Update a derived metric
PUT
https://api.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.us3.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.us5.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.datadoghq.eu/api/v2/metrics/derived-metrics/{metric_name}https://api.ap1.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.ap2.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.uk1.datadoghq.com/api/v2/metrics/derived-metrics/{metric_name}https://api.ddog-gov.com/api/v2/metrics/derived-metrics/{metric_name}https://api.us2.ddog-gov.com/api/v2/metrics/derived-metrics/{metric_name}概要
Update the definition of an existing derived metric. The id in the request body
must match the metric_name path parameter. Requires the Manage Tags for Metrics permission.
OAuth apps require the metric_tags_write authorization scope to access this endpoint.
引数
パスパラメーター
名前
タイプ
説明
metric_name [required]string
The name of the metric.
リクエスト
Body Data (required)
フィールド
タイプ
説明
data [required]object
Data object for creating or updating a derived metric.
attributes [required]object
Attributes of a derived metric.
definition [required]object
The definition of a derived metric as a formula over one or more queries.
formula [required]string
The formula that combines the queries into the value of the derived metric.
queries [required][object]
The list of queries referenced by the formula.
data_source [required]string
The data source that the query is run against.
name [required]string
The name used to reference this query from the formula.
query [required]string
The query string executed against the data source.
id [required]string
The derived metric name used as the resource ID.
type [required]enum
The derived metric resource type.
derived_metricsAllowed enum values:
derived_metrics{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}応答
OK
Response containing a single derived metric.
フィールド
タイプ
説明
data [required]object
A derived metric resource object.
attributes [required]object
Attributes of a derived metric.
definition [required]object
The definition of a derived metric as a formula over one or more queries.
formula [required]string
The formula that combines the queries into the value of the derived metric.
queries [required][object]
The list of queries referenced by the formula.
data_source [required]string
The data source that the query is run against.
name [required]string
The name used to reference this query from the formula.
query [required]string
The query string executed against the data source.
id [required]string
The derived metric name used as the resource ID.
type [required]enum
The derived metric resource type.
derived_metricsAllowed enum values:
derived_metrics{
"data": {
"attributes": {
"definition": {
"formula": "a",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}Bad Request
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
Update a derived metric returns "OK" response
# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF# Path parameters
export metric_name="dist.http.endpoint.request"
# 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 PUT "https://api.${DD_SITE}/api/v2/metrics/derived-metrics/${metric_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"definition": {
"formula": "a * 2",
"queries": [
{
"data_source": "metrics",
"name": "a",
"query": "avg:system.cpu.user{*}"
}
]
}
},
"id": "my.derived.metric",
"type": "derived_metrics"
}
}
EOF