コンテンツにスキップ

エクスポート¶

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 の入力テンプレートとして使用できます。

エクスポートフィールド

フィールド	type	説明
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"
}