Execute Direct Query API

Execute Direct Query API

이 기능은 실험적 기능이라 프로덕션 환경에서는 사용을 권장하지 않아요. 기능 진행 상황에 대한 업데이트나 피드백이 있으면 OpenSearch 포럼에서 토론에 참여해 주세요.

데이터 소스의 네이티브 질의 언어를 사용해 외부 데이터 소스에 대해 질의를 실행해요.

이 API를 사용하기 전에 먼저 데이터 소스를 구성해야 해요. 데이터 소스 구성 방법은 Data sources 문서를 참고하세요.

출처: 문서

본문

엔드포인트 (Endpoint)

POST /_plugins/_directquery/_query/{dataSource}

경로 파라미터 (Path parameters)

다음 표는 사용 가능한 경로 파라미터를 나열해요.

요청 본문 필드 (Request body fields)

다음 표는 사용 가능한 요청 본문 필드를 나열해요.

Prometheus 옵션

다음 옵션은 Prometheus 데이터 소스에 특화되어 있으며 options 객체에 제공해야 해요.

예시 요청: Instant 질의

다음 요청은 Prometheus 데이터 소스에 대해 instant PromQL 질의를 실행해요.

POST /_plugins/_directquery/_query/my_prometheus
{
  "query": "up",
  "language": "PROMQL",
  "options": {
    "queryType": "instant"
  }
}

예시 요청: Range 질의

다음 요청은 시간 경과에 따른 CPU 사용량을 가져오는 range 질의를 실행해요.

POST /_plugins/_directquery/_query/my_prometheus
{
  "query": "rate(node_cpu_seconds_total{mode=\"user\"}[5m])",
  "language": "PROMQL",
  "options": {
    "queryType": "range",
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T01:00:00Z",
    "step": "60s"
  }
}

예시 응답

{
  "queryId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "sessionId": "session-uuid-here",
  "results": {
    "status": "success",
    "data": {
      "resultType": "vector",
      "result": [
        {
          "metric": {
            "__name__": "up",
            "instance": "localhost:9090",
            "job": "prometheus"
          },
          "value": [1704067200, "1"]
        }
      ]
    }
  }
}

응답 본문 필드 (Response body fields)

다음 표는 모든 응답 본문 필드를 나열해요.

더 알아보기 (Learn more)

• Read Resources API
• Write Resources API
• 데이터 소스 API (Data source APIs)