콘텐츠로 이동

로그 인덱스 목록 조회



GET /api/v1/metric_info/log/indexes

개요

현재 워크스페이스에서 조회 가능하며 사용자 정의 스토리지에 바인딩되지 않은 logging 및 standard 로그 인덱스를 나열합니다.

호출 전 및 사용 단계

반환된 인덱스 이름으로 로그 필드 또는 Tag 값 인터페이스를 호출합니다. 목록에는 전체 건수가 없으므로, 이번 limit보다 적은 레코드를 받으면 페이지네이션을 종료할 수 있습니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
limit integer 기본값 100. 양의 정수를 전달하세요.
null 허용: True
기본값: 100
예: 100
획득 또는 입력 방법: 클라이언트가 매번 읽고자 하는 건수를 입력합니다.
offset integer 몇 번째부터 읽을지 지정하며 0부터 계산하고 기본값은 0입니다.
null 허용: True
기본값: 0
예: 0
획득 또는 입력 방법: 첫 페이지는 0을 전달합니다. 이후 페이지는 이전 offset에 limit을 더합니다.

파라미터 추가 설명

GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 읽습니다.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/metric_info/log/indexes" \
  --data-urlencode "limit=100" \
  --data-urlencode "offset=0"

응답

HTTP 200, application/json.

필드 유형 설명
content.data array<object> 결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다.
content.data[].name string 로그 인덱스 이름이며, 예: default.
content.declaration object 또는 null 워크스페이스 선언입니다. 응답에 이 공통 필드가 존재할 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요.
{"code": 200, "content": {"data": [{"name": "default"}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 전달한 경우 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. 파라미터 표에 나열된 파라미터만 사용합니다.
500 ft.InternalServerError limit 또는 offset에 정수로 변환할 수 없는 문자열을 전달한 경우 내부 오류입니다. 파라미터 표를 통해 사용한 페이지네이션 필드를 확인하고, 십진 정수 문자열을 전달한 후 다시 시도합니다.

문서 평가

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