인덱스 키 필드 조회¶
GET /api/v1/workspace/index_key_field/get
개요¶
로그 인덱스의 키 필드 표시 설정을 읽으며, 기본 인덱스와 클론 인덱스를 포함합니다.
호출 전 및 사용 단계¶
워크스페이스는 API Key로 결정되며, 로그 인덱스/탐색기 관리 권한이 있는 Key를 사용합니다. 키 필드 설정은 로그 표시와 선택적 가속을 제어하며, 실제 로그 필드 이름, 기존 로그 값 또는 단위 설명을 수정하지 않습니다. 인덱스 UUID와 인덱스 이름은 혼용할 수 없습니다.
content.cfgList를 읽은 후 cfg_uuid를 키 필드 수정 요청의 uuid에 채우고, name을 필드 가속 요청의 index에 채웁니다. 외부 바인딩 스토리지 인덱스는 이 목록에 포함되지 않습니다. 기본 인덱스는 영구 설정이 아직 없더라도 default 및 빈 필드를 반환하며, 이번 GET에서 새 설정이 저장되었음을 의미하지 않습니다. 기존 기본 설정 레이아웃은 호환되어 읽힙니다. 이 API는 전역 syncKeywordSpeed 스위치를 반환하지 않으며 가속 작업 완료 진행률도 조회하지 않습니다. 변경이 필요한 경우 워크스페이스 관리자가 전역 동기화 정책을 결정해야 합니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/workspace/index_key_field/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.cfgList | array<object> | 기본 인덱스가 첫 번째 항목이며, 그 뒤에 현재 워크스페이스에서 삭제되지 않았고 외부 바인딩이 아닌 인덱스가 오며, 클론 인덱스를 포함합니다. 페이지네이션은 없습니다. |
| content.cfgList[*].cfg_uuid | string | 기본 항목은 default로 고정되며, 그 외는 인덱스 설정 UUID입니다. 수정 시 cfgList[*].uuid에 매핑되므로 필드 이름이 다르다는 점에 유의합니다. |
| content.cfgList[*].name | string | 로그 인덱스 이름으로, 필드 가속 요청의 index에 사용합니다. |
| content.cfgList[*].extendFields | array<object> 또는 기존 JSON 값 | 현재 키 필드 배열이며 기본값은 []입니다. 기존 값은 완전히 정규화되지 않았을 수 있으므로 실제 구조에 따라 판단하고, 비정상 값은 먼저 확인한 후 수정합니다. |
| content.cfgList[*].extendFields[*].tag | string | 실제 필드 이름이며 표시 별칭이 아닙니다. |
| content.cfgList[*].extendFields[*].alias | string | 선택적 표시 별칭이며 생략하거나 비워 둘 수 있습니다. |
| content.declaration | object | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"cfgList": [
{
"cfg_uuid": "default",
"name": "default",
"extendFields": [
{
"tag": "host",
"alias": "호스트"
},
{
"tag": "service",
"alias": "서비스"
}
]
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 설정 읽기 또는 기존 설정 데이터 처리 실패 | 내부 오류 | traceId를 보관한 뒤 관리자에게 연락하여 설정을 확인하고, 수정 후 다시 읽습니다. |