インポート¶
POST /api/v1/log_index_cfg/import
概要¶
ログインデックステンプレートを一括インポートします。名前の重複チェック、スキップ、上書きに対応しています。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| logIndexes | array | Y | ログインデックステンプレートのリスト 空を許可: False |
| logIndexes[*] | None | ||
| logIndexes[*].name | string | Y | インデックス名 空を許可: False |
| logIndexes[*].desc | string | インデックスの説明 空を許可: False |
|
| logIndexes[*].directIndex | boolean | ネイティブダイレクトインデックスかどうか 空を許可: False |
|
| logIndexes[*].isFullLineIndex | int | 全文行インデックスかどうか。0/false は message フィールドのインデックスを保持、1/true は全文行インデックス、デフォルトは 0。ログストレージが scopedb のワークスペースのみ 1 に設定可能 空を許可: False |
|
| logIndexes[*].conditions | string | マッチ条件 空を許可: False |
|
| logIndexes[*].duration | string | 保持期間 空を許可: False |
|
| logIndexes[*].storagePolicy | json | 長期保持ポリシー 空を許可: False |
|
| logIndexes[*].extend | json | 拡張設定 空を許可: False |
|
| logIndexes[*].setting | json | ストレージ設定 空を許可: False |
|
| logIndexes[*].fields | array | フィールドマッピング設定 空を許可: False |
|
| logIndexes[*].is_disable | boolean | 無効化するかどうか 空を許可: False |
|
| repeatLogIndexNameOp | string | ログインデックス名の重複処理ポリシー 空を許可: False 選択可能な値: ['check', 'skip', 'recover'] |
パラメータ補足説明¶
このインターフェースは、ログインデックステンプレートを個別にインポートするために使用します。
呼び出しフロー
logIndexes配列を準備します。各要素は 1 つのログインデックステンプレートを表します。repeatLogIndexNameOpで、同名のインデックスが存在する場合の処理ポリシーを指定します。- ポリシーが
checkで同名のインデックスが存在する場合、インターフェースはrepeat_nameを返し、保存は実行されません。
repeatLogIndexNameOp の説明
| 値 | 説明 |
|---|---|
| check | 重複のチェックのみを行います。同名のインデックスが存在する場合、repeat_name を返します。 |
| skip | 既に存在する同名のインデックスをスキップし、存在しないインデックスのみをインポートします。 |
| recover | 対象のワークスペースに同名のインデックスが存在する場合、インポートテンプレートでそのインデックスの設定を上書きします。 |
特殊ルール
name=defaultのテンプレートは無視され、インポートは実行されません。- 外部インデックステンプレートは無視され、インポートは実行されません。
recoverは同名の内部インデックスのみを上書きし、defaultには影響しません。
テンプレートフィールド
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | はい | インデックス名 |
| desc | string | いいえ | インデックスの説明 |
| directIndex | boolean | いいえ | ネイティブダイレクトインデックスかどうか |
| isFullLineIndex | int | いいえ | 全文行インデックスかどうか。0 は message フィールドのインデックスを保持、1 は全文行インデックス、デフォルトは 0。ログストレージが scopedb のワークスペースのみ 1 に設定可能 |
| conditions | string | いいえ | マッチ条件 |
| duration | string | いいえ | 保持期間 |
| storagePolicy | json | いいえ | 長期保持ポリシー |
| extend | json | いいえ | 拡張設定 |
| setting | json | いいえ | ストレージ設定 |
| fields | array | いいえ | フィールドマッピング |
| is_disable | boolean | いいえ | 無効化するかどうか |
戻り値の説明
- インポートが成功した場合、
successCount、failCountを返します。 - 一部のオブジェクトが失敗した場合、戻り値に追加で
failedNamesが含まれます。 checkモードで重複が検出された場合、repeat_nameを返します。
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/log_index_cfg/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"repeatLogIndexNameOp":"recover","logIndexes":[{"name":"app-log","desc":"アプリケーションログインデックス","directIndex":false,"isFullLineIndex":0,"conditions":"","duration":"7d","storagePolicy":{},"extend":{},"setting":{},"fields":[],"is_disable":false}]}'