Class: DatadogAPIClient::V2::CloudCostManagementAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CloudCostManagementAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_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/cloud_cost_management_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_cost_awscur_config(body, opts = {}) ⇒ Object

Create Cloud Cost Management AWS CUR config.

See Also:



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

def create_cost_awscur_config(body, opts = {})
  data, _status_code, _headers = create_cost_awscur_config_with_http_info(body, opts)
  data
end

#create_cost_awscur_config_with_http_info(body, opts = {}) ⇒ Array<(AwsCurConfigResponse, Integer, Hash)>

Create Cloud Cost Management AWS CUR config.

Create a Cloud Cost Management account for an AWS CUR config.

Parameters:

Returns:

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

    AwsCurConfigResponse data, response status code and response headers



41
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
88
89
90
91
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 41

def create_cost_awscur_config_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_awscur_config ...'
  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 CloudCostManagementAPI.create_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config'

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

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

  new_options = opts.merge(
    :operation => :create_cost_awscur_config,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_cost_azure_uc_configs(body, opts = {}) ⇒ Object

Create Cloud Cost Management Azure configs.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 96

def create_cost_azure_uc_configs(body, opts = {})
  data, _status_code, _headers = create_cost_azure_uc_configs_with_http_info(body, opts)
  data
end

#create_cost_azure_uc_configs_with_http_info(body, opts = {}) ⇒ Array<(AzureUCConfigPairsResponse, Integer, Hash)>

Create Cloud Cost Management Azure configs.

Create a Cloud Cost Management account for an Azure config.

Parameters:

Returns:

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

    AzureUCConfigPairsResponse data, response status code and response headers



108
109
110
111
112
113
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
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 108

def create_cost_azure_uc_configs_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_azure_uc_configs ...'
  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 CloudCostManagementAPI.create_cost_azure_uc_configs"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config'

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

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

  new_options = opts.merge(
    :operation => :create_cost_azure_uc_configs,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_cost_gcp_usage_cost_config(body, opts = {}) ⇒ Object

Create Google Cloud Usage Cost config.

See Also:



163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 163

def create_cost_gcp_usage_cost_config(body, opts = {})
  data, _status_code, _headers = create_cost_gcp_usage_cost_config_with_http_info(body, opts)
  data
end

#create_cost_gcp_usage_cost_config_with_http_info(body, opts = {}) ⇒ Array<(GCPUsageCostConfigResponse, Integer, Hash)>

Create Google Cloud Usage Cost config.

Create a Cloud Cost Management account for an Google Cloud Usage Cost config.

Parameters:

Returns:

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

    GCPUsageCostConfigResponse data, response status code and response headers



175
176
177
178
179
180
181
182
183
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
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 175

def create_cost_gcp_usage_cost_config_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_gcp_usage_cost_config ...'
  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 CloudCostManagementAPI.create_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config'

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

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

  new_options = opts.merge(
    :operation => :create_cost_gcp_usage_cost_config,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_custom_allocation_rule(body, opts = {}) ⇒ Object

Create custom allocation rule.

See Also:



230
231
232
233
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 230

def create_custom_allocation_rule(body, opts = {})
  data, _status_code, _headers = create_custom_allocation_rule_with_http_info(body, opts)
  data
end

#create_custom_allocation_rule_with_http_info(body, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Create custom allocation rule.

Create a new custom allocation rule with the specified filters and allocation strategy.

**Strategy Methods:**

  • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.

  • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.

  • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).

**Filter Conditions:**

  • Use value for single-value conditions: “is”, “is not”, “contains”, “=”, “!=”, “like”, “not like”

  • Use values for multi-value conditions: “in”, “not in”

  • Cannot use both value and values simultaneously.

**Supported operators**: is, is not, contains, in, not in, =, !=, like, not like

Parameters:

Returns:

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

    ArbitraryRuleResponse data, response status code and response headers



254
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
304
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 254

def create_custom_allocation_rule_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_custom_allocation_rule ...'
  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 CloudCostManagementAPI.create_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule'

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

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

  new_options = opts.merge(
    :operation => :create_custom_allocation_rule,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tag_pipelines_ruleset(body, opts = {}) ⇒ Object

Create tag pipeline ruleset.

See Also:



309
310
311
312
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 309

def create_tag_pipelines_ruleset(body, opts = {})
  data, _status_code, _headers = create_tag_pipelines_ruleset_with_http_info(body, opts)
  data
end

#create_tag_pipelines_ruleset_with_http_info(body, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Create tag pipeline ruleset.

Create a new tag pipeline ruleset with the specified rules and configuration

Parameters:

Returns:

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

    RulesetResp data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 321

def create_tag_pipelines_ruleset_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_tag_pipelines_ruleset ...'
  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 CloudCostManagementAPI.create_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment'

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

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

  new_options = opts.merge(
    :operation => :create_tag_pipelines_ruleset,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_budget(budget_id, opts = {}) ⇒ Object

Delete budget.

See Also:



376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 376

def delete_budget(budget_id, opts = {})
  delete_budget_with_http_info(budget_id, opts)
  nil
end

#delete_budget_with_http_info(budget_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete budget.

Delete a budget

Parameters:

  • budget_id (String) —

    Budget id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 388

def delete_budget_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_budget ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.delete_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}'.sub('{budget_id}', CGI.escape(budget_id.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_budget,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_awscur_config(cloud_account_id, opts = {}) ⇒ Object

Delete Cloud Cost Management AWS CUR config.

See Also:



441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 441

def delete_cost_awscur_config(, opts = {})
  delete_cost_awscur_config_with_http_info(, opts)
  nil
end

#delete_cost_awscur_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Cloud Cost Management AWS CUR config.

Archive a Cloud Cost Management Account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 453

def delete_cost_awscur_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_cost_awscur_config,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_azure_uc_config(cloud_account_id, opts = {}) ⇒ Object

Delete Cloud Cost Management Azure config.

See Also:



506
507
508
509
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 506

def delete_cost_azure_uc_config(, opts = {})
  delete_cost_azure_uc_config_with_http_info(, opts)
  nil
end

#delete_cost_azure_uc_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Cloud Cost Management Azure config.

Archive a Cloud Cost Management Account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 518

def delete_cost_azure_uc_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_azure_uc_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_azure_uc_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_cost_azure_uc_config,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_azure_uc_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_gcp_usage_cost_config(cloud_account_id, opts = {}) ⇒ Object

Delete Google Cloud Usage Cost config.

See Also:



571
572
573
574
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 571

def delete_cost_gcp_usage_cost_config(, opts = {})
  delete_cost_gcp_usage_cost_config_with_http_info(, opts)
  nil
end

#delete_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Google Cloud Usage Cost config.

Archive a Cloud Cost Management account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 583

def delete_cost_gcp_usage_cost_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_cost_gcp_usage_cost_config,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_allocation_rule(rule_id, opts = {}) ⇒ Object

Delete custom allocation rule.

See Also:



636
637
638
639
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 636

def delete_custom_allocation_rule(rule_id, opts = {})
  delete_custom_allocation_rule_with_http_info(rule_id, opts)
  nil
end

#delete_custom_allocation_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete custom allocation rule.

Delete a custom allocation rule - Delete an existing custom allocation rule by its ID

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 648

def delete_custom_allocation_rule_with_http_info(rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.delete_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_custom_allocation_rule,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_costs_file(file_id, opts = {}) ⇒ Object

Delete Custom Costs file.

See Also:



701
702
703
704
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 701

def delete_custom_costs_file(file_id, opts = {})
  delete_custom_costs_file_with_http_info(file_id, opts)
  nil
end

#delete_custom_costs_file_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Custom Costs file.

Delete the specified Custom Costs file.

Parameters:

  • file_id (String) —

    File ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 713

def delete_custom_costs_file_with_http_info(file_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_costs_file ...'
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling CloudCostManagementAPI.delete_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs/{file_id}'.sub('{file_id}', CGI.escape(file_id.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_custom_costs_file,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag_pipelines_ruleset(ruleset_id, opts = {}) ⇒ Object

Delete tag pipeline ruleset.

See Also:



766
767
768
769
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 766

def delete_tag_pipelines_ruleset(ruleset_id, opts = {})
  delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts)
  nil
end

#delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete tag pipeline ruleset.

Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 778

def delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.delete_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_tag_pipelines_ruleset,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budget(budget_id, opts = {}) ⇒ Object

Get budget.

See Also:



831
832
833
834
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 831

def get_budget(budget_id, opts = {})
  data, _status_code, _headers = get_budget_with_http_info(budget_id, opts)
  data
end

#get_budget_with_http_info(budget_id, opts = {}) ⇒ Array<(BudgetWithEntries, Integer, Hash)>

Get budget.

Get a budget

Parameters:

  • budget_id (String) —

    Budget id.

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

    the optional parameters

Returns:

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

    BudgetWithEntries data, response status code and response headers



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 843

def get_budget_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_budget ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.get_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}'.sub('{budget_id}', CGI.escape(budget_id.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] || 'BudgetWithEntries'

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

  new_options = opts.merge(
    :operation => :get_budget,
    :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: CloudCostManagementAPI#get_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_commitment_list(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments list.

See Also:



896
897
898
899
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 896

def get_commitments_commitment_list(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_commitment_list_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_commitment_list_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsListResponse, Integer, Hash)>

Get commitments list.

Get a list of individual cloud commitments (Reserved Instances or Savings Plans) with their utilization details. The response schema varies based on the provider, product, and commitment type.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:

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

    CommitmentsListResponse data, response status code and response headers



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 913

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_commitment_list ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/commitment-list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].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] || 'CommitmentsListResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_commitment_list,
    :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: CloudCostManagementAPI#get_commitments_commitment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_coverage_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments coverage (scalar).

See Also:



999
1000
1001
1002
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 999

def get_commitments_coverage_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_coverage_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_coverage_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsCoverageScalarResponse, Integer, Hash)>

Get commitments coverage (scalar).

Get scalar coverage metrics for cloud commitment programs, including hours and cost coverage percentages.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1015

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_coverage_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/coverage/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].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] || 'CommitmentsCoverageScalarResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_coverage_scalar,
    :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: CloudCostManagementAPI#get_commitments_coverage_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_coverage_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments coverage (timeseries).

See Also:



1096
1097
1098
1099
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1096

def get_commitments_coverage_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_coverage_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_coverage_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsCoverageTimeseriesResponse, Integer, Hash)>

Get commitments coverage (timeseries).

Get timeseries coverage metrics for cloud commitment programs, broken down by coverage type (Reserved Instances, Savings Plans, On-Demand, and Spot) for both hours and cost.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1112

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_coverage_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/coverage/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].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] || 'CommitmentsCoverageTimeseriesResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_coverage_timeseries,
    :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: CloudCostManagementAPI#get_commitments_coverage_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_on_demand_hotspots_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments on-demand hot spots (scalar).

See Also:



1193
1194
1195
1196
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1193

def get_commitments_on_demand_hotspots_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_on_demand_hotspots_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_on_demand_hotspots_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsOnDemandHotspotsScalarResponse, Integer, Hash)>

Get commitments on-demand hot spots (scalar).

Get scalar on-demand hot-spots data for cloud commitment programs, showing per-dimension breakdowns of on-demand spending with coverage metrics and potential savings.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1209

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/on-demand-hot-spots/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].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] || 'CommitmentsOnDemandHotspotsScalarResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_on_demand_hotspots_scalar,
    :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: CloudCostManagementAPI#get_commitments_on_demand_hotspots_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_savings_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments savings (scalar).

See Also:



1290
1291
1292
1293
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1290

def get_commitments_savings_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_savings_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_savings_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsSavingsScalarResponse, Integer, Hash)>

Get commitments savings (scalar).

Get scalar savings metrics for cloud commitment programs, including realized savings and effective savings rate.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1306

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_savings_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/savings/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].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] || 'CommitmentsSavingsScalarResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_savings_scalar,
    :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: CloudCostManagementAPI#get_commitments_savings_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_savings_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments savings (timeseries).

See Also:



1387
1388
1389
1390
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1387

def get_commitments_savings_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_savings_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_savings_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsSavingsTimeseriesResponse, Integer, Hash)>

Get commitments savings (timeseries).

Get timeseries savings metrics for cloud commitment programs, including actual cost, on-demand equivalent cost, realized savings, and effective savings rate over time.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1403

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_savings_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/savings/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].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] || 'CommitmentsSavingsTimeseriesResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_savings_timeseries,
    :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: CloudCostManagementAPI#get_commitments_savings_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_utilization_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments utilization (scalar).

See Also:



1484
1485
1486
1487
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1484

def get_commitments_utilization_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_utilization_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_utilization_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsUtilizationScalarResponse, Integer, Hash)>

Get commitments utilization (scalar).

Get scalar utilization metrics for cloud commitment programs, including utilization percentage and unused cost.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:



1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1501

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_utilization_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/utilization/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].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] || 'CommitmentsUtilizationScalarResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_utilization_scalar,
    :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: CloudCostManagementAPI#get_commitments_utilization_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_utilization_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments utilization (timeseries).

See Also:



1587
1588
1589
1590
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1587

def get_commitments_utilization_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_utilization_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_utilization_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsUtilizationTimeseriesResponse, Integer, Hash)>

Get commitments utilization (timeseries).

Get timeseries utilization metrics for cloud commitment programs, including used and unused cost series over time.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

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

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1604

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_utilization_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/utilization/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].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] || 'CommitmentsUtilizationTimeseriesResponse'

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

  new_options = opts.merge(
    :operation => :get_commitments_utilization_timeseries,
    :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: CloudCostManagementAPI#get_commitments_utilization_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_anomaly(anomaly_id, opts = {}) ⇒ Object

Get cost anomaly.

See Also:



1690
1691
1692
1693
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1690

def get_cost_anomaly(anomaly_id, opts = {})
  data, _status_code, _headers = get_cost_anomaly_with_http_info(anomaly_id, opts)
  data
end

#get_cost_anomaly_with_http_info(anomaly_id, opts = {}) ⇒ Array<(CostAnomalyResponse, Integer, Hash)>

Get cost anomaly.

Get a detected Cloud Cost Management anomaly by UUID.

Parameters:

  • anomaly_id (String) —

    The UUID of the cost anomaly.

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

    the optional parameters

Returns:

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

    CostAnomalyResponse data, response status code and response headers



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1702

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_anomaly ...'
  end
  # verify the required parameter 'anomaly_id' is set
  if @api_client.config.client_side_validation && anomaly_id.nil?
    fail ArgumentError, "Missing the required parameter 'anomaly_id' when calling CloudCostManagementAPI.get_cost_anomaly"
  end
  # resource path
  local_var_path = '/api/v2/cost/anomalies/{anomaly_id}'.sub('{anomaly_id}', CGI.escape(anomaly_id.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] || 'CostAnomalyResponse'

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

  new_options = opts.merge(
    :operation => :get_cost_anomaly,
    :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: CloudCostManagementAPI#get_cost_anomaly\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_awscur_config(cloud_account_id, opts = {}) ⇒ Object

Get cost AWS CUR config.

See Also:



1761
1762
1763
1764
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1761

def get_cost_awscur_config(, opts = {})
  data, _status_code, _headers = get_cost_awscur_config_with_http_info(, opts)
  data
end

#get_cost_awscur_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(AwsCurConfigResponse, Integer, Hash)>

Get cost AWS CUR config.

Get a specific AWS CUR config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

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

    the optional parameters

Returns:

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

    AwsCurConfigResponse data, response status code and response headers



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1773

def get_cost_awscur_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'AwsCurConfigResponse'

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

  new_options = opts.merge(
    :operation => :get_cost_awscur_config,
    :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: CloudCostManagementAPI#get_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_azure_uc_config(cloud_account_id, opts = {}) ⇒ Object

Get cost Azure UC config.

See Also:



1826
1827
1828
1829
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1826

def get_cost_azure_uc_config(, opts = {})
  data, _status_code, _headers = get_cost_azure_uc_config_with_http_info(, opts)
  data
end

#get_cost_azure_uc_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(UCConfigPair, Integer, Hash)>

Get cost Azure UC config.

Get a specific Azure config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

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

    the optional parameters

Returns:

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

    UCConfigPair data, response status code and response headers



1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1838

def get_cost_azure_uc_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_azure_uc_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_azure_uc_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'UCConfigPair'

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

  new_options = opts.merge(
    :operation => :get_cost_azure_uc_config,
    :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: CloudCostManagementAPI#get_cost_azure_uc_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_gcp_usage_cost_config(cloud_account_id, opts = {}) ⇒ Object

Get Google Cloud Usage Cost config.

See Also:



1891
1892
1893
1894
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1891

def get_cost_gcp_usage_cost_config(, opts = {})
  data, _status_code, _headers = get_cost_gcp_usage_cost_config_with_http_info(, opts)
  data
end

#get_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(GcpUcConfigResponse, Integer, Hash)>

Get Google Cloud Usage Cost config.

Get a specific Google Cloud Usage Cost config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

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

    the optional parameters

Returns:

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

    GcpUcConfigResponse data, response status code and response headers



1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1903

def get_cost_gcp_usage_cost_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'GcpUcConfigResponse'

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

  new_options = opts.merge(
    :operation => :get_cost_gcp_usage_cost_config,
    :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: CloudCostManagementAPI#get_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_tag_key(tag_key, opts = {}) ⇒ Object

Get a Cloud Cost Management tag key.

See Also:



1956
1957
1958
1959
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1956

def get_cost_tag_key(tag_key, opts = {})
  data, _status_code, _headers = get_cost_tag_key_with_http_info(tag_key, opts)
  data
end

#get_cost_tag_key_with_http_info(tag_key, opts = {}) ⇒ Array<(CostTagKeyResponse, Integer, Hash)>

Get a Cloud Cost Management tag key.

Get details for a specific Cloud Cost Management tag key, including example tag values and description.

Parameters:

  • tag_key (String) —

    The Cloud Cost Management tag key. Tag keys can contain forward slashes (for example, ‘kubernetes/instance`).

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

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tag key details to. When omitted, returns details across all metrics.

  • :page_size (Integer) —

    Controls the size of the internal tag value search scope. This does not restrict the number of example tag values returned in the response. Defaults to 50, maximum 10000.

Returns:

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

    CostTagKeyResponse data, response status code and response headers



1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1970

def get_cost_tag_key_with_http_info(tag_key, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_tag_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.get_cost_tag_key"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CloudCostManagementAPI.get_cost_tag_key, must be smaller than or equal to 10000.'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_keys/{tag_key}'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'CostTagKeyResponse'

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

  new_options = opts.merge(
    :operation => :get_cost_tag_key,
    :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: CloudCostManagementAPI#get_cost_tag_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_allocation_rule(rule_id, opts = {}) ⇒ Object

Get custom allocation rule.

See Also:



2028
2029
2030
2031
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2028

def get_custom_allocation_rule(rule_id, opts = {})
  data, _status_code, _headers = get_custom_allocation_rule_with_http_info(rule_id, opts)
  data
end

#get_custom_allocation_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Get custom allocation rule.

Get a specific custom allocation rule - Retrieve a specific custom allocation rule by its ID

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

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

    the optional parameters

Returns:

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

    ArbitraryRuleResponse data, response status code and response headers



2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2040

def get_custom_allocation_rule_with_http_info(rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.get_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.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] || 'ArbitraryRuleResponse'

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

  new_options = opts.merge(
    :operation => :get_custom_allocation_rule,
    :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: CloudCostManagementAPI#get_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_costs_file(file_id, opts = {}) ⇒ Object

Get Custom Costs file.

See Also:



2093
2094
2095
2096
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2093

def get_custom_costs_file(file_id, opts = {})
  data, _status_code, _headers = get_custom_costs_file_with_http_info(file_id, opts)
  data
end

#get_custom_costs_file_with_http_info(file_id, opts = {}) ⇒ Array<(CustomCostsFileGetResponse, Integer, Hash)>

Get Custom Costs file.

Fetch the specified Custom Costs file.

Parameters:

  • file_id (String) —

    File ID.

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

    the optional parameters

Returns:

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

    CustomCostsFileGetResponse data, response status code and response headers



2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2105

def get_custom_costs_file_with_http_info(file_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_custom_costs_file ...'
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling CloudCostManagementAPI.get_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs/{file_id}'.sub('{file_id}', CGI.escape(file_id.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] || 'CustomCostsFileGetResponse'

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

  new_options = opts.merge(
    :operation => :get_custom_costs_file,
    :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: CloudCostManagementAPI#get_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_pipelines_ruleset(ruleset_id, opts = {}) ⇒ Object

Get a tag pipeline ruleset.

See Also:



2158
2159
2160
2161
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2158

def get_tag_pipelines_ruleset(ruleset_id, opts = {})
  data, _status_code, _headers = get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts)
  data
end

#get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Get a tag pipeline ruleset.

Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

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

    the optional parameters

Returns:

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

    RulesetResp data, response status code and response headers



2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2170

def get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.get_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.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] || 'RulesetResp'

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

  new_options = opts.merge(
    :operation => :get_tag_pipelines_ruleset,
    :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: CloudCostManagementAPI#get_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_budgets(opts = {}) ⇒ Object

List budgets.

See Also:



2223
2224
2225
2226
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2223

def list_budgets(opts = {})
  data, _status_code, _headers = list_budgets_with_http_info(opts)
  data
end

#list_budgets_with_http_info(opts = {}) ⇒ Array<(BudgetArray, Integer, Hash)>

List budgets.

List budgets.

Parameters:

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

    the optional parameters

Returns:

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

    BudgetArray data, response status code and response headers



2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2234

def list_budgets_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_budgets ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/budgets'

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

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

  new_options = opts.merge(
    :operation => :list_budgets,
    :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: CloudCostManagementAPI#list_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_anomalies(opts = {}) ⇒ Object

List cost anomalies.

See Also:



2283
2284
2285
2286
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2283

def list_cost_anomalies(opts = {})
  data, _status_code, _headers = list_cost_anomalies_with_http_info(opts)
  data
end

#list_cost_anomalies_with_http_info(opts = {}) ⇒ Array<(CostAnomaliesResponse, Integer, Hash)>

List cost anomalies.

List detected Cloud Cost Management anomalies for the organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Start time as Unix milliseconds. Defaults to the start of the latest stable seven-day window.

  • :_end (Integer) —

    End time as Unix milliseconds. Defaults to the end of the latest stable seven-day window.

  • :filter (String) —

    Optional JSON object mapping cost tag keys to allowed values, for example ‘href=""payments"">team”:,“env”:`. Filters match anomaly dimensions or correlated tags.

  • :min_anomalous_threshold (String) —

    Minimum absolute anomalous cost change to include. Numeric value; defaults to ‘1`.

  • :min_cost_threshold (String) —

    Minimum absolute actual cost to include. Numeric value; defaults to ‘0`.

  • :dismissal_cause (String) —

    Filter by resolution state. Use ‘none` for unresolved anomalies, `all` or `*` for resolved anomalies, or a comma-separated list of causes.

  • :order_by (String) —

    Sort field. One of ‘start_date`, `end_date`, `duration`, `max_cost`, `anomalous_cost`, or `dismissal_date`. Defaults to `anomalous_cost`.

  • :order (String) —

    Sort direction. One of ‘asc` or `desc`. Defaults to `desc`.

  • :limit (Integer) —

    Maximum number of anomalies to return. Defaults to ‘200`.

  • :offset (Integer) —

    Pagination offset. Defaults to ‘0`.

  • :provider_ids (Array<String>) —

    Optional repeated cloud or SaaS provider filters, such as ‘aws`, `gcp`, `azure`, `Oracle`, `datadog`, `OpenAI`, or `Anthropic`.

Returns:

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

    CostAnomaliesResponse data, response status code and response headers



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2305

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_anomalies ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/anomalies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'min_anomalous_threshold'] = opts[:'min_anomalous_threshold'] if !opts[:'min_anomalous_threshold'].nil?
  query_params[:'min_cost_threshold'] = opts[:'min_cost_threshold'] if !opts[:'min_cost_threshold'].nil?
  query_params[:'dismissal_cause'] = opts[:'dismissal_cause'] if !opts[:'dismissal_cause'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'provider_ids'] = @api_client.build_collection_param(opts[:'provider_ids'], :multi) if !opts[:'provider_ids'].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] || 'CostAnomaliesResponse'

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

  new_options = opts.merge(
    :operation => :list_cost_anomalies,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

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

#list_cost_awscur_configs(opts = {}) ⇒ Object

List Cloud Cost Management AWS CUR configs.

See Also:



2372
2373
2374
2375
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2372

def list_cost_awscur_configs(opts = {})
  data, _status_code, _headers = list_cost_awscur_configs_with_http_info(opts)
  data
end

#list_cost_awscur_configs_with_http_info(opts = {}) ⇒ Array<(AwsCURConfigsResponse, Integer, Hash)>

List Cloud Cost Management AWS CUR configs.

List the AWS CUR configs.

Parameters:

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

    the optional parameters

Returns:

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

    AwsCURConfigsResponse data, response status code and response headers



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2383

def list_cost_awscur_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_awscur_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config'

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

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

  new_options = opts.merge(
    :operation => :list_cost_awscur_configs,
    :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: CloudCostManagementAPI#list_cost_awscur_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_azure_uc_configs(opts = {}) ⇒ Object

List Cloud Cost Management Azure configs.

See Also:



2432
2433
2434
2435
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2432

def list_cost_azure_uc_configs(opts = {})
  data, _status_code, _headers = list_cost_azure_uc_configs_with_http_info(opts)
  data
end

#list_cost_azure_uc_configs_with_http_info(opts = {}) ⇒ Array<(AzureUCConfigsResponse, Integer, Hash)>

List Cloud Cost Management Azure configs.

List the Azure configs.

Parameters:

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

    the optional parameters

Returns:

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

    AzureUCConfigsResponse data, response status code and response headers



2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2443

def list_cost_azure_uc_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_azure_uc_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config'

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

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

  new_options = opts.merge(
    :operation => :list_cost_azure_uc_configs,
    :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: CloudCostManagementAPI#list_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_gcp_usage_cost_configs(opts = {}) ⇒ Object

List Google Cloud Usage Cost configs.

See Also:



2492
2493
2494
2495
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2492

def list_cost_gcp_usage_cost_configs(opts = {})
  data, _status_code, _headers = list_cost_gcp_usage_cost_configs_with_http_info(opts)
  data
end

#list_cost_gcp_usage_cost_configs_with_http_info(opts = {}) ⇒ Array<(GCPUsageCostConfigsResponse, Integer, Hash)>

List Google Cloud Usage Cost configs.

List the Google Cloud Usage Cost configs.

Parameters:

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

    the optional parameters

Returns:

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

    GCPUsageCostConfigsResponse data, response status code and response headers



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2503

def list_cost_gcp_usage_cost_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_gcp_usage_cost_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config'

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

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

  new_options = opts.merge(
    :operation => :list_cost_gcp_usage_cost_configs,
    :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: CloudCostManagementAPI#list_cost_gcp_usage_cost_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_oci_configs(opts = {}) ⇒ Object

List Cloud Cost Management OCI configs.

See Also:



2552
2553
2554
2555
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2552

def list_cost_oci_configs(opts = {})
  data, _status_code, _headers = list_cost_oci_configs_with_http_info(opts)
  data
end

#list_cost_oci_configs_with_http_info(opts = {}) ⇒ Array<(OCIConfigsResponse, Integer, Hash)>

List Cloud Cost Management OCI configs.

List the OCI configs.

Parameters:

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

    the optional parameters

Returns:

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

    OCIConfigsResponse data, response status code and response headers



2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2563

def list_cost_oci_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_oci_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/oci_config'

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

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

  new_options = opts.merge(
    :operation => :list_cost_oci_configs,
    :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: CloudCostManagementAPI#list_cost_oci_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_descriptions(opts = {}) ⇒ Object

List Cloud Cost Management tag descriptions.

See Also:



2612
2613
2614
2615
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2612

def list_cost_tag_descriptions(opts = {})
  data, _status_code, _headers = list_cost_tag_descriptions_with_http_info(opts)
  data
end

#list_cost_tag_descriptions_with_http_info(opts = {}) ⇒ Array<(CostTagDescriptionsResponse, Integer, Hash)>

List Cloud Cost Management tag descriptions.

List Cloud Cost Management tag key descriptions for the organization. Use ‘filter` to scope the result to a single cloud provider; when omitted, both cross-cloud defaults and cloud-specific descriptions are returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_cloud (String) —

    Filter descriptions to a specific cloud provider (for example, ‘aws`). Omit to return descriptions across all clouds.

Returns:

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

    CostTagDescriptionsResponse data, response status code and response headers



2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2624

def list_cost_tag_descriptions_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_descriptions ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[cloud]'] = opts[:'filter_cloud'] if !opts[:'filter_cloud'].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] || 'CostTagDescriptionsResponse'

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

  new_options = opts.merge(
    :operation => :list_cost_tag_descriptions,
    :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: CloudCostManagementAPI#list_cost_tag_descriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_keys(opts = {}) ⇒ Object

List Cloud Cost Management tag keys.

See Also:



2674
2675
2676
2677
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2674

def list_cost_tag_keys(opts = {})
  data, _status_code, _headers = list_cost_tag_keys_with_http_info(opts)
  data
end

#list_cost_tag_keys_with_http_info(opts = {}) ⇒ Array<(CostTagKeysResponse, Integer, Hash)>

List Cloud Cost Management tag keys.

List Cloud Cost Management tag keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tag keys to. When omitted, returns tag keys across all metrics.

  • :filter_tags (Array<String>) —

    Filter to return only tag keys that appear with the given ‘key:value` tag values. For example, `filter=providername:aws` returns tag keys found on the same cost data, such as `is_aws_ec2_compute` and `aws_instance_type`.

Returns:

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

    CostTagKeysResponse data, response status code and response headers



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2687

def list_cost_tag_keys_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_keys ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'filter[tags]'] = @api_client.build_collection_param(opts[:'filter_tags'], :multi) if !opts[:'filter_tags'].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] || 'CostTagKeysResponse'

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

  new_options = opts.merge(
    :operation => :list_cost_tag_keys,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

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

#list_cost_tags(opts = {}) ⇒ Object

List Cloud Cost Management tags.

See Also:



2739
2740
2741
2742
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2739

def list_cost_tags(opts = {})
  data, _status_code, _headers = list_cost_tags_with_http_info(opts)
  data
end

#list_cost_tags_with_http_info(opts = {}) ⇒ Array<(CostTagsResponse, Integer, Hash)>

List Cloud Cost Management tags.

List Cloud Cost Management tags for a given metric.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tags to. When omitted, returns tags across all metrics.

  • :filter_match (String) —

    A substring used to filter the returned tags by name.

  • :filter_tags (Array<String>) —

    Filter to return only tags that appear with the given ‘key:value` tag values. For example, `filter=providername:aws` returns tags found on the same cost data, such as `aws_instance_type:t3.micro` and `aws_instance_type:m5.large`.

  • :filter_tag_keys (Array<String>) —

    Restrict the returned tags to those whose key matches one of the given tag keys.

  • :page_size (Integer) —

    Controls the size of the internal tag search scope. This does not restrict the number of tags returned in the response. Defaults to 50, maximum 10000.

Returns:

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

    CostTagsResponse data, response status code and response headers



2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2755

def list_cost_tags_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tags ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CloudCostManagementAPI.list_cost_tags, must be smaller than or equal to 10000.'
  end
  # resource path
  local_var_path = '/api/v2/cost/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'filter[match]'] = opts[:'filter_match'] if !opts[:'filter_match'].nil?
  query_params[:'filter[tags]'] = @api_client.build_collection_param(opts[:'filter_tags'], :multi) if !opts[:'filter_tags'].nil?
  query_params[:'filter[tag_keys]'] = @api_client.build_collection_param(opts[:'filter_tag_keys'], :multi) if !opts[:'filter_tag_keys'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'CostTagsResponse'

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

  new_options = opts.merge(
    :operation => :list_cost_tags,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

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

#list_custom_allocation_rules(opts = {}) ⇒ Object

List custom allocation rules.

See Also:



2813
2814
2815
2816
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2813

def list_custom_allocation_rules(opts = {})
  data, _status_code, _headers = list_custom_allocation_rules_with_http_info(opts)
  data
end

#list_custom_allocation_rules_status(opts = {}) ⇒ Object

List custom allocation rule statuses.

See Also:



2873
2874
2875
2876
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2873

def list_custom_allocation_rules_status(opts = {})
  data, _status_code, _headers = list_custom_allocation_rules_status_with_http_info(opts)
  data
end

#list_custom_allocation_rules_status_with_http_info(opts = {}) ⇒ Array<(ArbitraryRuleStatusResponseArray, Integer, Hash)>

List custom allocation rule statuses.

List the processing status of all custom allocation rules. Returns only the ID and processing status for each rule.

Parameters:

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

    the optional parameters

Returns:



2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2884

def list_custom_allocation_rules_status_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_allocation_rules_status ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/status'

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

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

  new_options = opts.merge(
    :operation => :list_custom_allocation_rules_status,
    :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: CloudCostManagementAPI#list_custom_allocation_rules_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_allocation_rules_with_http_info(opts = {}) ⇒ Array<(ArbitraryRuleResponseArray, Integer, Hash)>

List custom allocation rules.

List all custom allocation rules - Retrieve a list of all custom allocation rules for the organization

Parameters:

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

    the optional parameters

Returns:

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

    ArbitraryRuleResponseArray data, response status code and response headers



2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2824

def list_custom_allocation_rules_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_allocation_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule'

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

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

  new_options = opts.merge(
    :operation => :list_custom_allocation_rules,
    :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: CloudCostManagementAPI#list_custom_allocation_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_costs_files(opts = {}) ⇒ Object

List Custom Costs files.

See Also:



2933
2934
2935
2936
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2933

def list_custom_costs_files(opts = {})
  data, _status_code, _headers = list_custom_costs_files_with_http_info(opts)
  data
end

#list_custom_costs_files_with_http_info(opts = {}) ⇒ Array<(CustomCostsFileListResponse, Integer, Hash)>

List Custom Costs files.

List the Custom Costs files.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number for pagination

  • :page_size (Integer) —

    Page size for pagination

  • :filter_status (String) —

    Filter by file status

  • :filter_name (String) —

    Filter files by name with case-insensitive substring matching.

  • :filter_provider (Array<String>) —

    Filter by provider.

  • :sort (String) —

    Sort key with optional descending prefix

Returns:

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

    CustomCostsFileListResponse data, response status code and response headers



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2950

def list_custom_costs_files_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_costs_files ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[provider]'] = @api_client.build_collection_param(opts[:'filter_provider'], :multi) if !opts[:'filter_provider'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'CustomCostsFileListResponse'

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

  new_options = opts.merge(
    :operation => :list_custom_costs_files,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

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

#list_tag_pipelines_rulesets(opts = {}) ⇒ Object

List tag pipeline rulesets.

See Also:



3006
3007
3008
3009
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3006

def list_tag_pipelines_rulesets(opts = {})
  data, _status_code, _headers = list_tag_pipelines_rulesets_with_http_info(opts)
  data
end

#list_tag_pipelines_rulesets_status(opts = {}) ⇒ Object

List tag pipeline ruleset statuses.

See Also:



3066
3067
3068
3069
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3066

def list_tag_pipelines_rulesets_status(opts = {})
  data, _status_code, _headers = list_tag_pipelines_rulesets_status_with_http_info(opts)
  data
end

#list_tag_pipelines_rulesets_status_with_http_info(opts = {}) ⇒ Array<(RulesetStatusRespArray, Integer, Hash)>

List tag pipeline ruleset statuses.

List the processing status of all tag pipeline rulesets. Returns only the ID and processing status for each ruleset.

Parameters:

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

    the optional parameters

Returns:

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

    RulesetStatusRespArray data, response status code and response headers



3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3077

def list_tag_pipelines_rulesets_status_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_tag_pipelines_rulesets_status ...'
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/status'

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

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

  new_options = opts.merge(
    :operation => :list_tag_pipelines_rulesets_status,
    :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: CloudCostManagementAPI#list_tag_pipelines_rulesets_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tag_pipelines_rulesets_with_http_info(opts = {}) ⇒ Array<(RulesetRespArray, Integer, Hash)>

List tag pipeline rulesets.

List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization

Parameters:

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

    the optional parameters

Returns:

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

    RulesetRespArray data, response status code and response headers



3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3017

def list_tag_pipelines_rulesets_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_tag_pipelines_rulesets ...'
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment'

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

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

  new_options = opts.merge(
    :operation => :list_tag_pipelines_rulesets,
    :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: CloudCostManagementAPI#list_tag_pipelines_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reorder_custom_allocation_rules(body, opts = {}) ⇒ Object

Reorder custom allocation rules.

See Also:



3126
3127
3128
3129
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3126

def reorder_custom_allocation_rules(body, opts = {})
  reorder_custom_allocation_rules_with_http_info(body, opts)
  nil
end

#reorder_custom_allocation_rules_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reorder custom allocation rules.

Reorder custom allocation rules - Change the execution order of custom allocation rules.

Important: You must provide the **complete list** of all rule IDs in the desired execution order. The API will reorder ALL rules according to the provided sequence.

Rules are executed in the order specified, with lower indices (earlier in the array) having higher priority.

Example: If you have rules with IDs [123, 456, 789] and want to change order from 123→456→789 to 456→123→789, send: [“456”, “123”, “789”]

Parameters:

Returns:

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

    nil, response status code and response headers



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3144

def reorder_custom_allocation_rules_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.reorder_custom_allocation_rules ...'
  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 CloudCostManagementAPI.reorder_custom_allocation_rules"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/reorder'

  # 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(['*/*'])
  # 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]

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

  new_options = opts.merge(
    :operation => :reorder_custom_allocation_rules,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#reorder_custom_allocation_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reorder_tag_pipelines_rulesets(body, opts = {}) ⇒ Object

Reorder tag pipeline rulesets.

See Also:



3199
3200
3201
3202
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3199

def reorder_tag_pipelines_rulesets(body, opts = {})
  reorder_tag_pipelines_rulesets_with_http_info(body, opts)
  nil
end

#reorder_tag_pipelines_rulesets_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reorder tag pipeline rulesets.

Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets

Parameters:

Returns:

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

    nil, response status code and response headers



3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3211

def reorder_tag_pipelines_rulesets_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.reorder_tag_pipelines_rulesets ...'
  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 CloudCostManagementAPI.reorder_tag_pipelines_rulesets"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/reorder'

  # 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(['*/*'])
  # 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]

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

  new_options = opts.merge(
    :operation => :reorder_tag_pipelines_rulesets,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#reorder_tag_pipelines_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_awscur_config(cloud_account_id, body, opts = {}) ⇒ Object

Update Cloud Cost Management AWS CUR config.

See Also:



3266
3267
3268
3269
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3266

def update_cost_awscur_config(, body, opts = {})
  data, _status_code, _headers = update_cost_awscur_config_with_http_info(, body, opts)
  data
end

#update_cost_awscur_config_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(AwsCURConfigsResponse, Integer, Hash)>

Update Cloud Cost Management AWS CUR config.

Update the status (active/archived) and/or account filtering configuration of an AWS CUR config.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

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

    the optional parameters

Returns:

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

    AwsCURConfigsResponse data, response status code and response headers



3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3279

def update_cost_awscur_config_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_awscur_config"
  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 CloudCostManagementAPI.update_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'AwsCURConfigsResponse'

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

  new_options = opts.merge(
    :operation => :update_cost_awscur_config,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_azure_uc_configs(cloud_account_id, body, opts = {}) ⇒ Object

Update Cloud Cost Management Azure config.

See Also:



3338
3339
3340
3341
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3338

def update_cost_azure_uc_configs(, body, opts = {})
  data, _status_code, _headers = update_cost_azure_uc_configs_with_http_info(, body, opts)
  data
end

#update_cost_azure_uc_configs_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(AzureUCConfigPairsResponse, Integer, Hash)>

Update Cloud Cost Management Azure config.

Update the status of an Azure config (active/archived).

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

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

    the optional parameters

Returns:

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

    AzureUCConfigPairsResponse data, response status code and response headers



3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3351

def update_cost_azure_uc_configs_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_azure_uc_configs ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_azure_uc_configs"
  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 CloudCostManagementAPI.update_cost_azure_uc_configs"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'AzureUCConfigPairsResponse'

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

  new_options = opts.merge(
    :operation => :update_cost_azure_uc_configs,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_gcp_usage_cost_config(cloud_account_id, body, opts = {}) ⇒ Object

Update Google Cloud Usage Cost config.

See Also:



3410
3411
3412
3413
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3410

def update_cost_gcp_usage_cost_config(, body, opts = {})
  data, _status_code, _headers = update_cost_gcp_usage_cost_config_with_http_info(, body, opts)
  data
end

#update_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(GCPUsageCostConfigResponse, Integer, Hash)>

Update Google Cloud Usage Cost config.

Update the status of an Google Cloud Usage Cost config (active/archived).

Parameters:

Returns:

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

    GCPUsageCostConfigResponse data, response status code and response headers



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3423

def update_cost_gcp_usage_cost_config_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_gcp_usage_cost_config"
  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 CloudCostManagementAPI.update_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.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] || 'GCPUsageCostConfigResponse'

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

  new_options = opts.merge(
    :operation => :update_cost_gcp_usage_cost_config,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_custom_allocation_rule(rule_id, body, opts = {}) ⇒ Object

Update custom allocation rule.

See Also:



3482
3483
3484
3485
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3482

def update_custom_allocation_rule(rule_id, body, opts = {})
  data, _status_code, _headers = update_custom_allocation_rule_with_http_info(rule_id, body, opts)
  data
end

#update_custom_allocation_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Update custom allocation rule.

Update an existing custom allocation rule with new filters and allocation strategy.

**Strategy Methods:**

  • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.

  • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.

  • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).

  • USAGE_METRIC: Allocates based on usage metrics (implementation varies).

**Filter Conditions:**

  • Use value for single-value conditions: “is”, “is not”, “contains”, “=”, “!=”, “like”, “not like”

  • Use values for multi-value conditions: “in”, “not in”

  • Cannot use both value and values simultaneously.

**Supported operators**: is, is not, contains, in, not in, =, !=, like, not like

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

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

    the optional parameters

Returns:

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

    ArbitraryRuleResponse data, response status code and response headers



3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3508

def update_custom_allocation_rule_with_http_info(rule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.update_custom_allocation_rule"
  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 CloudCostManagementAPI.update_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.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] || 'ArbitraryRuleResponse'

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

  new_options = opts.merge(
    :operation => :update_custom_allocation_rule,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag_pipelines_ruleset(ruleset_id, body, opts = {}) ⇒ Object

Update tag pipeline ruleset.

See Also:



3567
3568
3569
3570
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3567

def update_tag_pipelines_ruleset(ruleset_id, body, opts = {})
  data, _status_code, _headers = update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts)
  data
end

#update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Update tag pipeline ruleset.

Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

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

    the optional parameters

Returns:

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

    RulesetResp data, response status code and response headers



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3580

def update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.update_tag_pipelines_ruleset"
  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 CloudCostManagementAPI.update_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.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] || 'RulesetResp'

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

  new_options = opts.merge(
    :operation => :update_tag_pipelines_ruleset,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_custom_costs_file(body, opts = {}) ⇒ Object

Upload Custom Costs file.

See Also:



3639
3640
3641
3642
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3639

def upload_custom_costs_file(body, opts = {})
  data, _status_code, _headers = upload_custom_costs_file_with_http_info(body, opts)
  data
end

#upload_custom_costs_file_with_http_info(body, opts = {}) ⇒ Array<(CustomCostsFileUploadResponse, Integer, Hash)>

Upload Custom Costs file.

Upload a Custom Costs file.

Parameters:

Returns:



3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3651

def upload_custom_costs_file_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upload_custom_costs_file ...'
  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 CloudCostManagementAPI.upload_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs'

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

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

  new_options = opts.merge(
    :operation => :upload_custom_costs_file,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upload_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_budget(body, opts = {}) ⇒ Object

Create or update a budget.

See Also:



3706
3707
3708
3709
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3706

def upsert_budget(body, opts = {})
  data, _status_code, _headers = upsert_budget_with_http_info(body, opts)
  data
end

#upsert_budget_with_http_info(body, opts = {}) ⇒ Array<(BudgetWithEntries, Integer, Hash)>

Create or update a budget.

Create a new budget or update an existing one.

Parameters:

Returns:

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

    BudgetWithEntries data, response status code and response headers



3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3718

def upsert_budget_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upsert_budget ...'
  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 CloudCostManagementAPI.upsert_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget'

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

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

  new_options = opts.merge(
    :operation => :upsert_budget,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upsert_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_budget(body, opts = {}) ⇒ Object

Validate budget.

See Also:



3773
3774
3775
3776
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3773

def validate_budget(body, opts = {})
  data, _status_code, _headers = validate_budget_with_http_info(body, opts)
  data
end

#validate_budget_with_http_info(body, opts = {}) ⇒ Array<(BudgetValidationResponse, Integer, Hash)>

Validate budget.

Validate a budget configuration without creating or modifying it

Parameters:

Returns:

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

    BudgetValidationResponse data, response status code and response headers



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3785

def validate_budget_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_budget ...'
  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 CloudCostManagementAPI.validate_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/validate'

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

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

  new_options = opts.merge(
    :operation => :validate_budget,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_csv_budget(opts = {}) ⇒ Object

Validate CSV budget.

See Also:



3840
3841
3842
3843
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3840

def validate_csv_budget(opts = {})
  data, _status_code, _headers = validate_csv_budget_with_http_info(opts)
  data
end

#validate_csv_budget_with_http_info(opts = {}) ⇒ Array<(ValidationResponse, Integer, Hash)>

Validate CSV budget.

Parameters:

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

    the optional parameters

Returns:

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

    ValidationResponse data, response status code and response headers



3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3848

def validate_csv_budget_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_csv_budget ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/csv/validate'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :validate_csv_budget,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_csv_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_query(body, opts = {}) ⇒ Object

Validate query.

See Also:



3897
3898
3899
3900
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3897

def validate_query(body, opts = {})
  data, _status_code, _headers = validate_query_with_http_info(body, opts)
  data
end

#validate_query_with_http_info(body, opts = {}) ⇒ Array<(RulesValidateQueryResponse, Integer, Hash)>

Validate query.

Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

Parameters:

Returns:

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

    RulesValidateQueryResponse data, response status code and response headers



3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3909

def validate_query_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_query ...'
  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 CloudCostManagementAPI.validate_query"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/validate-query'

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

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

  new_options = opts.merge(
    :operation => :validate_query,
    :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::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end