콘텐츠로 이동

로그 인덱스 Tags 정보 조회



GET /api/v1/metric_info/log/tags

개요

특정 로그 인덱스 내 지정 필드의 값을 샘플링하여 조회합니다.

호출 전 및 사용 단계

조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당 빈 배열입니다. 일부 비어 있지 않은 값만 반환되므로 과거의 모든 값을 열거하는 데 사용할 수 없습니다. 업스트림 조회 결과의 null, 빈 문자열, 0, false는 샘플 목록에 포함되지 않습니다. 인덱스 이름이나 필드 이름을 비워 두면 성공을 반환하며 content는 {}입니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y AK 식별자로, 인증에 사용합니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 인터페이스 권한을 가진 Key를 생성하거나 획득합니다.

Query 요청 파라미터

파라미터명 유형 필수 설명
index string Y 로그 인덱스 이름이며, 응답의 원래 값을 사용합니다.
null 허용: False
예: default
획득 또는 입력 방법: 로그 인덱스 목록 조회 응답의 content.data[].name에서 값을 가져옵니다.
tag string Y 로그 인덱스 내 필드 이름입니다. 예: service.
null 허용: False
예: service
획득 또는 입력 방법: 로그 Schema 조회 응답의 content.fields[].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/log/tags" \
  --data-urlencode "index=default" \
  --data-urlencode "tag=service" \
  --data-urlencode "limit=10"

응답

HTTP 200, application/json.

필드 유형 설명
content.index string 요청의 로그 인덱스입니다.
content.tag string 요청의 필드 또는 Tag 이름입니다.
content.values array 샘플링된 값입니다. 요소의 유형은 데이터 소스 필드에 따라 다르며, 일치하는 값이 없으면 빈 배열입니다.
content.declaration object 또는 null 워크스페이스 선언입니다. 응답에 이 공통 필드가 존재할 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요.
{"code": 200, "content": {"index": "default", "tag": "service", "values": ["api", "worker"]}, "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에 정수로 변환할 수 없는 문자열이 전달된 경우 내부 오류입니다. 파라미터 표를 통해 사용한 페이징 필드를 확인하고, 10진수 정수 문자열을 전달한 후 다시 시도합니다.

문서 평가

이 페이지가 도움이 되었나요?