Class: DatadogAPIClient::V1::HostsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/hosts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of HostsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/hosts_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/v1/api/hosts_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_host_totals(opts = {}) ⇒ Object

Get the total number of active hosts.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 29

def get_host_totals(opts = {})
  data, _status_code, _headers = get_host_totals_with_http_info(opts)
  data
end

#get_host_totals_with_http_info(opts = {}) ⇒ Array<(HostTotals, Integer, Hash)>

Get the total number of active hosts.

This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    Number of seconds from which you want to get total number of active hosts.

Returns:

  • (Array<(HostTotals, Integer, Hash)>) —

    HostTotals data, response status code and response headers



42
43
44
45
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
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 42

def get_host_totals_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostsAPI.get_host_totals ...'
  end
  # resource path
  local_var_path = '/api/v1/hosts/totals'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].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] || 'HostTotals'

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

  new_options = opts.merge(
    :operation => :get_host_totals,
    :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 => "V1"
  )

  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: HostsAPI#get_host_totals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_hosts(opts = {}) ⇒ Object

Get all hosts for your organization.

See Also:



92
93
94
95
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 92

def list_hosts(opts = {})
  data, _status_code, _headers = list_hosts_with_http_info(opts)
  data
end

#list_hosts_with_http_info(opts = {}) ⇒ Array<(HostListResponse, Integer, Hash)>

Get all hosts for your organization.

This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    String to filter search results.

  • :sort_field (String) —

    Sort hosts by this field.

  • :sort_dir (String) —

    Direction of sort. Options include ‘asc` and `desc`.

  • :start (Integer) —

    Specify the starting point for the host search results. For example, if you set ‘count` to 100 and the first 100 results have already been returned, you can set `start` to `101` to get the next 100 results.

  • :count (Integer) —

    Number of hosts to return. Max 1000.

  • :from (Integer) —

    Number of seconds since UNIX epoch from which you want to search your hosts.

  • :include_muted_hosts_data (Boolean) —

    Include information on the muted status of hosts and when the mute expires.

  • :include_hosts_metadata (Boolean) —

    Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).

Returns:

  • (Array<(HostListResponse, Integer, Hash)>) —

    HostListResponse data, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 114

def list_hosts_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostsAPI.list_hosts ...'
  end
  # resource path
  local_var_path = '/api/v1/hosts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'include_muted_hosts_data'] = opts[:'include_muted_hosts_data'] if !opts[:'include_muted_hosts_data'].nil?
  query_params[:'include_hosts_metadata'] = opts[:'include_hosts_metadata'] if !opts[:'include_hosts_metadata'].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] || 'HostListResponse'

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

  new_options = opts.merge(
    :operation => :list_hosts,
    :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 => "V1"
  )

  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: HostsAPI#list_hosts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mute_host(host_name, body, opts = {}) ⇒ Object

Mute a host.

See Also:



171
172
173
174
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 171

def mute_host(host_name, body, opts = {})
  data, _status_code, _headers = mute_host_with_http_info(host_name, body, opts)
  data
end

#mute_host_with_http_info(host_name, body, opts = {}) ⇒ Array<(HostMuteResponse, Integer, Hash)>

Mute a host.

Mute a host. Note: This creates a [Downtime V2](docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) for the host.

Parameters:

  • host_name (String) —

    Name of the host to mute.

  • body (HostMuteSettings) —

    Mute a host request body.

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

    the optional parameters

Returns:

  • (Array<(HostMuteResponse, Integer, Hash)>) —

    HostMuteResponse data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 184

def mute_host_with_http_info(host_name, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostsAPI.mute_host ...'
  end
  # verify the required parameter 'host_name' is set
  if @api_client.config.client_side_validation && host_name.nil?
    fail ArgumentError, "Missing the required parameter 'host_name' when calling HostsAPI.mute_host"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling HostsAPI.mute_host"
  end
  # resource path
  local_var_path = '/api/v1/host/{host_name}/mute'.sub('{host_name}', CGI.escape(host_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

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

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :mute_host,
    :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 => "V1"
  )

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

#unmute_host(host_name, opts = {}) ⇒ Object

Unmute a host.

See Also:



243
244
245
246
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 243

def unmute_host(host_name, opts = {})
  data, _status_code, _headers = unmute_host_with_http_info(host_name, opts)
  data
end

#unmute_host_with_http_info(host_name, opts = {}) ⇒ Array<(HostMuteResponse, Integer, Hash)>

Unmute a host.

Unmutes a host. This endpoint takes no JSON arguments.

Parameters:

  • host_name (String) —

    Name of the host to unmute.

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

    the optional parameters

Returns:

  • (Array<(HostMuteResponse, Integer, Hash)>) —

    HostMuteResponse data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/datadog_api_client/v1/api/hosts_api.rb', line 255

def unmute_host_with_http_info(host_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HostsAPI.unmute_host ...'
  end
  # verify the required parameter 'host_name' is set
  if @api_client.config.client_side_validation && host_name.nil?
    fail ArgumentError, "Missing the required parameter 'host_name' when calling HostsAPI.unmute_host"
  end
  # resource path
  local_var_path = '/api/v1/host/{host_name}/unmute'.sub('{host_name}', CGI.escape(host_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'HostMuteResponse'

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

  new_options = opts.merge(
    :operation => :unmute_host,
    :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 => "V1"
  )

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