메트릭 Tags 정보 조회¶
GET /api/v1/metric_info/measurement/tags
개요¶
지정한 메저먼트의 특정 Tag 값을 샘플링하여 조회합니다.
호출 전 및 사용 단계¶
조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당하는 빈 배열입니다. 일부 비어 있지 않은 값을 반환하며, 과거의 모든 값을 열거하는 데 사용할 수 없습니다. 업스트림 조회 결과의 null, 빈 문자열, 0 및 false는 샘플 목록에 포함되지 않습니다. 메저먼트 이름 또는 Tag 이름이 비어 있으면 성공을 반환하고 content는 {}입니다.
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 식별자이며 인증에 사용됩니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 인터페이스 권한이 있는 Key를 생성하거나 가져옵니다. |
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| measurement | string | Y | 메저먼트의 정확한 이름입니다(예: cpu). null 허용: False 예시: cpu가져오기 또는 입력 방법: 메저먼트 목록 조회 응답의 content.data[].name에서 값을 가져옵니다. |
| tag | string | Y | Tag 이름을 하나 지정합니다(예: host). null 허용: False 예시: host가져오기 또는 입력 방법: 메저먼트 스키마 조회 응답의 content.fields[].tags[].name에서 값을 가져옵니다. |
| limit | integer | 기본값은 10이며, 10보다 크면 10으로 처리합니다. 양의 정수를 전달하세요. null 허용: True 기본값: 10 예시: 10가져오기 또는 입력 방법: 호출 측에서 필요한 샘플 수에 따라 설정하며, 1에서 10을 권장합니다. |
매개변수 추가 설명¶
GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 읽습니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/measurement/tags" \
--data-urlencode "measurement=cpu" \
--data-urlencode "tag=host" \
--data-urlencode "limit=10"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.measurement | string | 요청에 포함된 메저먼트 이름입니다. |
| content.tag | string | 요청에 포함된 필드 또는 Tag 이름입니다. |
| content.values | array | 샘플링된 값입니다. 요소의 유형은 데이터 소스 필드에 따라 달라지며, 일치하는 값이 없으면 빈 배열입니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. 이 공통 필드는 응답에 존재할 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요. |
{"code": 200, "content": {"measurement": "cpu", "tag": "host", "values": ["web-01", "web-02"]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필수 Query 매개변수가 누락되었거나 선언되지 않은 Query 매개변수가 전달되었습니다. | 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. | 매개변수 표와 예시를 확인하세요. |
| 403 | ft.ForbiddenQuery | 현재 자격 증명에 요청에 해당하는 데이터를 조회할 권한이 없습니다. | 조회 권한이 부족합니다. | API Key 조회 권한과 대상 데이터의 권한 부여 범위를 확인하세요. |
| 503 | ft.QueryServiceUnavailable | 종속된 조회 서비스를 일시적으로 사용할 수 없습니다. | 조회 서비스를 일시적으로 사용할 수 없으므로 나중에 다시 시도하세요. | content.retryable을 확인하고, 일시적 오류는 지연 후 재시도할 수 있습니다. |
| 500 | ft.InternalServerError | limit에 정수로 변환할 수 없는 문자열이 전달되었습니다. | 내부 오류입니다. | 매개변수 표를 통해 사용한 페이지네이션 필드를 확인하고, 십진 정수 문자열을 전달한 후 다시 시도하세요. |