コンテンツにスキップ

エクスポート¶

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"
}