インポート¶
POST /api/v1/log_index_cfg/import
概要¶
内部ログインデックステンプレートを一括インポートし、名前ごとにチェック、スキップ、または上書きします。
呼び出し前の準備と使用手順¶
先に対象設定をエクスポートしてバックアップし、空でない logIndexes 配列を使用します。check はデフォルトで、同名インデックスがある場合に content.repeat_name を返して成功し、バッチ全体をインポートしません。skip は既存項目をスキップします。recover は同名のソース A を上書きします。入力内で同名のテンプレート(trim 後)は直ちにエラーになります。デフォルトの default テンプレートはスキップされます。内部の通常テンプレートまたは直書きテンプレートのみをサポートし、外部バインディングはインポートしません。
recover は既存の directIndex モードを変更しません。desc を省略するとクリア、extend を省略すると全体置換となります。duration/storagePolicy/isFullLineIndex/fields が未指定の場合は元の値を保持します。is_disable を省略すると false になり、既存の無効な A は有効化されます。cloneConfig を含む場合は関連 B を新規作成または更新します。既存の B は UUID/名前を保持し、編集可能な設定を上書きします。null/省略では B を削除しません。既に B として使われている名前を直接インポートすると失敗し、A と一緒にインポートする必要があります。直書き/バインディング/デフォルトはクローン元にできず、B の条件は空にできません。scopedb テンプレートの新規作成では全行が必要で、公開インポートでは内部移行の自動 0→1 変換は実行されません。
各項目は個別にコミットされ、一部が失敗しても成功済みの項目はロールバックされません。content.successCount/failCount はデータベースへのコミット数です。failedNames は失敗した名前のみを返し、項目ごとの理由は返しません。コミット後に下流のポリシー/フィールド同期で異常が発生しても、成功として計上される可能性があるため、実際のストレージを確認する必要があります。skip の数は現在の公開結果では個別に返されないため、総入力数から failCount を引いて成功数を推測しないでください。
フィールドマッピングに明示的な [] を指定するとクリアされ、省略とは異なります。extendFields の変更は対象フィールドのアクセラレーションスイッチに従って同期されます。保持を減らす、フィルターを変更する、全行にアップグレードする前に影響を確認し、失敗した項目は traceId とサービスログを組み合わせて特定し、バッチ全体の盲目的な再試行を避けてください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| logIndexes[*].storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合のデフォルトは false です。無効にすると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 例: false取得または入力方法: true で長期ストレージを有効化し、false で無効化します。JSON のブール値を明示することを推奨します。 |
|
| logIndexes[*].storagePolicy.longStorageDuration | string | 有効時は条件付きで必須です。値は d を含む文字列で、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 例: 180d取得または入力方法: pay ではデフォルトで 90d/120d/180d/360d を選択し、enterprise/unlimited ではデフォルトで 1d から 1800d までであり、duration より厳密に大きい必要があります。 |
|
| logIndexes[*].setting.hot_retention | integer | TLS では条件付きで必須です。デフォルト範囲は 1~1800 日で、24~43200 時間に相当し、24 の倍数である必要があります。コールドストレージを使用する場合、ホットストレージは最低 7 日、アーカイブを使用する場合は最低 30 日です。 例: 168取得または入力方法: 日数×24 で入力します。例: 7 日 = 168 時間。 |
|
| logIndexes[*].setting.cold_retention | integer | 任意です。デフォルトは 30~1800 日で、整数日の時間数です。0 で省略を表さないでください。合計は 1800 日を超えません。 例: 720取得または入力方法: 低頻度ストレージの日数×24 で入力します。例: 30 日 = 720 時間。このステージを有効化しない場合は省略します。 |
|
| logIndexes[*].setting.archive_retention | integer | 任意です。デフォルトは 60~1800 日で、整数日の時間数です。ホットストレージは最低 30 日で、合計は 1800 日を超えません。 例: 1440取得または入力方法: アーカイブ日数×24 で入力します。例: 60 日 = 1440 時間。このステージを有効化しない場合は省略します。 |
|
| logIndexes[*].extend.matchMode | string | 省略/空値は basic として扱います。advanced では advancedFilter を使用し、basic では filters を使用します。モードを切り替える場合は、対応する完全な条件も同時に指定してください。 例: basic取得または入力方法: 通常マッチは basic、高度なマッチは advanced。 |
|
| logIndexes[*].extend.filters | array | basic のリーフ配列です。空でない条件は conditions を生成します。basic の新規作成/変更では operation が match または not match の指定を明確に拒否します。テキスト包含などの複雑なセマンティクスには、advanced の対応する演算を優先して使用してください。 例: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]取得または入力方法: 実際のログフィールド条件です。通常マッチをクリアする必要がある場合は filters=[] を明示的に渡してください。 |
|
| logIndexes[*].extend.filters[*].name | string | 実際のフィールド名です。バッククォートを付けません。 例: env取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].extend.filters[*].condition | string | 前の条件との and/or 関係です。先頭項目の連結子は無視されます。 例: and取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].extend.filters[*].operation | string | 一般的な =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist を使用します。basic では match/not match を禁止します。 例: =取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].extend.filters[*].value | array | 条件値の配列です。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 例: ["production"]取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].extend.filters[*] | json | 条件オブジェクトです。フィールド名/演算/値は完全である必要があります。 例: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}取得または入力方法: 各項目は 1 つの基本条件を表します。 |
|
| logIndexes[*].extend.filters[*].value[*] | JSON | 単一の比較値です。表示名を実際の値の代わりに使用しないでください。 例: production取得または入力方法: ログの元のフィールド値を取得し、文字列/数値型を保持します。 |
|
| logIndexes[*].extend.advancedFilter | json | advanced 時に必須のルート group オブジェクトです。グループは type=group、condition、filters を使用し、リーフは type=rule、name、operation、value を使用します。 例: {"type": "group", "condition": "and", "filters": [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]}取得または入力方法: 高度なモードでは次の再帰的な group/rule 構造で構成し、basic のフラット形式をコピーしないでください。 |
|
| logIndexes[*].extend.advancedFilter.type | string | ルートノードの型です。rule にはできません。 例: group取得または入力方法: ルートノードは group 固定です。 |
|
| logIndexes[*].extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係です。 例: and取得または入力方法: and/or で、デフォルトは and です。 |
|
| logIndexes[*].extend.advancedFilter.filters | array | 子ノードの配列です。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 例: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]取得または入力方法: リーフの rule または再帰的な group 子ノードを指定します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*] | json | rule リーフまたは group オブジェクトです。 例: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}取得または入力方法: リーフは実際のログフィールドで指定し、グループは同じ構造で再帰を続けます。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].type | string | rule はリーフ、group は再帰グループです。 例: rule取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].name | string | rule では空でないフィールド名が必須です。 例: env取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].operation | string | rule では =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist を許可します。 例: =取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].value | array | rule では配列が必須です。exist/not_exist では [] を使用できますが、それ以外では空配列を許可しません。 例: ["production"]取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].condition | string | group の子グループでは and/or を使用します。 例: and取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].filters | array | group の子グループの再帰配列です。ルールのリーフでは省略します。 例: []取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].extend.advancedFilter.filters[*].value[*] | JSON | 単一の文字列または数値です。regexp の値にはバッククォートを含めません。 例: production取得または入力方法: ログの元の値を取得します。 |
|
| logIndexes[*].extend.extendFields | array | 任意のキーフィールド配列です。tag/alias 構造で送信し、tag は空でない必要があります。新規作成ではこの構造の検証は強制されませんが、変更時には検証されます。インポートではフィールドアクセラレーションスイッチに従ってフィールドインデックスも同期しますが、直接 modify する場合はこの設定を保存するだけです。 例: [{"tag": "service", "alias": "服务"}]取得または入力方法: 実際のログフィールドから主要な表示フィールドを選択します。 |
|
| logIndexes[*].extend.extendFields[*] | json | tag/alias キーのみを許可します。 例: {"tag": "service", "alias": "服务"}取得または入力方法: フィールドキーと表示別名を指定します。 |
|
| logIndexes[*].extend.extendFields[*].tag | string | 条件付きで必須の空でないキーです。 例: service取得または入力方法: 実際のログフィールド名です。 |
|
| logIndexes[*].extend.extendFields[*].alias | string | 任意の表示別名です。 例: 服务取得または入力方法: 業務上の表示名で、省略できます。 |
|
| logIndexes[*].extend.topFields | array | 任意の表示設定で、同じ tag/alias オブジェクトを使用します。通常の modify は独立したピン留めインターフェースではありません。 例: [{"tag": "host", "alias": "主机"}]取得または入力方法: コンソールのピン留めフィールドリストを保持します。 |
|
| logIndexes[*].extend.topFields[*] | json | 単一の表示フィールドオブジェクトです。 例: {"tag": "host", "alias": "主机"}取得または入力方法: 既存のリストに従って入力します。 |
|
| logIndexes[*].extend.topFields[*].tag | string | フィールドキーです。 例: host取得または入力方法: 実際のフィールド名です。 |
|
| logIndexes[*].extend.topFields[*].alias | string | 任意の別名です。 例: 主机取得または入力方法: 表示別名です。 |
|
| logIndexes[*].extend.services | array | 任意のエコー情報で、filters の実際のマッチ条件の代わりにはなりません。 例: ["checkout-api"]取得または入力方法: コンソールの関連サービス表示設定を保持します。 |
|
| logIndexes[*].extend.services[*] | string | 単一のサービス表示値です。 例: checkout-api取得または入力方法: 実際のサービス名です。 |
|
| logIndexes[*].fields[*] | json | 単一の field/originalField マッピングです。 例: {"field": "message", "originalField": "content"}取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].fields[*].field | string | プラットフォームのフィールド名です。 例: message取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].fields[*].originalField | string | 実際のソースフィールドです。 例: content取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.name | string | クローン新規作成では空でない名前が必須で、A の名前と同じにできません。recover で既存 B がある場合は対象の元の UUID と名前を使用し、インポート名で名前を変更しません。 例: production_logs取得または入力方法: 業務に合わせて命名し、まずログインデックスリストで本ワークスペースの使用済み名前を確認します。 |
|
| logIndexes[*].cloneConfig.desc | string | 任意の説明で、最大 1024 文字です。通常の modify では省略すると保持され、空文字列にするとクリアされます。外部バインディングの変更では省略するとクリアされます。 例: 生产服务日志。取得または入力方法: 用途、ソース、保守責任の説明を入力します。 |
|
| logIndexes[*].cloneConfig.duration | string | 通常の新規作成ではデフォルトは通常 3d です。TLS 以外のストレージでは、pay はデフォルトで 3d/7d/14d/30d/60d/90d を許可し、enterprise/unlimited はデフォルトで 1d から 1800d までです。詳細はサイト設定に従います。modify では省略すると保持されます。TLS では setting を参照し、このフィールドで実際の期間を制御しません。 例: 7d取得または入力方法: 現在のワークスペースのバージョンとログストレージに応じて標準保持日数を選択し、整数+d を使用します。 |
|
| logIndexes[*].cloneConfig.storagePolicy | json | 任意の完全な長期ポリシーオブジェクトです。通常の新規作成では {} を省略します。変更では省略すると保持され、{} は無効に正規化されます。明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きい必要があり、単位は引き続き日です。 例: {"longStorageEnabled": false}取得または入力方法: ログストレージが scopedb で、バージョンが pay/enterprise/unlimited の場合にのみ長期ストレージを有効化できます。まずワークスペースの機能を確認してください。 |
|
| logIndexes[*].cloneConfig.storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合のデフォルトは false です。無効にすると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 例: false取得または入力方法: true で長期ストレージを有効化し、false で無効化します。JSON のブール値を明示することを推奨します。 |
|
| logIndexes[*].cloneConfig.storagePolicy.longStorageDuration | string | 有効時は条件付きで必須です。値は d を含む文字列で、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 例: 180d取得または入力方法: pay ではデフォルトで 90d/120d/180d/360d を選択し、enterprise/unlimited ではデフォルトで 1d から 1800d までであり、duration より厳密に大きい必要があります。 |
|
| logIndexes[*].cloneConfig.isFullLineIndex | int | 0/1 またはブール値のみを受け付けます。scopedb の新規作成ではデフォルトが 1 で、0 は許可されません。既存の Message は 0→1 を許可しますが、1→0 はできません。切り替えると message フィールドインデックスが同期され、元に戻せません。modify では省略すると保持されます。 例: 1取得または入力方法: scopedb ログの新規作成では 1/true が必須で、その他のログストレージでは 0/false を保持します。 |
|
| logIndexes[*].cloneConfig.setting | json | TLS の新規作成では hot_retention を必ず指定します。合計 duration は 3 つの時間数の合計を日に換算します。通常の変更で setting を指定する場合は、ホットストレージと必要なステージを完全に指定し、cold_retention だけを渡さないでください。その他のストレージではこのフィールドを TLS として解釈しません。 例: {"hot_retention": 168}取得または入力方法: ワークスペースのログストレージが volctls の場合にのみ、標準/低頻度/アーカイブの保持を設定します。数値の単位は時間です。 |
|
| logIndexes[*].cloneConfig.setting.hot_retention | integer | TLS では条件付きで必須です。デフォルト範囲は 1~1800 日で、24~43200 時間に相当し、24 の倍数である必要があります。コールドストレージを使用する場合、ホットストレージは最低 7 日、アーカイブを使用する場合は最低 30 日です。 例: 168取得または入力方法: 日数×24 で入力します。例: 7 日 = 168 時間。 |
|
| logIndexes[*].cloneConfig.setting.cold_retention | integer | 任意です。デフォルトは 30~1800 日で、整数日の時間数です。0 で省略を表さないでください。合計は 1800 日を超えません。 例: 720取得または入力方法: 低頻度ストレージの日数×24 で入力します。例: 30 日 = 720 時間。このステージを有効化しない場合は省略します。 |
|
| logIndexes[*].cloneConfig.setting.archive_retention | integer | 任意です。デフォルトは 60~1800 日で、整数日の時間数です。ホットストレージは最低 30 日で、合計は 1800 日を超えません。 例: 1440取得または入力方法: アーカイブ日数×24 で入力します。例: 60 日 = 1440 時間。このステージを有効化しない場合は省略します。 |
|
| logIndexes[*].cloneConfig.extend | json | クローンでは空でないマッチ条件を生成できる extend を必ず指定します。A の条件と組み合わせてマッチし、空のグループは使用できません。recover では全体を置換します。 例: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}取得または入力方法: マッチ条件は実際のログフィールドと値から構築します。その他の表示設定は元の詳細から保持します。 |
|
| logIndexes[*].cloneConfig.extend.matchMode | string | 省略/空値は basic として扱います。advanced では advancedFilter を使用し、basic では filters を使用します。モードを切り替える場合は、対応する完全な条件も同時に指定してください。 例: basic取得または入力方法: 通常マッチは basic、高度なマッチは advanced。 |
|
| logIndexes[*].cloneConfig.extend.filters | array | basic のリーフ配列です。空でない条件は conditions を生成します。basic の新規作成/変更では operation が match または not match の指定を明確に拒否します。テキスト包含などの複雑なセマンティクスには、advanced の対応する演算を優先して使用してください。 例: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]取得または入力方法: 実際のログフィールド条件です。通常マッチをクリアする必要がある場合は filters=[] を明示的に渡してください。 |
|
| logIndexes[*].cloneConfig.extend.filters[*].name | string | 実際のフィールド名です。バッククォートを付けません。 例: env取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.filters[*].condition | string | 前の条件との and/or 関係です。先頭項目の連結子は無視されます。 例: and取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.filters[*].operation | string | 一般的な =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist を使用します。basic では match/not match を禁止します。 例: =取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.filters[*].value | array | 条件値の配列です。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 例: ["production"]取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.filters[*] | json | 条件オブジェクトです。フィールド名/演算/値は完全である必要があります。 例: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}取得または入力方法: 各項目は 1 つの基本条件を表します。 |
|
| logIndexes[*].cloneConfig.extend.filters[*].value[*] | JSON | 単一の比較値です。表示名を実際の値の代わりに使用しないでください。 例: production取得または入力方法: ログの元のフィールド値を取得し、文字列/数値型を保持します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter | json | advanced 時に必須のルート group オブジェクトです。グループは type=group、condition、filters を使用し、リーフは type=rule、name、operation、value を使用します。 例: {"type": "group", "condition": "and", "filters": [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]}取得または入力方法: 高度なモードでは次の再帰的な group/rule 構造で構成し、basic のフラット形式をコピーしないでください。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.type | string | ルートノードの型です。rule にはできません。 例: group取得または入力方法: ルートノードは group 固定です。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係です。 例: and取得または入力方法: and/or で、デフォルトは and です。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters | array | 子ノードの配列です。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 例: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]取得または入力方法: リーフの rule または再帰的な group 子ノードを指定します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*] | json | rule リーフまたは group オブジェクトです。 例: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}取得または入力方法: リーフは実際のログフィールドで指定し、グループは同じ構造で再帰を続けます。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].type | string | rule はリーフ、group は再帰グループです。 例: rule取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].name | string | rule では空でないフィールド名が必須です。 例: env取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].operation | string | rule では =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist を許可します。 例: =取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].value | array | rule では配列が必須です。exist/not_exist では [] を使用できますが、それ以外では空配列を許可しません。 例: ["production"]取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].condition | string | group の子グループでは and/or を使用します。 例: and取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].filters | array | group の子グループの再帰配列です。ルールのリーフでは省略します。 例: []取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].value[*] | JSON | 単一の文字列または数値です。regexp の値にはバッククォートを含めません。 例: production取得または入力方法: ログの元の値を取得します。 |
|
| logIndexes[*].cloneConfig.extend.extendFields | array | 任意のキーフィールド配列です。tag/alias 構造で送信し、tag は空でない必要があります。新規作成ではこの構造の検証は強制されませんが、変更時には検証されます。インポートではフィールドアクセラレーションスイッチに従ってフィールドインデックスも同期しますが、直接 modify する場合はこの設定を保存するだけです。 例: [{"tag": "service", "alias": "服务"}]取得または入力方法: 実際のログフィールドから主要な表示フィールドを選択します。 |
|
| logIndexes[*].cloneConfig.extend.extendFields[*] | json | tag/alias キーのみを許可します。 例: {"tag": "service", "alias": "服务"}取得または入力方法: フィールドキーと表示別名を指定します。 |
|
| logIndexes[*].cloneConfig.extend.extendFields[*].tag | string | 条件付きで必須の空でないキーです。 例: service取得または入力方法: 実際のログフィールド名です。 |
|
| logIndexes[*].cloneConfig.extend.extendFields[*].alias | string | 任意の表示別名です。 例: 服务取得または入力方法: 業務上の表示名で、省略できます。 |
|
| logIndexes[*].cloneConfig.extend.topFields | array | 任意の表示設定で、同じ tag/alias オブジェクトを使用します。通常の modify は独立したピン留めインターフェースではありません。 例: [{"tag": "host", "alias": "主机"}]取得または入力方法: コンソールのピン留めフィールドリストを保持します。 |
|
| logIndexes[*].cloneConfig.extend.topFields[*] | json | 単一の表示フィールドオブジェクトです。 例: {"tag": "host", "alias": "主机"}取得または入力方法: 既存のリストに従って入力します。 |
|
| logIndexes[*].cloneConfig.extend.topFields[*].tag | string | フィールドキーです。 例: host取得または入力方法: 実際のフィールド名です。 |
|
| logIndexes[*].cloneConfig.extend.topFields[*].alias | string | 任意の別名です。 例: 主机取得または入力方法: 表示別名です。 |
|
| logIndexes[*].cloneConfig.extend.services | array | 任意のエコー情報で、filters の実際のマッチ条件の代わりにはなりません。 例: ["checkout-api"]取得または入力方法: コンソールの関連サービス表示設定を保持します。 |
|
| logIndexes[*].cloneConfig.extend.services[*] | string | 単一のサービス表示値です。 例: checkout-api取得または入力方法: 実際のサービス名です。 |
|
| logIndexes[*].cloneConfig.conditions | string | エクスポート互換の条件文字列です。インポートの作成/上書きでは実際に extend から再生成され、このフィールドで範囲を直接決定しません。 例: { `env` = 'production' }取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.fields | array | フィールドマッピングです。省略すると既存のマッピングを保持し、明示的な [] は空で上書きします。外部 modify の空配列の動作とは異なります。 例: [{"field": "message", "originalField": "content"}]取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.fields[*] | json | 単一の field/originalField マッピングです。 例: {"field": "message", "originalField": "content"}取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.fields[*].field | string | プラットフォームのフィールド名です。 例: message取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.fields[*].originalField | string | 実際のソースフィールドです。 例: content取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].cloneConfig.is_disable | boolean | エクスポート/インポートの状態キーは正確に is_disable です。デフォルトは false で、recover 時に元が無効で true を渡さない場合は有効化されます。 例: false取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes | array | Y | 空でないテンプレート配列が必須です。デフォルトインデックステンプレートはスキップされ、外部バインディングはこのインポート機能の対象外です。 null を許可: False 例: []取得または入力方法: 本モジュールの export レスポンスの content 配列からテンプレートを取得します。レスポンス全体の外殻を Body として扱わないでください。 |
| logIndexes[*] | object | テンプレートオブジェクトで、次の完全な構造で構成します。 例: {"name": "production_logs", "desc": "生产服务日志。", "duration": "7d", "directIndex": false, "isFullLineIndex": 1, "extend": {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}}取得または入力方法: 各項目は通常の内部/直書きインデックスで、cloneConfig を 1 つ持つことができます。 |
|
| logIndexes[*].cloneConfig | json | 任意のクローン B テンプレートです。ない場合は null/省略します。これによって対象に既存の B が削除されることはなく、通常の add/modify ではこの公開パラメータをサポートしません。 null を許可: True 例: {}取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].conditions | string | エクスポート互換の条件文字列です。インポートの作成/上書きでは実際に extend から再生成され、このフィールドで範囲を直接決定しません。 null を許可: False 例: { `env` = 'production' }取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].desc | string | 任意の説明で、最大 1024 文字です。通常の modify では省略すると保持され、空文字列にするとクリアされます。外部バインディングの変更では省略するとクリアされます。 null を許可: False 例: 生产服务日志。取得または入力方法: 用途、ソース、保守責任の説明を入力します。 |
|
| logIndexes[*].directIndex | boolean | 任意です。新規作成時のデフォルトは false です。直書きは通常マッチの順序で振り分けません。通常の modify にはこのフィールドがなく、インポートの recover でも既存のインデックスモードを変換しません。 null を許可: False 例: false取得または入力方法: 通常マッチで振り分けるインデックスは false、インデックス名で直接書き込むネイティブ直書きインデックスは true です。 |
|
| logIndexes[*].duration | string | 通常の新規作成ではデフォルトは通常 3d です。TLS 以外のストレージでは、pay はデフォルトで 3d/7d/14d/30d/60d/90d を許可し、enterprise/unlimited はデフォルトで 1d から 1800d までです。詳細はサイト設定に従います。modify では省略すると保持されます。TLS では setting を参照し、このフィールドで実際の期間を制御しません。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースのバージョンとログストレージに応じて標準保持日数を選択し、整数+d を使用します。 |
|
| logIndexes[*].extend | json | 任意の拡張オブジェクトで、実際のマッチおよび表示設定を含みます。通常の modify では第一階層のキーでマージし、未指定のキーは保持され、配列またはネストしたオブジェクトは全体置換されます。{} は既存の filters を消去しません。null は避けてください。一部の変更分岐では 500 になります。インポートの recover では extend 全体を置換します。 null を許可: False 例: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}取得または入力方法: マッチ条件は実際のログフィールドと値から構築します。その他の表示設定は元の詳細から保持します。 |
|
| logIndexes[*].fields | array | フィールドマッピングです。省略すると既存のマッピングを保持し、明示的な [] は空で上書きします。外部 modify の空配列の動作とは異なります。 null を許可: False 例: [{"field": "message", "originalField": "content"}]取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].isFullLineIndex | int | 0/1 またはブール値のみを受け付けます。scopedb の新規作成ではデフォルトが 1 で、0 は許可されません。既存の Message は 0→1 を許可しますが、1→0 はできません。切り替えると message フィールドインデックスが同期され、元に戻せません。modify では省略すると保持されます。 null を許可: False 例: 1取得または入力方法: scopedb ログの新規作成では 1/true が必須で、その他のログストレージでは 0/false を保持します。 |
|
| logIndexes[*].is_disable | boolean | エクスポート/インポートの状態キーは正確に is_disable です。デフォルトは false で、recover 時に元が無効で true を渡さない場合は有効化されます。 null を許可: False 例: false取得または入力方法: エクスポートテンプレートの対応するフィールドを使用し、対象ワークスペースのリソースに合わせて調整します。 |
|
| logIndexes[*].name | string | Y | 新規作成では必須です。宣言上は最大 256 文字ですが、実際の保存列は 128 であるため、128 以内を推奨します。ES ログストレージではハイフンを許可しません。default の予約名や他のインデックス UUID を使用しないでください。通常のインデックスは modify で名前を変更できません。 null を許可: False 例: production_logs取得または入力方法: 業務に合わせて命名し、まずログインデックスリストで本ワークスペースの使用済み名前を確認します。 |
| logIndexes[*].setting | json | TLS の新規作成では hot_retention を必ず指定します。合計 duration は 3 つの時間数の合計を日に換算します。通常の変更で setting を指定する場合は、ホットストレージと必要なステージを完全に指定し、cold_retention だけを渡さないでください。その他のストレージではこのフィールドを TLS として解釈しません。 null を許可: False 例: {"hot_retention": 168}取得または入力方法: ワークスペースのログストレージが volctls の場合にのみ、標準/低頻度/アーカイブの保持を設定します。数値の単位は時間です。 |
|
| logIndexes[*].storagePolicy | json | 任意の完全な長期ポリシーオブジェクトです。通常の新規作成では {} を省略します。変更では省略すると保持され、{} は無効に正規化されます。明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きい必要があり、単位は引き続き日です。 null を許可: False 例: {"longStorageEnabled": false}取得または入力方法: ログストレージが scopedb で、バージョンが pay/enterprise/unlimited の場合にのみ長期ストレージを有効化できます。まずワークスペースの機能を確認してください。 |
|
| repeatLogIndexNameOp | string | 任意です。デフォルトは check です。check で重複名がある場合は repeat_name を返し、インポートしません。skip は既存項目を上書きしません。recover は履歴データではなく設定を上書きします。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: check はチェック、skip は既存名をスキップ、recover は同名設定を上書きします。 |
パラメータ補足説明¶
このインターフェースはログインデックステンプレートを個別にインポートするために使用します。
呼び出しフロー
logIndexes配列を準備し、各要素は 1 つのログインデックステンプレートを表します。repeatLogIndexNameOpで同名インデックスが存在する場合の処理ポリシーを指定します。- ポリシーが
checkで同名インデックスが存在する場合、インターフェースはrepeat_nameを返し、保存を実行しません。
repeatLogIndexNameOp の説明
| 値 | 説明 |
|---|---|
| check | 重複のみチェックします。同名インデックスがある場合は repeat_name を返します |
| skip | 既存の同名インデックスをスキップし、存在しないインデックスのみをインポートします |
| recover | 対象ワークスペースに同名インデックスが既にある場合、インポートテンプレートでそのインデックス設定を上書きします |
特殊ルール
name=defaultのテンプレートは無視され、インポートを実行しません- 外部インデックステンプレートは無視され、インポートを実行しません
recoverは同名の内部インデックスのみを上書きし、defaultは操作しません
テンプレートフィールド
| フィールド | type | 必須 | 説明 |
|---|---|---|---|
| name | string | はい | インデックス名 |
| desc | string | いいえ | インデックス説明 |
| directIndex | boolean | いいえ | ネイティブ直書きインデックスかどうか |
| isFullLineIndex | int | いいえ | 全行インデックスかどうか。整数 0/1 またはブール値 false/true をサポートします。Scopedb インデックスの新規作成ではデフォルトが 1 で、0 への設定は許可されません。既存インデックスを上書きする場合は 0→1 を許可し、1→0 を禁止します。指定しない場合は元の値を保持します |
| conditions | string | いいえ | マッチ条件 |
| duration | string | いいえ | 保存期間 |
| storagePolicy | json | いいえ | 長期ストレージポリシー |
| extend | json | いいえ | 拡張設定 |
| setting | json | いいえ | ストレージ設定 |
| fields | array | いいえ | フィールドマッピング |
| cloneConfig | json/null | いいえ | クローンインデックスの完全な設定。クローンインデックスがない場合は null を渡します |
| is_disable | boolean | いいえ | 無効化するかどうか |
レスポンス説明
- インポート成功時は
successCount、failCountを返します - 一部のオブジェクトが失敗した場合、レスポンスに
failedNamesが追加されます checkモードで重複が見つかった場合はrepeat_nameを返します
リクエスト例¶
curl --request POST '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":"check","logIndexes":[{"name":"production_logs","desc":"生产服务日志。","duration":"7d","directIndex":false,"isFullLineIndex":1,"extend":{"matchMode":"basic","filters":[{"name":"env","condition":"and","operation":"=","value":["production"]}]},"conditions":"{ `env` = '"'"'production'"'"' }","storagePolicy":{},"setting":{},"fields":[],"is_disable":false,"cloneConfig":null}]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.successCount | integer | コミットに成功した項目数です。クローンは A と同じ項目として数えます。下流の同期成功は保証しません。 |
| content.failCount | integer | 項目ごとのコミット前に失敗した数です。 |
| content.failedNames | array<string> |
失敗がある場合に対応するインデックス名を返します。 |
| content.failedNames[] | string | 単一の失敗名です。 |
| content.repeat_name | array<string> |
check モードで重複名が見つかった場合に統計結果の代わりに返され、インポートは実行されません。 |
| content.repeat_name[] | string | 単一の既存名です。 |
| content.declaration | object | ワークスペース宣言です。 |
{
"code": 200,
"content": {
"successCount": 1,
"failCount": 0,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
check モードで重複名が見つかった場合:
{
"code": 200,
"content": {
"repeat_name": [
"production_logs"
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトでない、またはポリシーがオブジェクトでない | 一部の JSON ファイル形式エラー | パラメータ表に従ってオブジェクトを送信し、storagePolicy には JSON オブジェクトを使用してください。 |
| 400 | ft.ErrorFieldCheck | テンプレートまたは cloneConfig に空でない名前がない | {} フィールド検証に失敗 | 有効な名前を補完してください。 |
| 400 | ft.FileObjectNameRepeat | 同一バッチ内で有効なテンプレート名が重複 | ファイル内に同じ名前のオブジェクトが存在 | trim 後の名前で重複を排除してください。 |
| 500 | ft.InternalServerError | 前処理、全体クエリ、または最終レスポンス処理に失敗 | 内部エラー | まず既存インデックスと各項目の状態を確認してから再試行を判断し、traceId を提供してください。 |
| 403 | ft.Forbidden | 権限不足、または現在のバージョンでこのインターフェースが許可されていない | 操作権限がありません | 対応するインデックス権限を持つ API Key とサポート対象バージョンを使用してください。 |