datadog_api_client 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +6 -6
- data/.github/workflows/scripts/test_integration.js +24 -0
- data/.github/workflows/test.yml +4 -0
- data/.github/workflows/test_integration.yml +87 -0
- data/.openapi-generator/FILES +48 -0
- data/CHANGELOG.md +18 -0
- data/README.md +1 -1
- data/data/v1/openapi.yaml +1133 -99
- data/data/v2/openapi.yaml +420 -13
- data/docs/v1/Downtime.md +2 -0
- data/docs/v1/DowntimeChild.md +48 -0
- data/docs/v1/MetricsAPI.md +1 -1
- data/docs/v1/Monitor.md +3 -3
- data/docs/v1/MonitorGroupSearchResponse.md +22 -0
- data/docs/v1/MonitorGroupSearchResponseCounts.md +20 -0
- data/docs/v1/MonitorGroupSearchResult.md +30 -0
- data/docs/v1/MonitorOptions.md +1 -1
- data/docs/v1/MonitorSearchResponse.md +22 -0
- data/docs/v1/MonitorSearchResponseCounts.md +24 -0
- data/docs/v1/MonitorSearchResponseMetadata.md +24 -0
- data/docs/v1/MonitorSearchResult.md +40 -0
- data/docs/v1/MonitorSearchResultNotification.md +20 -0
- data/docs/v1/MonitorsAPI.md +155 -13
- data/docs/v1/NotebookCreateDataAttributes.md +1 -1
- data/docs/v1/NotebookResponseDataAttributes.md +3 -3
- data/docs/v1/NotebookUpdateDataAttributes.md +1 -1
- data/docs/v1/NotebooksResponse.md +1 -1
- data/docs/v1/NotebooksResponseData.md +22 -0
- data/docs/v1/NotebooksResponseDataAttributes.md +30 -0
- data/docs/v1/README.md +25 -4
- data/docs/v1/SyntheticsAPI.md +62 -2
- data/docs/v1/SyntheticsAPITest.md +2 -2
- data/docs/v1/SyntheticsAPITestConfig.md +1 -1
- data/docs/v1/SyntheticsBrowserTest.md +2 -2
- data/docs/v1/SyntheticsConfigVariable.md +3 -1
- data/docs/v1/SyntheticsGlobalVariableValue.md +1 -1
- data/docs/v1/SyntheticsListGlobalVariablesResponse.md +18 -0
- data/docs/v1/SyntheticsTestConfig.md +1 -1
- data/docs/v1/SyntheticsTestDetails.md +2 -2
- data/docs/v1/UsageAttributionBody.md +2 -0
- data/docs/v1/UsageAttributionPagination.md +3 -7
- data/docs/v1/UsageAttributionValues.md +8 -0
- data/docs/v1/UsageAuditLogsHour.md +20 -0
- data/docs/v1/UsageAuditLogsResponse.md +18 -0
- data/docs/v1/UsageCWSHour.md +22 -0
- data/docs/v1/UsageCWSResponse.md +18 -0
- data/docs/v1/UsageCloudSecurityPostureManagementHour.md +22 -0
- data/docs/v1/UsageCloudSecurityPostureManagementResponse.md +18 -0
- data/docs/v1/UsageMeteringAPI.md +157 -21
- data/docs/v1/UsageSummaryDate.md +12 -4
- data/docs/v1/UsageSummaryDateOrg.md +12 -4
- data/docs/v1/UsageSummaryResponse.md +12 -4
- data/docs/v1/UsageTopAvgMetricsMetadata.md +2 -2
- data/docs/v1/WidgetCustomLink.md +7 -3
- data/docs/v2/IncidentServicesAPI.md +2 -2
- data/docs/v2/IncidentTeamsAPI.md +2 -2
- data/docs/v2/IncidentsAPI.md +2 -2
- data/docs/v2/IncidentsResponse.md +1 -1
- data/docs/v2/KeyManagementAPI.md +6 -6
- data/docs/v2/README.md +21 -0
- data/docs/v2/RelationshipToIncidentIntegrationMetadataData.md +1 -1
- data/docs/v2/RelationshipToIncidentIntegrationMetadatas.md +1 -1
- data/docs/v2/RolesAPI.md +4 -4
- data/docs/v2/SecurityFilter.md +22 -0
- data/docs/v2/SecurityFilterAttributes.md +30 -0
- data/docs/v2/SecurityFilterCreateAttributes.md +26 -0
- data/docs/v2/SecurityFilterCreateData.md +20 -0
- data/docs/v2/SecurityFilterCreateRequest.md +18 -0
- data/docs/v2/SecurityFilterDeleteResponse.md +18 -0
- data/docs/v2/SecurityFilterExclusionFilter.md +20 -0
- data/docs/v2/SecurityFilterExclusionFilterResponse.md +20 -0
- data/docs/v2/SecurityFilterFilteredDataType.md +15 -0
- data/docs/v2/SecurityFilterMeta.md +18 -0
- data/docs/v2/SecurityFilterResponse.md +20 -0
- data/docs/v2/SecurityFilterType.md +15 -0
- data/docs/v2/SecurityFilterUpdateAttributes.md +28 -0
- data/docs/v2/SecurityFilterUpdateData.md +20 -0
- data/docs/v2/SecurityFilterUpdateRequest.md +18 -0
- data/docs/v2/SecurityFiltersResponse.md +20 -0
- data/docs/v2/SecurityMonitoringAPI.md +316 -2
- data/docs/v2/UsersAPI.md +10 -10
- data/lib/datadog_api_client/v1.rb +18 -2
- data/lib/datadog_api_client/v1/api/metrics_api.rb +2 -2
- data/lib/datadog_api_client/v1/api/monitors_api.rb +163 -5
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +67 -0
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +180 -23
- data/lib/datadog_api_client/v1/models/downtime.rb +11 -1
- data/lib/datadog_api_client/v1/models/downtime_child.rb +427 -0
- data/lib/datadog_api_client/v1/models/monitor.rb +10 -0
- data/lib/datadog_api_client/v1/models/monitor_group_search_response.rb +243 -0
- data/lib/datadog_api_client/v1/models/monitor_group_search_response_counts.rb +237 -0
- data/lib/datadog_api_client/v1/models/monitor_group_search_result.rb +285 -0
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_search_response.rb +243 -0
- data/lib/datadog_api_client/v1/models/monitor_search_response_counts.rb +261 -0
- data/lib/datadog_api_client/v1/models/monitor_search_response_metadata.rb +253 -0
- data/lib/datadog_api_client/v1/models/monitor_search_result.rb +339 -0
- data/lib/datadog_api_client/v1/models/monitor_search_result_notification.rb +233 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_distribution_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_heat_map_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_log_stream_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_response_data_attributes.rb +3 -3
- data/lib/datadog_api_client/v1/models/notebook_timeseries_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_toplist_cell_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebook_update_data_attributes.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebooks_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/notebooks_response_data.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebooks_response_data_attributes.rb +317 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_test_config.rb +0 -5
- data/lib/datadog_api_client/v1/models/synthetics_config_variable.rb +11 -6
- data/lib/datadog_api_client/v1/models/synthetics_config_variable_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_global_variable_value.rb +0 -5
- data/lib/datadog_api_client/v1/models/synthetics_list_global_variables_response.rb +225 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_config.rb +0 -5
- data/lib/datadog_api_client/v1/models/usage_attribution_body.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_attribution_pagination.rb +10 -30
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +41 -1
- data/lib/datadog_api_client/v1/models/usage_audit_logs_hour.rb +233 -0
- data/lib/datadog_api_client/v1/models/{usage_compliance_response.rb → usage_audit_logs_response.rb} +6 -6
- data/lib/datadog_api_client/v1/models/{usage_compliance_hour.rb → usage_cloud_security_posture_management_hour.rb} +19 -19
- data/lib/datadog_api_client/v1/models/usage_cloud_security_posture_management_response.rb +225 -0
- data/lib/datadog_api_client/v1/models/usage_cws_hour.rb +243 -0
- data/lib/datadog_api_client/v1/models/usage_cws_response.rb +225 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +61 -22
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +61 -22
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +61 -22
- data/lib/datadog_api_client/v1/models/usage_top_avg_metrics_metadata.rb +2 -4
- data/lib/datadog_api_client/v1/models/widget_custom_link.rb +24 -14
- data/lib/datadog_api_client/v2.rb +16 -0
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +369 -0
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_type.rb +1 -1
- data/lib/datadog_api_client/v2/models/relationship_to_incident_integration_metadata_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/security_filter.rb +243 -0
- data/lib/datadog_api_client/v2/models/security_filter_attributes.rb +299 -0
- data/lib/datadog_api_client/v2/models/security_filter_create_attributes.rb +289 -0
- data/lib/datadog_api_client/v2/models/security_filter_create_data.rb +243 -0
- data/lib/datadog_api_client/v2/models/security_filter_create_request.rb +227 -0
- data/lib/datadog_api_client/v2/models/security_filter_delete_response.rb +222 -0
- data/lib/datadog_api_client/v2/models/security_filter_exclusion_filter.rb +243 -0
- data/lib/datadog_api_client/v2/models/security_filter_exclusion_filter_response.rb +233 -0
- data/lib/datadog_api_client/v2/models/security_filter_filtered_data_type.rb +39 -0
- data/lib/datadog_api_client/v2/models/security_filter_meta.rb +223 -0
- data/lib/datadog_api_client/v2/models/security_filter_response.rb +231 -0
- data/lib/datadog_api_client/v2/models/security_filter_type.rb +39 -0
- data/lib/datadog_api_client/v2/models/security_filter_update_attributes.rb +289 -0
- data/lib/datadog_api_client/v2/models/security_filter_update_data.rb +243 -0
- data/lib/datadog_api_client/v2/models/security_filter_update_request.rb +227 -0
- data/lib/datadog_api_client/v2/models/security_filters_response.rb +234 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/spec/v1/models/downtime_child_spec.rb +127 -0
- data/spec/v1/models/monitor_group_search_response_counts_spec.rb +43 -0
- data/spec/v1/models/monitor_group_search_response_spec.rb +49 -0
- data/spec/v1/models/monitor_group_search_result_spec.rb +73 -0
- data/spec/v1/models/monitor_search_response_counts_spec.rb +55 -0
- data/spec/v1/models/monitor_search_response_metadata_spec.rb +55 -0
- data/spec/v1/models/monitor_search_response_spec.rb +49 -0
- data/spec/v1/models/monitor_search_result_notification_spec.rb +43 -0
- data/spec/v1/models/monitor_search_result_spec.rb +103 -0
- data/spec/v1/models/notebooks_response_data_attributes_spec.rb +73 -0
- data/spec/v1/models/notebooks_response_data_spec.rb +49 -0
- data/spec/v1/models/synthetics_list_global_variables_response_spec.rb +37 -0
- data/spec/v1/models/usage_audit_logs_hour_spec.rb +43 -0
- data/spec/v1/models/{usage_compliance_response_spec.rb → usage_audit_logs_response_spec.rb} +6 -6
- data/spec/v1/models/usage_cloud_security_posture_management_hour_spec.rb +49 -0
- data/spec/v1/models/usage_cloud_security_posture_management_response_spec.rb +37 -0
- data/spec/v1/models/{usage_compliance_hour_spec.rb → usage_cws_hour_spec.rb} +8 -8
- data/spec/v1/models/usage_cws_response_spec.rb +37 -0
- data/spec/v2/models/security_filter_attributes_spec.rb +73 -0
- data/spec/v2/models/security_filter_create_attributes_spec.rb +61 -0
- data/spec/v2/models/security_filter_create_data_spec.rb +43 -0
- data/spec/v2/models/security_filter_create_request_spec.rb +37 -0
- data/spec/v2/models/security_filter_delete_response_spec.rb +37 -0
- data/spec/v2/models/security_filter_exclusion_filter_response_spec.rb +43 -0
- data/spec/v2/models/security_filter_exclusion_filter_spec.rb +43 -0
- data/spec/v2/models/security_filter_filtered_data_type_spec.rb +31 -0
- data/spec/v2/models/security_filter_meta_spec.rb +37 -0
- data/spec/v2/models/security_filter_response_spec.rb +43 -0
- data/spec/v2/models/security_filter_spec.rb +49 -0
- data/spec/v2/models/security_filter_type_spec.rb +31 -0
- data/spec/v2/models/security_filter_update_attributes_spec.rb +67 -0
- data/spec/v2/models/security_filter_update_data_spec.rb +43 -0
- data/spec/v2/models/security_filter_update_request_spec.rb +37 -0
- data/spec/v2/models/security_filters_response_spec.rb +43 -0
- metadata +140 -11
- data/.azure-pipelines/all.yml +0 -50
- data/docs/v1/UsageComplianceHour.md +0 -22
- data/docs/v1/UsageComplianceResponse.md +0 -18
@@ -0,0 +1,20 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageAuditLogsHour
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **hour** | **Time** | The hour for the usage. | [optional] |
|
8
|
+
| **lines_indexed** | **Integer** | The total number of audit logs lines indexed during a given hour. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'datadog_api_client/v1'
|
14
|
+
|
15
|
+
instance = DatadogAPIClient::V1::UsageAuditLogsHour.new(
|
16
|
+
hour: null,
|
17
|
+
lines_indexed: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageAuditLogsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage** | [**Array<UsageAuditLogsHour>**](UsageAuditLogsHour.md) | Get hourly usage for audit logs. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::UsageAuditLogsResponse.new(
|
15
|
+
usage: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageCWSHour
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cws_container_count** | **Integer** | The total number of Cloud Workload Security container hours from the start of the given hour’s month until the given hour. | [optional] |
|
8
|
+
| **cws_host_count** | **Integer** | The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour. | [optional] |
|
9
|
+
| **hour** | **Time** | The hour for the usage. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'datadog_api_client/v1'
|
15
|
+
|
16
|
+
instance = DatadogAPIClient::V1::UsageCWSHour.new(
|
17
|
+
cws_container_count: null,
|
18
|
+
cws_host_count: null,
|
19
|
+
hour: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageCWSResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage** | [**Array<UsageCWSHour>**](UsageCWSHour.md) | Get hourly usage for Cloud Workload Security. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::UsageCWSResponse.new(
|
15
|
+
usage: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageCloudSecurityPostureManagementHour
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **container_count** | **Integer** | The total number of Cloud Security Posture Management containers during a given hour. | [optional] |
|
8
|
+
| **host_count** | **Integer** | The total number of Cloud Security Posture Management hosts during a given hour. | [optional] |
|
9
|
+
| **hour** | **Time** | The hour for the usage. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'datadog_api_client/v1'
|
15
|
+
|
16
|
+
instance = DatadogAPIClient::V1::UsageCloudSecurityPostureManagementHour.new(
|
17
|
+
container_count: null,
|
18
|
+
host_count: null,
|
19
|
+
hour: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::UsageCloudSecurityPostureManagementResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage** | [**Array<UsageCloudSecurityPostureManagementHour>**](UsageCloudSecurityPostureManagementHour.md) | Get hourly usage for Cloud Security Posture Management. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::UsageCloudSecurityPostureManagementResponse.new(
|
15
|
+
usage: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/v1/UsageMeteringAPI.md
CHANGED
@@ -13,8 +13,10 @@ All URIs are relative to *https://api.datadoghq.com*
|
|
13
13
|
| [**get_tracing_without_limits**](UsageMeteringAPI.md#get_tracing_without_limits) | **GET** /api/v1/usage/tracing-without-limits | Get hourly usage for tracing without limits |
|
14
14
|
| [**get_usage_analyzed_logs**](UsageMeteringAPI.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs |
|
15
15
|
| [**get_usage_attribution**](UsageMeteringAPI.md#get_usage_attribution) | **GET** /api/v1/usage/attribution | Get Usage Attribution |
|
16
|
+
| [**get_usage_audit_logs**](UsageMeteringAPI.md#get_usage_audit_logs) | **GET** /api/v1/usage/audit_logs | Get hourly usage for audit logs |
|
16
17
|
| [**get_usage_billable_summary**](UsageMeteringAPI.md#get_usage_billable_summary) | **GET** /api/v1/usage/billable-summary | Get billable usage across your account |
|
17
|
-
| [**
|
18
|
+
| [**get_usage_cloud_security_posture_management**](UsageMeteringAPI.md#get_usage_cloud_security_posture_management) | **GET** /api/v1/usage/cspm | Get hourly usage for CSPM |
|
19
|
+
| [**get_usage_cws**](UsageMeteringAPI.md#get_usage_cws) | **GET** /api/v1/usage/cws | Get hourly usage for Cloud Workload Security |
|
18
20
|
| [**get_usage_fargate**](UsageMeteringAPI.md#get_usage_fargate) | **GET** /api/v1/usage/fargate | Get hourly usage for Fargate |
|
19
21
|
| [**get_usage_hosts**](UsageMeteringAPI.md#get_usage_hosts) | **GET** /api/v1/usage/hosts | Get hourly usage for hosts and containers |
|
20
22
|
| [**get_usage_indexed_spans**](UsageMeteringAPI.md#get_usage_indexed_spans) | **GET** /api/v1/usage/indexed-spans | Get hourly usage for indexed spans |
|
@@ -33,7 +35,7 @@ All URIs are relative to *https://api.datadoghq.com*
|
|
33
35
|
| [**get_usage_synthetics_api**](UsageMeteringAPI.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks |
|
34
36
|
| [**get_usage_synthetics_browser**](UsageMeteringAPI.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks |
|
35
37
|
| [**get_usage_timeseries**](UsageMeteringAPI.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics |
|
36
|
-
| [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get
|
38
|
+
| [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get all custom metrics by hourly average |
|
37
39
|
| [**get_usage_trace**](UsageMeteringAPI.md#get_usage_trace) | **GET** /api/v1/usage/traces | Get hourly usage for Trace Search |
|
38
40
|
|
39
41
|
|
@@ -662,6 +664,72 @@ end
|
|
662
664
|
- **Accept**: application/json;datetime-format=rfc3339
|
663
665
|
|
664
666
|
|
667
|
+
## get_usage_audit_logs
|
668
|
+
|
669
|
+
> <UsageAuditLogsResponse> get_usage_audit_logs(start_hr, opts)
|
670
|
+
|
671
|
+
Get hourly usage for audit logs
|
672
|
+
|
673
|
+
Get hourly usage for audit logs.
|
674
|
+
|
675
|
+
### Examples
|
676
|
+
|
677
|
+
```ruby
|
678
|
+
require 'datadog_api_client'
|
679
|
+
api_instance = DatadogAPIClient::V1::UsageMeteringAPI.new
|
680
|
+
start_hr = Time.parse('2013-10-20T19:20:30+01:00') # Time | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
|
681
|
+
opts = {
|
682
|
+
end_hr: Time.parse('2013-10-20T19:20:30+01:00') # Time | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.
|
683
|
+
}
|
684
|
+
|
685
|
+
begin
|
686
|
+
# Get hourly usage for audit logs
|
687
|
+
result = api_instance.get_usage_audit_logs(start_hr, opts)
|
688
|
+
p result
|
689
|
+
rescue DatadogAPIClient::V1::APIError => e
|
690
|
+
puts "Error when calling UsageMeteringAPI->get_usage_audit_logs: #{e}"
|
691
|
+
end
|
692
|
+
```
|
693
|
+
|
694
|
+
#### Using the get_usage_audit_logs_with_http_info variant
|
695
|
+
|
696
|
+
This returns an Array which contains the response data, status code and headers.
|
697
|
+
|
698
|
+
> <Array(<UsageAuditLogsResponse>, Integer, Hash)> get_usage_audit_logs_with_http_info(start_hr, opts)
|
699
|
+
|
700
|
+
```ruby
|
701
|
+
begin
|
702
|
+
# Get hourly usage for audit logs
|
703
|
+
data, status_code, headers = api_instance.get_usage_audit_logs_with_http_info(start_hr, opts)
|
704
|
+
p status_code # => 2xx
|
705
|
+
p headers # => { ... }
|
706
|
+
p data # => <UsageAuditLogsResponse>
|
707
|
+
rescue DatadogAPIClient::V1::APIError => e
|
708
|
+
puts "Error when calling UsageMeteringAPI->get_usage_audit_logs_with_http_info: #{e}"
|
709
|
+
end
|
710
|
+
```
|
711
|
+
|
712
|
+
### Parameters
|
713
|
+
|
714
|
+
| Name | Type | Description | Notes |
|
715
|
+
| ---- | ---- | ----------- | ----- |
|
716
|
+
| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | |
|
717
|
+
| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] |
|
718
|
+
|
719
|
+
### Return type
|
720
|
+
|
721
|
+
[**UsageAuditLogsResponse**](UsageAuditLogsResponse.md)
|
722
|
+
|
723
|
+
### Authorization
|
724
|
+
|
725
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
726
|
+
|
727
|
+
### HTTP request headers
|
728
|
+
|
729
|
+
- **Content-Type**: Not defined
|
730
|
+
- **Accept**: application/json;datetime-format=rfc3339
|
731
|
+
|
732
|
+
|
665
733
|
## get_usage_billable_summary
|
666
734
|
|
667
735
|
> <UsageBillableSummaryResponse> get_usage_billable_summary(opts)
|
@@ -726,13 +794,79 @@ end
|
|
726
794
|
- **Accept**: application/json;datetime-format=rfc3339
|
727
795
|
|
728
796
|
|
729
|
-
##
|
797
|
+
## get_usage_cloud_security_posture_management
|
798
|
+
|
799
|
+
> <UsageCloudSecurityPostureManagementResponse> get_usage_cloud_security_posture_management(start_hr, opts)
|
800
|
+
|
801
|
+
Get hourly usage for CSPM
|
802
|
+
|
803
|
+
Get hourly usage for Cloud Security Posture Management (CSPM).
|
804
|
+
|
805
|
+
### Examples
|
806
|
+
|
807
|
+
```ruby
|
808
|
+
require 'datadog_api_client'
|
809
|
+
api_instance = DatadogAPIClient::V1::UsageMeteringAPI.new
|
810
|
+
start_hr = Time.parse('2013-10-20T19:20:30+01:00') # Time | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
|
811
|
+
opts = {
|
812
|
+
end_hr: Time.parse('2013-10-20T19:20:30+01:00') # Time | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.
|
813
|
+
}
|
814
|
+
|
815
|
+
begin
|
816
|
+
# Get hourly usage for CSPM
|
817
|
+
result = api_instance.get_usage_cloud_security_posture_management(start_hr, opts)
|
818
|
+
p result
|
819
|
+
rescue DatadogAPIClient::V1::APIError => e
|
820
|
+
puts "Error when calling UsageMeteringAPI->get_usage_cloud_security_posture_management: #{e}"
|
821
|
+
end
|
822
|
+
```
|
823
|
+
|
824
|
+
#### Using the get_usage_cloud_security_posture_management_with_http_info variant
|
825
|
+
|
826
|
+
This returns an Array which contains the response data, status code and headers.
|
827
|
+
|
828
|
+
> <Array(<UsageCloudSecurityPostureManagementResponse>, Integer, Hash)> get_usage_cloud_security_posture_management_with_http_info(start_hr, opts)
|
829
|
+
|
830
|
+
```ruby
|
831
|
+
begin
|
832
|
+
# Get hourly usage for CSPM
|
833
|
+
data, status_code, headers = api_instance.get_usage_cloud_security_posture_management_with_http_info(start_hr, opts)
|
834
|
+
p status_code # => 2xx
|
835
|
+
p headers # => { ... }
|
836
|
+
p data # => <UsageCloudSecurityPostureManagementResponse>
|
837
|
+
rescue DatadogAPIClient::V1::APIError => e
|
838
|
+
puts "Error when calling UsageMeteringAPI->get_usage_cloud_security_posture_management_with_http_info: #{e}"
|
839
|
+
end
|
840
|
+
```
|
841
|
+
|
842
|
+
### Parameters
|
843
|
+
|
844
|
+
| Name | Type | Description | Notes |
|
845
|
+
| ---- | ---- | ----------- | ----- |
|
846
|
+
| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | |
|
847
|
+
| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] |
|
848
|
+
|
849
|
+
### Return type
|
850
|
+
|
851
|
+
[**UsageCloudSecurityPostureManagementResponse**](UsageCloudSecurityPostureManagementResponse.md)
|
852
|
+
|
853
|
+
### Authorization
|
854
|
+
|
855
|
+
[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
|
856
|
+
|
857
|
+
### HTTP request headers
|
858
|
+
|
859
|
+
- **Content-Type**: Not defined
|
860
|
+
- **Accept**: application/json;datetime-format=rfc3339
|
861
|
+
|
862
|
+
|
863
|
+
## get_usage_cws
|
730
864
|
|
731
|
-
> <
|
865
|
+
> <UsageCWSResponse> get_usage_cws(start_hr, opts)
|
732
866
|
|
733
|
-
Get hourly usage for
|
867
|
+
Get hourly usage for Cloud Workload Security
|
734
868
|
|
735
|
-
Get hourly usage for
|
869
|
+
Get hourly usage for Cloud Workload Security.
|
736
870
|
|
737
871
|
### Examples
|
738
872
|
|
@@ -745,29 +879,29 @@ opts = {
|
|
745
879
|
}
|
746
880
|
|
747
881
|
begin
|
748
|
-
# Get hourly usage for
|
749
|
-
result = api_instance.
|
882
|
+
# Get hourly usage for Cloud Workload Security
|
883
|
+
result = api_instance.get_usage_cws(start_hr, opts)
|
750
884
|
p result
|
751
885
|
rescue DatadogAPIClient::V1::APIError => e
|
752
|
-
puts "Error when calling UsageMeteringAPI->
|
886
|
+
puts "Error when calling UsageMeteringAPI->get_usage_cws: #{e}"
|
753
887
|
end
|
754
888
|
```
|
755
889
|
|
756
|
-
#### Using the
|
890
|
+
#### Using the get_usage_cws_with_http_info variant
|
757
891
|
|
758
892
|
This returns an Array which contains the response data, status code and headers.
|
759
893
|
|
760
|
-
> <Array(<
|
894
|
+
> <Array(<UsageCWSResponse>, Integer, Hash)> get_usage_cws_with_http_info(start_hr, opts)
|
761
895
|
|
762
896
|
```ruby
|
763
897
|
begin
|
764
|
-
# Get hourly usage for
|
765
|
-
data, status_code, headers = api_instance.
|
898
|
+
# Get hourly usage for Cloud Workload Security
|
899
|
+
data, status_code, headers = api_instance.get_usage_cws_with_http_info(start_hr, opts)
|
766
900
|
p status_code # => 2xx
|
767
901
|
p headers # => { ... }
|
768
|
-
p data # => <
|
902
|
+
p data # => <UsageCWSResponse>
|
769
903
|
rescue DatadogAPIClient::V1::APIError => e
|
770
|
-
puts "Error when calling UsageMeteringAPI->
|
904
|
+
puts "Error when calling UsageMeteringAPI->get_usage_cws_with_http_info: #{e}"
|
771
905
|
end
|
772
906
|
```
|
773
907
|
|
@@ -780,7 +914,7 @@ end
|
|
780
914
|
|
781
915
|
### Return type
|
782
916
|
|
783
|
-
[**
|
917
|
+
[**UsageCWSResponse**](UsageCWSResponse.md)
|
784
918
|
|
785
919
|
### Authorization
|
786
920
|
|
@@ -1990,9 +2124,9 @@ end
|
|
1990
2124
|
|
1991
2125
|
> <UsageTopAvgMetricsResponse> get_usage_top_avg_metrics(opts)
|
1992
2126
|
|
1993
|
-
Get
|
2127
|
+
Get all custom metrics by hourly average
|
1994
2128
|
|
1995
|
-
Get
|
2129
|
+
Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed.
|
1996
2130
|
|
1997
2131
|
### Examples
|
1998
2132
|
|
@@ -2003,11 +2137,12 @@ opts = {
|
|
2003
2137
|
month: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)
|
2004
2138
|
day: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)
|
2005
2139
|
names: ['inner_example'], # Array<String> | Comma-separated list of metric names.
|
2006
|
-
limit: 56 # Integer | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.
|
2140
|
+
limit: 56, # Integer | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.
|
2141
|
+
next_record_id: 'next_record_id_example' # String | List following results with a next_record_id provided in the previous query.
|
2007
2142
|
}
|
2008
2143
|
|
2009
2144
|
begin
|
2010
|
-
# Get
|
2145
|
+
# Get all custom metrics by hourly average
|
2011
2146
|
result = api_instance.get_usage_top_avg_metrics(opts)
|
2012
2147
|
p result
|
2013
2148
|
rescue DatadogAPIClient::V1::APIError => e
|
@@ -2023,7 +2158,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
2023
2158
|
|
2024
2159
|
```ruby
|
2025
2160
|
begin
|
2026
|
-
# Get
|
2161
|
+
# Get all custom metrics by hourly average
|
2027
2162
|
data, status_code, headers = api_instance.get_usage_top_avg_metrics_with_http_info(opts)
|
2028
2163
|
p status_code # => 2xx
|
2029
2164
|
p headers # => { ... }
|
@@ -2041,6 +2176,7 @@ end
|
|
2041
2176
|
| **day** | **Time** | Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both) | [optional] |
|
2042
2177
|
| **names** | **Array<String>** | Comma-separated list of metric names. | [optional] |
|
2043
2178
|
| **limit** | **Integer** | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. | [optional][default to 500] |
|
2179
|
+
| **next_record_id** | **String** | List following results with a next_record_id provided in the previous query. | [optional] |
|
2044
2180
|
|
2045
2181
|
### Return type
|
2046
2182
|
|
data/docs/v1/UsageSummaryDate.md
CHANGED
@@ -7,16 +7,20 @@
|
|
7
7
|
| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. | [optional] |
|
8
8
|
| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. | [optional] |
|
9
9
|
| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. | [optional] |
|
10
|
+
| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of audit logs lines indexed over all hours in the current date for all organizations. | [optional] |
|
10
11
|
| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. | [optional] |
|
11
12
|
| **aws_lambda_func_count** | **Integer** | Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. | [optional] |
|
12
13
|
| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. | [optional] |
|
13
14
|
| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. | [optional] |
|
14
15
|
| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for all organizations. | [optional] |
|
15
|
-
| **compliance_container_count_sum** | **Object** | Shows the sum of compliance containers over all hours in the current date for all organizations. | [optional] |
|
16
|
-
| **compliance_host_count_sum** | **Integer** | Shows the sum of compliance hosts over all hours in the current date for all organizations. | [optional] |
|
17
16
|
| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for all organizations. | [optional] |
|
18
17
|
| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. | [optional] |
|
18
|
+
| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] |
|
19
|
+
| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] |
|
20
|
+
| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for all organizations. | [optional] |
|
19
21
|
| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for all organizations. | [optional] |
|
22
|
+
| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations. | [optional] |
|
23
|
+
| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations. | [optional] |
|
20
24
|
| **date** | **Time** | The date for the usage. | [optional] |
|
21
25
|
| **fargate_tasks_count_avg** | **Integer** | Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. | [optional] |
|
22
26
|
| **fargate_tasks_count_hwm** | **Integer** | Shows the average of all Fargate tasks over all hours in the current date for all organizations. | [optional] |
|
@@ -53,16 +57,20 @@ instance = DatadogAPIClient::V1::UsageSummaryDate.new(
|
|
53
57
|
agent_host_top99p: null,
|
54
58
|
apm_azure_app_service_host_top99p: null,
|
55
59
|
apm_host_top99p: null,
|
60
|
+
audit_logs_lines_indexed_sum: null,
|
56
61
|
aws_host_top99p: null,
|
57
62
|
aws_lambda_func_count: null,
|
58
63
|
aws_lambda_invocations_sum: null,
|
59
64
|
azure_app_service_top99p: null,
|
60
65
|
billable_ingested_bytes_sum: null,
|
61
|
-
compliance_container_count_sum: null,
|
62
|
-
compliance_host_count_sum: null,
|
63
66
|
container_avg: null,
|
64
67
|
container_hwm: null,
|
68
|
+
cspm_container_avg: null,
|
69
|
+
cspm_container_hwm: null,
|
70
|
+
cspm_host_top99p: null,
|
65
71
|
custom_ts_avg: null,
|
72
|
+
cws_container_count_avg: null,
|
73
|
+
cws_host_top99p: null,
|
66
74
|
date: null,
|
67
75
|
fargate_tasks_count_avg: null,
|
68
76
|
fargate_tasks_count_hwm: null,
|
@@ -7,16 +7,20 @@
|
|
7
7
|
| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. | [optional] |
|
8
8
|
| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. | [optional] |
|
9
9
|
| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. | [optional] |
|
10
|
+
| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of all audit logs lines indexed over all hours in the current date for the given org. | [optional] |
|
10
11
|
| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. | [optional] |
|
11
12
|
| **aws_lambda_func_count** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] |
|
12
13
|
| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] |
|
13
14
|
| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. | [optional] |
|
14
15
|
| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for the given org. | [optional] |
|
15
|
-
| **compliance_container_agg_sum** | **Object** | Shows the sum of all compliance containers over all hours in the current date for the given org. | [optional] |
|
16
|
-
| **compliance_host_agg_sum** | **Integer** | Shows the sum of all compliance hosts over all hours in the current date for the given org. | [optional] |
|
17
16
|
| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for the given org. | [optional] |
|
18
17
|
| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for the given org. | [optional] |
|
18
|
+
| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] |
|
19
|
+
| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] |
|
20
|
+
| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for the given org. | [optional] |
|
19
21
|
| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for the given org. | [optional] |
|
22
|
+
| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org. | [optional] |
|
23
|
+
| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org. | [optional] |
|
20
24
|
| **fargate_tasks_count_avg** | **Integer** | The average task count for Fargate. | [optional] |
|
21
25
|
| **fargate_tasks_count_hwm** | **Integer** | Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. | [optional] |
|
22
26
|
| **gcp_host_top99p** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. | [optional] |
|
@@ -54,16 +58,20 @@ instance = DatadogAPIClient::V1::UsageSummaryDateOrg.new(
|
|
54
58
|
agent_host_top99p: null,
|
55
59
|
apm_azure_app_service_host_top99p: null,
|
56
60
|
apm_host_top99p: null,
|
61
|
+
audit_logs_lines_indexed_sum: null,
|
57
62
|
aws_host_top99p: null,
|
58
63
|
aws_lambda_func_count: null,
|
59
64
|
aws_lambda_invocations_sum: null,
|
60
65
|
azure_app_service_top99p: null,
|
61
66
|
billable_ingested_bytes_sum: null,
|
62
|
-
compliance_container_agg_sum: null,
|
63
|
-
compliance_host_agg_sum: null,
|
64
67
|
container_avg: null,
|
65
68
|
container_hwm: null,
|
69
|
+
cspm_container_avg: null,
|
70
|
+
cspm_container_hwm: null,
|
71
|
+
cspm_host_top99p: null,
|
66
72
|
custom_ts_avg: null,
|
73
|
+
cws_container_count_avg: null,
|
74
|
+
cws_host_top99p: null,
|
67
75
|
fargate_tasks_count_avg: null,
|
68
76
|
fargate_tasks_count_hwm: null,
|
69
77
|
gcp_host_top99p: null,
|