For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ja/api/latest/cloud-cost-management/get-commitments-list.md. A documentation index is available at /llms.txt.
homeホームdocsドキュメントapiAPI
Language
Datadog site

Get commitments list

警告Note: 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/commitment-listhttps://api.us3.datadoghq.com/api/v2/cost/commitments/commitment-listhttps://api.us5.datadoghq.com/api/v2/cost/commitments/commitment-listhttps://api.datadoghq.eu/api/v2/cost/commitments/commitment-listhttps://api.ap1.datadoghq.com/api/v2/cost/commitments/commitment-listhttps://api.ap2.datadoghq.com/api/v2/cost/commitments/commitment-listhttps://api.uk1.datadoghq.com/api/v2/cost/commitments/commitment-listhttps://api.ddog-gov.com/api/v2/cost/commitments/commitment-listhttps://api.us2.ddog-gov.com/api/v2/cost/commitments/commitment-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.

This endpoint requires the cloud_cost_management_read permission.

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

引数

クエリ文字列

名前
タイプ
説明
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

応答

OK

Response containing a list of cloud commitment details.

フィールド
タイプ
説明
commitments [required]
[<oneOf>]

Array of commitment items.

meta
object

Metadata for a commitments list response.

コード例

Get commitments list
# 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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?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/commitment-list?provider=${provider}&product=${product}&start=${start}&end=${end}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"