콘텐츠로 이동

내보내기¶

POST /api/v1/log_index_cfg/export

개요¶

로그 인덱스 목록 필터 조건에 따라 로그 인덱스 템플릿을 내보냅니다.

Query 요청 매개변수¶

매개변수 이름	유형	필수 여부	설명
search	string		인덱스 이름으로 검색 빈 문자열 허용: True
isBindCustomStore	boolean		사용자 정의 저장소 바인딩 여부. 내보내기 시 내부 인덱스만 지원하며 true를 전달하면 결과가 비어 있습니다.
isDirectIndex	boolean		네이티브 직접 쓰기 인덱스 여부
queryType	commaArray		저장소 쿼리 유형

매개변수 추가 설명¶

이 API는 로그 인덱스 템플릿을 단독으로 내보내는 데 사용되며 워크스페이스 리소스 내보내기 작업을 거칠 필요가 없습니다.

요청 설명

내보내기 매개변수는 로그 인덱스 목록 API와 동일하지만 페이징 및 워크스페이스 간 관련 매개변수는 지원하지 않습니다.
현재 지원되는 필터 매개변수는 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	필드 매핑 구성
cloneConfig	json/null	클론 인덱스 전체 구성. 클론 인덱스가 없으면 null입니다.
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"
                }
            ],
            "cloneConfig": {
                "name": "app-log-clone",
                "desc": "应用日志克隆索引",
                "isFullLineIndex": 0,
                "conditions": "service = 'api'",
                "duration": "3d",
                "storagePolicy": {},
                "extend": {
                    "matchMode": "basic",
                    "filters": [
                        {
                            "name": "service",
                            "condition": "and",
                            "operation": "=",
                            "value": [
                                "api"
                            ]
                        }
                    ]
                },
                "setting": {},
                "fields": [
                    {
                        "field": "host_alias",
                        "originalField": "host"
                    }
                ],
                "is_disable": false
            },
            "is_disable": false
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}