메저먼트 스키마 정보 가져오기¶
GET /api/v1/metric_info/measurement/schema
개요¶
지정된 메저먼트에서 당일 발견된 필드, 필드 유형 및 Tag 정보를 가져옵니다.
호출 전 및 사용 단계¶
조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당 빈 배열입니다. 자동 발견과 사용자 정의 메타데이터가 모두 존재하는 필드에는 사용자 정의 구성을 사용합니다. 먼저 메저먼트를 가져온 다음, 반환된 필드 및 Tag 이름을 사용하여 쿼리를 구성할 수 있습니다. 메저먼트 이름을 비워 두면 성공을 반환하고 content는 {}입니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| Accept-Language | string | 필드 및 Tag의 현지화 가능한 설명 언어를 결정합니다. 예: zh가져오기 또는 입력 방법: 반환할 설명 언어를 필요에 따라 입력합니다. 예: zh. |
|
| DF-API-KEY | string | Y | AK 식별자로, 인증에 사용됩니다 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 인터페이스 권한이 있는 Key를 생성하거나 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| measurement | string | Y | 메저먼트의 정확한 이름입니다. 예: cpu. null 허용: 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/measurement/schema" \
--data-urlencode "measurement=cpu"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.measurement | string | 요청의 메저먼트 이름입니다. |
| content.fields | array<object> |
결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다. |
| content.fields[].name | string | 메트릭 필드 이름입니다. |
| content.fields[].value_type | string | 메트릭 필드의 값 유형입니다. |
| content.fields[].type | string | 필드 값 유형이 비어 있지 않으면 gauge이고, 그렇지 않으면 빈 문자열입니다. |
| content.fields[].unit | string | 구성된 단위이며 빈 문자열일 수 있습니다. |
| content.fields[].description | string | 구성된 설명이며 빈 문자열일 수 있습니다. |
| content.fields[].tags | array<object> |
해당 필드의 Tag 카탈로그입니다. |
| content.fields[].tags[].name | string | Tag의 정확한 이름입니다. |
| content.fields[].tags[].description | string | Tag 설명이며 빈 문자열일 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. 응답에 이 공통 필드가 포함될 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요. |
{"code": 200, "content": {"measurement": "cpu", "fields": [{"name": "usage_idle", "value_type": "float", "type": "gauge", "unit": "percent", "description": "", "tags": [{"name": "host", "description": ""}]}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필수 Query 파라미터가 누락되었거나 선언되지 않은 Query 파라미터가 전달되었습니다 | 요청 필드 유효성 검사에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. | 파라미터 표와 예시를 확인하세요. |
| 403 | ft.ForbiddenQuery | 현재 자격 증명에 요청에 해당하는 데이터를 조회할 권한이 없습니다 | 조회 권한이 부족합니다. | API Key 조회 권한과 대상 데이터의 권한 부여 범위를 확인하세요. |
| 503 | ft.QueryServiceUnavailable | 의존하는 조회 서비스를 일시적으로 사용할 수 없습니다 | 조회 서비스를 일시적으로 사용할 수 없습니다. 나중에 다시 시도하세요. | content.retryable을 확인하고, 일시적 오류인 경우 지연 후 다시 시도할 수 있습니다. |