메트릭 및 태그 정보 조회¶
GET /api/v1/metric_info/get
개요¶
지정한 메저먼트의 메타데이터와 조회된 태그 설명을 읽습니다.
호출 전 및 사용 단계¶
먼저 메저먼트 이름을 가져온 다음 필드 설명, 측정 단위 및 기존 태그 설명을 읽을 수 있습니다. 일치하는 필드 메타데이터 또는 태그가 없으면 해당 배열은 비어 있습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| Accept-Language | string | 필드 및 태그의 지역화 가능한 설명 언어를 결정합니다. 예: zh조회 또는 입력 방법: 필요에 따라 설명을 반환할 언어를 입력합니다(예: zh). |
|
| DF-API-KEY | string | Y | AK 식별자, AK uuid 예: <DF-API-KEY>조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 API 권한을 가진 Key를 생성하거나 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| metric | string | Y | 메저먼트의 정확한 이름입니다(예: cpu). null 허용: False 빈 문자열 허용: False 예: cpu조회 또는 입력 방법: 메저먼트 목록 조회 응답의 content.data[].name에서 값을 가져옵니다. |
파라미터 추가 설명¶
GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 읽습니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/get" \
--data-urlencode "metric=cpu"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.metric_fields_info | array<object> |
결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다. |
| content.metric_fields_info[].field | string | 메트릭 필드 이름입니다. |
| content.metric_fields_info[].type | string | 필드 메타데이터 소스이며, inner는 내장, custom은 사용자 정의입니다. |
| content.metric_fields_info[].data_type | string 또는 null | 필드의 데이터 유형입니다. |
| content.metric_fields_info[].unit | string | 메트릭 단위이며 비어 있을 수 있습니다. |
| content.metric_fields_info[].desc | string | 메트릭 필드 설명입니다. |
| content.metric_fields_info[].tags | array<string> |
해당 필드에 대응하는 태그 이름입니다. |
| content.metric_fields_info[].origin_field | string | 원본 필드 이름이며 일부 구성에서 반환됩니다. |
| content.tags_info | array<object> |
결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다. |
| content.tags_info[].tag_key | string | 태그 이름입니다. |
| content.tags_info[].tag_desc | string | 태그 설명이며 비어 있을 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. 이 공통 필드는 응답에 포함될 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요. |
{"code": 200, "content": {"metric_fields_info": [{"field": "usage_idle", "type": "inner", "data_type": "float", "unit": "percent", "desc": "空闲百分比", "tags": ["host"]}], "tags_info": [{"tag_key": "host", "tag_desc": "主机名"}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필수 Query 파라미터가 누락되었거나 선언되지 않은 Query 파라미터가 전달됨 | 요청 필드 검증에 실패했으며 메시지에 필드 또는 규칙이 표시됩니다. | 파라미터 표와 예시를 확인하세요. |
| 403 | ft.ForbiddenQuery | 현재 자격 증명으로 요청에 대응하는 데이터를 조회할 권한이 없음 | 조회 권한이 부족합니다. | API Key 조회 권한과 대상 데이터의 권한 범위를 확인하세요. |
| 503 | ft.QueryServiceUnavailable | 의존하는 조회 서비스를 일시적으로 사용할 수 없음 | 조회 서비스를 일시적으로 사용할 수 없으므로 잠시 후 다시 시도하세요. | content.retryable을 확인하고 일시적 오류는 지연 후 재시도할 수 있습니다. |