For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/es/api/latest/cloud-cost-management/get-commitments-utilization-scalar.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get commitments utilization (scalar)

ADVERTENCIANote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.us3.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.us5.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.datadoghq.eu/api/v2/cost/commitments/utilization/scalarhttps://api.ap1.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.ap2.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.uk1.datadoghq.com/api/v2/cost/commitments/utilization/scalarhttps://api.ddog-gov.com/api/v2/cost/commitments/utilization/scalarhttps://api.us2.ddog-gov.com/api/v2/cost/commitments/utilization/scalar

Descripción general

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

This endpoint requires the cloud_cost_management_read permission.

OAuth apps require the cloud_cost_management_read authorization scope to access this endpoint.

Argumentos

Cadenas de consulta

Nombre
Type
Descripción
provider [required]
enum

Cloud provider for commitment programs (aws or azure).

Allowed enum values: aws, azure
product [required]
string

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

start [required]
integer

Start of the query time range in Unix milliseconds.

end [required]
integer

End of the query time range in Unix milliseconds.

filterBy
string

Optional filter expression to narrow down results.

commitmentType
enum

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

Allowed enum values: ri, sp

Respuesta

OK

Response containing scalar utilization metrics for cloud commitment programs.

Campo
Type
Descripción
columns [required]
[object]

Array of scalar columns in the response.

product_breakdown
[object]

Array of per-product utilization breakdown entries.

Ejemplo de código

Get commitments utilization (scalar)
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Required query arguments
export provider="aws"
export product="ec2"
export start="1693526400000"
export end="1696118400000"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/utilization/scalar?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"