데이터 관측 가능성 모니터 실행 상태 가져오기 - Data Observability

경고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/data-observability/monitors/runs/{run_id}/statushttps://api.us3.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.us5.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.datadoghq.eu/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ap1.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ap2.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.uk1.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ddog-gov.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.us2.ddog-gov.com/api/v2/data-observability/monitors/runs/{run_id}/status

개요

데이터 관측 가능성 모니터 실행의 현재 상태를 검색합니다. 실행을 트리거한 후 이 엔드포인트를 폴링하여 평가가 완료되는 시점을 확인합니다.

OAuth apps require the data_observability_monitors_write, monitors_write authorization scope to access this endpoint.

인수

경로 파라미터

이름

유형

설명

run_id [required]

string

The ID of the monitor run to retrieve status for.

응답

The response for getting the status of a data observability monitor run.

항목

유형

설명

data [required]

object

The data object for a data observability monitor run status response.

{
  "data": {
    "attributes": {
      "error_message": "run completed but produced no metric data",
      "status": "pending"
    },
    "id": "abc123def456",
    "type": "monitor_run"
  }
}

Not Found

API error response.

항목

유형

설명

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 예시

데이터 관측 가능성 모니터 실행 상태 가져오기

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export run_id="abc123def456"

# 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/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"