내보내기¶
POST /api/v1/log_index_cfg/export
개요¶
로그 인덱스 목록 필터 조건에 따라 로그 인덱스 템플릿을 내보냅니다.
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| search | string | 인덱스 이름으로 검색 빈 문자열 허용: True |
|
| isBindCustomStore | boolean | 사용자 정의 스토리지 바인딩 여부. 내보내기 시 내부 인덱스만 지원하며, true를 전달하면 결과가 비어 있습니다. |
|
| isDirectIndex | boolean | 네이티브 직접 쓰기 인덱스 여부 |
|
| queryType | commaArray | 스토리지 쿼리 유형 |
매개변수 추가 설명¶
이 인터페이스는 로그 인덱스 템플릿을 단독으로 내보내는 데 사용되며, 워크스페이스 리소스 내보내기 작업이 필요하지 않습니다.
요청 설명
- 내보내기 매개변수는 로그 인덱스 목록 인터페이스와 동일하지만, 페이지네이션 및 워크스페이스 간 관련 매개변수는 지원하지 않습니다.
- 현재 지원되는 필터 매개변수는
search,queryType,isDirectIndex,isBindCustomStore입니다. - 현재 워크스페이스의 내부 로그 인덱스만 내보냅니다.
default인덱스와 외부 인덱스는 내보내지지 않습니다.- 반환 결과는 JSON 목록으로,
/log_index_cfg/import의 입력 템플릿으로 직접 사용할 수 있습니다.
내보내기 필드
| 필드 | 유형 | 설명 |
|---|---|---|
| name | string | 인덱스 이름 |
| desc | string | 인덱스 설명 |
| directIndex | boolean | 네이티브 직접 쓰기 인덱스 여부 |
| isFullLineIndex | int | 전체 행 인덱스 여부. 0은 message 필드 인덱스 유지, 1은 전체 행 인덱스를 의미합니다. 로그 스토리지가 scopedb인 워크스페이스만 1로 설정할 수 있습니다. |
| conditions | string | 인덱스 매칭 조건 |
| duration | string | 스토리지 기간 |
| storagePolicy | json | 장기 스토리지 정책 |
| extend | json | 확장 구성 |
| setting | json | 스토리지 설정 |
| fields | array | 필드 매핑 구성 |
| is_disable | boolean | 비활성화 여부 |
요청 예시¶
curl 'https://openapi.guance.com/api/v1/log_index_cfg/export?search=app-log&isDirectIndex=false' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
{
"code": 200,
"content": [
{
"name": "app-log",
"desc": "애플리케이션 로그 인덱스",
"directIndex": false,
"isFullLineIndex": 0,
"conditions": "",
"duration": "7d",
"storagePolicy": {},
"extend": {},
"setting": {},
"fields": [
{
"field": "service",
"originalField": "service"
}
],
"is_disable": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}