@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class UsageMeteringApi extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
UsageMeteringApi.CreateQuotasOptionalParameters
Manage optional parameters to createQuotas.
|
static class |
UsageMeteringApi.GetBillingDimensionMappingOptionalParameters
Manage optional parameters to getBillingDimensionMapping.
|
static class |
UsageMeteringApi.GetCostByOrgOptionalParameters
Manage optional parameters to getCostByOrg.
|
static class |
UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters
Manage optional parameters to getEstimatedCostByOrg.
|
static class |
UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters
Manage optional parameters to getHistoricalCostByOrg.
|
static class |
UsageMeteringApi.GetHourlyUsageOptionalParameters
Manage optional parameters to getHourlyUsage.
|
static class |
UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters
Manage optional parameters to getMonthlyCostAttribution.
|
static class |
UsageMeteringApi.GetProjectedCostOptionalParameters
Manage optional parameters to getProjectedCost.
|
static class |
UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters
Manage optional parameters to getUsageApplicationSecurityMonitoring.
|
static class |
UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters
Manage optional parameters to getUsageLambdaTracedInvocations.
|
static class |
UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters
Manage optional parameters to getUsageObservabilityPipelines.
|
static class |
UsageMeteringApi.ListQuotasOptionalParameters
Manage optional parameters to listQuotas.
|
| Constructor and Description |
|---|
UsageMeteringApi() |
UsageMeteringApi(ApiClient apiClient) |
public UsageMeteringApi()
public UsageMeteringApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - an instance of API clientpublic UsageQuotasBulkResponse createQuotas(String quotaNamespace, UsageQuotasCreateRequest body) throws ApiException
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)ApiException - if fails to make API callpublic CompletableFuture<UsageQuotasBulkResponse> createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)public UsageQuotasBulkResponse createQuotas(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) throws ApiException
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<UsageQuotasBulkResponse> createQuotasAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)parameters - Optional parameters for the request.public ApiResponse<UsageQuotasBulkResponse> createQuotasWithHttpInfo(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters) throws ApiException
user_access_manage
, billing_edit, and org_management permissions.quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK. The response includes each item's result; see each item's `error` attribute for any that failed to write. | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
| 500 | Internal Server Error. Every item in the batch failed to write. | - |
public CompletableFuture<ApiResponse<UsageQuotasBulkResponse>> createQuotasWithHttpInfoAsync(String quotaNamespace, UsageQuotasCreateRequest body, UsageMeteringApi.CreateQuotasOptionalParameters parameters)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)body - The usage quotas to create or update. (required)parameters - Optional parameters for the request.public void deleteQuota(String quotaNamespace, String id) throws ApiException
See deleteQuotaWithHttpInfo(java.lang.String, java.lang.String).
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)ApiException - if fails to make API callpublic CompletableFuture<Void> deleteQuotaAsync(String quotaNamespace, String id)
See deleteQuotaWithHttpInfoAsync(java.lang.String, java.lang.String).
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)public ApiResponse<Void> deleteQuotaWithHttpInfo(String quotaNamespace, String id) throws ApiException
user_access_manage, billing_edit, and
org_management permissions.quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<Void>> deleteQuotaWithHttpInfoAsync(String quotaNamespace, String id)
See deleteQuotaWithHttpInfo(java.lang.String, java.lang.String).
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)public ActiveBillingDimensionsResponse getActiveBillingDimensions() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<ActiveBillingDimensionsResponse> getActiveBillingDimensionsAsync()
public ApiResponse<ActiveBillingDimensionsResponse> getActiveBillingDimensionsWithHttpInfo() throws ApiException
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<ActiveBillingDimensionsResponse>> getActiveBillingDimensionsWithHttpInfoAsync()
public BillingDimensionsMappingResponse getBillingDimensionMapping() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<BillingDimensionsMappingResponse> getBillingDimensionMappingAsync()
public BillingDimensionsMappingResponse getBillingDimensionMapping(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<BillingDimensionsMappingResponse> getBillingDimensionMappingAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<BillingDimensionsMappingResponse> getBillingDimensionMappingWithHttpInfo(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters) throws ApiException
This endpoint is only accessible to parent-level organizations.
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<BillingDimensionsMappingResponse>> getBillingDimensionMappingWithHttpInfoAsync(UsageMeteringApi.GetBillingDimensionMappingOptionalParameters parameters)
parameters - Optional parameters for the request.@Deprecated public CostByOrgResponse getCostByOrg(OffsetDateTime startMonth) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)ApiException - if fails to make API call@Deprecated public CompletableFuture<CostByOrgResponse> getCostByOrgAsync(OffsetDateTime startMonth)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)@Deprecated public CostByOrgResponse getCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call@Deprecated public CompletableFuture<CostByOrgResponse> getCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.@Deprecated public ApiResponse<CostByOrgResponse> getCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters) throws ApiException
/historical_cost instead.
This endpoint is only accessible for parent-level organizations.
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
@Deprecated public CompletableFuture<ApiResponse<CostByOrgResponse>> getCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetCostByOrgOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.public CostByOrgResponse getEstimatedCostByOrg() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<CostByOrgResponse> getEstimatedCostByOrgAsync()
public CostByOrgResponse getEstimatedCostByOrg(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<CostByOrgResponse> getEstimatedCostByOrgAsync(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<CostByOrgResponse> getEstimatedCostByOrgWithHttpInfo(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters) throws ApiException
/historical_cost
endpoint.
This endpoint is only accessible for parent-level organizations.
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<CostByOrgResponse>> getEstimatedCostByOrgWithHttpInfoAsync(UsageMeteringApi.GetEstimatedCostByOrgOptionalParameters parameters)
parameters - Optional parameters for the request.public CostByOrgResponse getHistoricalCostByOrg(OffsetDateTime startMonth) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)ApiException - if fails to make API callpublic CompletableFuture<CostByOrgResponse> getHistoricalCostByOrgAsync(OffsetDateTime startMonth)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)public CostByOrgResponse getHistoricalCostByOrg(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<CostByOrgResponse> getHistoricalCostByOrgAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.public ApiResponse<CostByOrgResponse> getHistoricalCostByOrgWithHttpInfo(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters) throws ApiException
This endpoint is only accessible for parent-level organizations.
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<CostByOrgResponse>> getHistoricalCostByOrgWithHttpInfoAsync(OffsetDateTime startMonth, UsageMeteringApi.GetHistoricalCostByOrgOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning this month. (required)parameters - Optional parameters for the request.public HourlyUsageResponse getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies) throws ApiException
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)ApiException - if fails to make API callpublic CompletableFuture<HourlyUsageResponse> getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies)
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)public HourlyUsageResponse getHourlyUsage(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) throws ApiException
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<HourlyUsageResponse> getHourlyUsageAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters)
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)parameters - Optional parameters for the request.public ApiResponse<HourlyUsageResponse> getHourlyUsageWithHttpInfo(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters) throws ApiException
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<HourlyUsageResponse>> getHourlyUsageWithHttpInfoAsync(OffsetDateTime filterTimestampStart, String filterProductFamilies, UsageMeteringApi.GetHourlyUsageOptionalParameters parameters)
filterTimestampStart - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)filterProductFamilies - Comma separated list of product families to retrieve. Available
families are all, ai, analyzed_logs,
application_performance_monitoring, application_security,
audit_trail, bits_ai, serverless, ci_app,
cloud_cost_management, cloud_siem, csm_container_enterprise
, csm_host_enterprise, csm_host_pro, cspm,
custom_events, cws, data_observability, dbm
, digital_experience_management, error_tracking,
fargate, infra_hosts, incident_management,
indexed_logs, indexed_spans, infrastructure_monitoring,
ingested_spans, iot, lambda_traced_invocations,
llm_observability, log_management, logs,
network_flows, network_hosts, network_monitoring,
observability_pipelines, online_archive, platform_capabilities
, product_analytics, profiling, rum,
rum_browser_sessions, rum_mobile_sessions, sds,
security, snmp, software_delivery, synthetics_api
, synthetics_browser, synthetics_mobile,
synthetics_parallel_testing, timeseries, vuln_management
and workflow_executions. The following product family has been
deprecated: audit_logs. (required)parameters - Optional parameters for the request.public MonthlyCostAttributionResponse getMonthlyCostAttribution(OffsetDateTime startMonth, String fields) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)ApiException - if fails to make API callpublic CompletableFuture<MonthlyCostAttributionResponse> getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)public MonthlyCostAttributionResponse getMonthlyCostAttribution(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) throws ApiException
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<MonthlyCostAttributionResponse> getMonthlyCostAttributionAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)parameters - Optional parameters for the request.public ApiResponse<MonthlyCostAttributionResponse> getMonthlyCostAttributionWithHttpInfo(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters) throws ApiException
next_record_id is set in the response. If it is, make another request and pass
next_record_id as a parameter. Pseudo code example:
response := GetMonthlyCostAttribution(start_month, end_month)
cursor := response.metadata.pagination.next_record_id
WHILE cursor != null BEGIN
sleep(5 seconds) # Avoid running into rate limit
response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)
cursor := response.metadata.pagination.next_record_id
END
This endpoint is only accessible for parent-level organizations. This endpoint is not available in the Government (US1-FED) site.
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<MonthlyCostAttributionResponse>> getMonthlyCostAttributionWithHttpInfoAsync(OffsetDateTime startMonth, String fields, UsageMeteringApi.GetMonthlyCostAttributionOptionalParameters parameters)
startMonth - Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]
for cost beginning in this month. (required)fields - Comma-separated list specifying cost types (e.g.,
<billing_dimension>_on_demand_cost,
<billing_dimension>_committed_cost, <billing_dimension>_total_cost
) and the proportions (<billing_dimension>_percentage_in_org,
<billing_dimension>_percentage_in_account). Use * to
retrieve all fields. Example:
infra_host_on_demand_cost,infra_host_percentage_in_account To obtain the complete
list of active billing dimensions that can be used to replace
<billing_dimension> in the field names, make a request to the Get
active billing dimensions API. (required)parameters - Optional parameters for the request.public ProjectedCostResponse getProjectedCost() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<ProjectedCostResponse> getProjectedCostAsync()
public ProjectedCostResponse getProjectedCost(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<ProjectedCostResponse> getProjectedCostAsync(UsageMeteringApi.GetProjectedCostOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<ProjectedCostResponse> getProjectedCostWithHttpInfo(UsageMeteringApi.GetProjectedCostOptionalParameters parameters) throws ApiException
This endpoint is only accessible for parent-level organizations.
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<ProjectedCostResponse>> getProjectedCostWithHttpInfoAsync(UsageMeteringApi.GetProjectedCostOptionalParameters parameters)
parameters - Optional parameters for the request.@Deprecated public UsageApplicationSecurityMonitoringResponse getUsageApplicationSecurityMonitoring(OffsetDateTime startHr) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringAsync(OffsetDateTime startHr)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)@Deprecated public UsageApplicationSecurityMonitoringResponse getUsageApplicationSecurityMonitoring(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.@Deprecated public ApiResponse<UsageApplicationSecurityMonitoringResponse> getUsageApplicationSecurityMonitoringWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
@Deprecated public CompletableFuture<ApiResponse<UsageApplicationSecurityMonitoringResponse>> getUsageApplicationSecurityMonitoringWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageApplicationSecurityMonitoringOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.public UsageAttributionTypesResponse getUsageAttributionTypes() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<UsageAttributionTypesResponse> getUsageAttributionTypesAsync()
public ApiResponse<UsageAttributionTypesResponse> getUsageAttributionTypesWithHttpInfo() throws ApiException
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<UsageAttributionTypesResponse>> getUsageAttributionTypesWithHttpInfoAsync()
@Deprecated public UsageLambdaTracedInvocationsResponse getUsageLambdaTracedInvocations(OffsetDateTime startHr) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsAsync(OffsetDateTime startHr)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)@Deprecated public UsageLambdaTracedInvocationsResponse getUsageLambdaTracedInvocations(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.@Deprecated public ApiResponse<UsageLambdaTracedInvocationsResponse> getUsageLambdaTracedInvocationsWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
@Deprecated public CompletableFuture<ApiResponse<UsageLambdaTracedInvocationsResponse>> getUsageLambdaTracedInvocationsWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageLambdaTracedInvocationsOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.@Deprecated public UsageObservabilityPipelinesResponse getUsageObservabilityPipelines(OffsetDateTime startHr) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesAsync(OffsetDateTime startHr)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)@Deprecated public UsageObservabilityPipelinesResponse getUsageObservabilityPipelines(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call@Deprecated public CompletableFuture<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.@Deprecated public ApiResponse<UsageObservabilityPipelinesResponse> getUsageObservabilityPipelinesWithHttpInfo(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters) throws ApiException
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden - User is not authorized | - |
| 429 | Too many requests | - |
@Deprecated public CompletableFuture<ApiResponse<UsageObservabilityPipelinesResponse>> getUsageObservabilityPipelinesWithHttpInfoAsync(OffsetDateTime startHr, UsageMeteringApi.GetUsageObservabilityPipelinesOptionalParameters parameters)
startHr - Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh]
for usage beginning at this hour. (required)parameters - Optional parameters for the request.public UsageSummaryAvailableFieldsResponse getUsageSummaryAvailableFields() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<UsageSummaryAvailableFieldsResponse> getUsageSummaryAvailableFieldsAsync()
public ApiResponse<UsageSummaryAvailableFieldsResponse> getUsageSummaryAvailableFieldsWithHttpInfo() throws ApiException
GET /api/v1/usage/summary at each of its three
response levels. Each list contains every key the data endpoint emits—both typed fields
declared in the OpenAPI spec and untyped keys exposed through additionalProperties
(the latter used for billing dimensions and usage types added after the v1 schema freeze).
This endpoint is only accessible for parent-level organizations.
Go example:
```go fields, _, err := api.GetUsageSummaryAvailableFields(ctx) attr := fields.Data.GetAttributes()
// resp is the *UsageSummaryResponse returned by api.GetUsageSummary(ctx, ...) // Layer 1: UsageSummaryResponse for , key := range attr.GetResponseFields() { if val, ok := resp.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 2: UsageSummaryDate (per month) for , date := range resp.GetUsage() { for , key := range attr.GetDateFields() { if val, ok := date.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } // Layer 3: UsageSummaryDateOrg (per org per month) for , org := range date.GetOrgs() { for _, key := range attr.GetDateOrgFields() { if val, ok := org.AdditionalProperties[key]; ok { fmt.Println(key, val.(json.Number)) } } } } ```
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK. | - |
| 403 | Forbidden - User is not authorized. | - |
| 429 | Too many requests. | - |
public CompletableFuture<ApiResponse<UsageSummaryAvailableFieldsResponse>> getUsageSummaryAvailableFieldsWithHttpInfoAsync()
public UsageQuotasListResponse listQuotas(String quotaNamespace) throws ApiException
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)ApiException - if fails to make API callpublic CompletableFuture<UsageQuotasListResponse> listQuotasAsync(String quotaNamespace)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)public UsageQuotasListResponse listQuotas(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) throws ApiException
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<UsageQuotasListResponse> listQuotasAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)parameters - Optional parameters for the request.public PaginationIterable<UsageQuotaResponseData> listQuotasWithPagination(String quotaNamespace)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)public PaginationIterable<UsageQuotaResponseData> listQuotasWithPagination(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)public ApiResponse<UsageQuotasListResponse> listQuotasWithHttpInfo(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters) throws ApiException
user_access_manage, billing_edit, and org_management
permissions.quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<UsageQuotasListResponse>> listQuotasWithHttpInfoAsync(String quotaNamespace, UsageMeteringApi.ListQuotasOptionalParameters parameters)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)parameters - Optional parameters for the request.public UsageQuotaResponse updateQuota(String quotaNamespace, String id, UsageQuotaUpdateRequest body) throws ApiException
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)body - The usage quota fields to update. Omitting an attribute leaves its current value
unchanged. (required)ApiException - if fails to make API callpublic CompletableFuture<UsageQuotaResponse> updateQuotaAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)body - The usage quota fields to update. Omitting an attribute leaves its current value
unchanged. (required)public ApiResponse<UsageQuotaResponse> updateQuotaWithHttpInfo(String quotaNamespace, String id, UsageQuotaUpdateRequest body) throws ApiException
user_access_manage,
billing_edit, and org_management permissions.quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)body - The usage quota fields to update. Omitting an attribute leaves its current value
unchanged. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request. Returned if the request is malformed, or if the `id` in the request body does not match the `id` in the request path. | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<UsageQuotaResponse>> updateQuotaWithHttpInfoAsync(String quotaNamespace, String id, UsageQuotaUpdateRequest body)
quotaNamespace - The product-specific namespace whose usage quotas are being managed.
(required)id - The opaque quota identifier returned by a previous list or create request. Clients
must pass this value verbatim. (required)body - The usage quota fields to update. Omitting an attribute leaves its current value
unchanged. (required)Copyright © 2026. All rights reserved.