Class: DatadogAPIClient::V2::NetworkHealthInsightsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/network_health_insights_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ NetworkHealthInsightsAPI

Returns a new instance of NetworkHealthInsightsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/network_health_insights_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/network_health_insights_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#list_network_health_insights(opts = {}) ⇒ Object

List network health insights.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/network_health_insights_api.rb', line 29

def list_network_health_insights(opts = {})
  data, _status_code, _headers = list_network_health_insights_with_http_info(opts)
  data
end

#list_network_health_insights_with_http_info(opts = {}) ⇒ Array<(NetworkHealthInsightsResponse, Integer, Hash)>

List network health insights.

Return network health insights for the organization within the given time window. Insights are produced by analyzing DNS failures pre-classified by network-dns-logger, TLS certificate metrics, and denied security group connections. Each insight identifies the client and server services involved, the type of issue, and the magnitude of the failure observed during the query window.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (String) —

    Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the to timestamp. If neither from nor to are provided, the query window will be [now - 15m, now].

  • :to (String) —

    Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be the current time. If neither from nor to are provided, the query window will be [now - 15m, now].

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/datadog_api_client/v2/api/network_health_insights_api.rb', line 46

def list_network_health_insights_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_network_health_insights".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_network_health_insights")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_network_health_insights"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkHealthInsightsAPI.list_network_health_insights ...'
  end
  # resource path
  local_var_path = '/api/v2/network-health-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'NetworkHealthInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_network_health_insights,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkHealthInsightsAPI#list_network_health_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end