로그 스키마 정보 가져오기¶
GET /api/v1/metric_info/log/schema
개요¶
로그 인덱스에서 당일 발견된 필드 이름과 데이터 유형을 가져옵니다.
호출 전 및 사용 단계¶
조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당 빈 배열입니다. 먼저 로그 인덱스 목록에서 인덱스 이름을 확인한 후 본 API를 호출합니다. 값을 필터링해야 하는 경우 반환된 필드 이름을 로그 Tag 값 가져오기로 전달합니다.
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 식별자, 인증에 사용 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 API 권한을 가진 Key를 생성하거나 가져옵니다. |
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| index | string | 조회할 로그 인덱스입니다. 생략하거나 공백으로 전달하면 default를 사용합니다. null 허용: True 예: default가져오기 또는 입력 방법: 로그 인덱스 목록 가져오기 응답의 content.data[].name에서 선택합니다. |
매개변수 추가 설명¶
GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 읽습니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/log/schema" \
--data-urlencode "index=default"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.index | string | 실제 조회한 로그 인덱스입니다. |
| content.fields | array<object> |
결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다. |
| content.fields[].name | string | 필드 이름이며 이후 조회에 사용할 수 있습니다. |
| content.fields[].value_type | string | 데이터 소스가 반환한 필드 값 유형이며 빈 문자열일 수 있습니다. |
| content.fields[].type | string | 필드 분류로, 항상 text입니다. |
| content.fields[].description | string | 필드 설명이며 현재 빈 문자열입니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. 응답에 이 공통 필드가 존재할 수 있으며, 자세한 내용은 공통 응답 구조를 참조하십시오. |
{"code": 200, "content": {"index": "default", "fields": [{"name": "service", "value_type": "string", "type": "text", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 매개변수를 전달한 경우 | 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 명시됩니다. | 매개변수 표에 나열된 매개변수만 사용합니다. |
| 403 | ft.ForbiddenQuery | 현재 자격 증명에 요청 대상 데이터를 조회할 권한이 없는 경우 | 조회 권한이 부족합니다. | API Key의 조회 권한과 대상 데이터의 권한 부여 범위를 확인합니다. |
| 503 | ft.QueryServiceUnavailable | 의존하는 조회 서비스를 일시적으로 사용할 수 없는 경우 | 조회 서비스를 일시적으로 사용할 수 없으며 잠시 후 다시 시도합니다. | content.retryable을 확인하고 일시적 오류인 경우 지연 후 재시도합니다. |