エクスポート¶
POST /api/v1/log_index_cfg/export
概要¶
フィルタ条件に従って内部ログインデックスおよびそのクローンテンプレートを JSON でエクスポートします。
呼び出し前の確認と使用手順¶
URL Query でフィルタを送信します。Query が空でない場合、POST に JSON Body は不要で、Query が優先的に読み取られます。全量エクスポートでは、明示的に ?search=空文字列 を使用して Query が存在することを保証できます。Query を完全に省略する場合は、Content-Type: application/json と {} を送信してください。そうしないと、非 JSON Body の読み取りでエラーが発生する可能性があります。混在させないでください。本ワークスペースの削除済みでない、デフォルトでない、外部バインディングでない、クローンでない独立項目のみをエクスポートします。A の名前の昇順で、A には cloneConfig と両方の fields が含まれます。返却されるのは JSON の共通エンベロープ内の配列であり、ZIP/ファイルダウンロードや非同期タスクではありません。成功してもインデックスやデータは変更されません。
公開されている isBindCustomStore と実装には歴史的な差異があります。実装ではこれを無視し、バインディングを常に除外します。true を指定してバインディングのエクスポートを要求したり、その返却が空であることに依存したりすることはできません。移行時は content からテンプレートを抽出し、共通の declaration を削除してから、import の logIndexes フィールドに従って送信し、対象ストレージ/保持/全行機能を確認します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得方法または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isBindCustomStore | boolean | 互換性のためのクエリフィールドで、現在は実装のフィルタには使用されません。値に関係なくバインディングインデックスを除外し、true でも空結果を保証しません。 例: false取得方法または入力方法: このエクスポートは内部インデックスのみをサポートするため、false を使用します。 |
|
| isDirectIndex | boolean | 任意。A の直接書き込みマークでフィルタします。 例: false取得方法または入力方法: true は直接書き込み、false は非直接書き込み、省略時は両方です。 |
|
| queryType | commaArray | 任意。カテゴリの完全一致フィルタで、省略時はフィルタしません。 例: logging取得方法または入力方法: 一覧の queryType から実際の値を取得し、複数指定する場合は半角カンマで区切り、スペースは入れません。 |
|
| search | string | 任意。B がヒットした場合はその A および内包される B をエクスポートします。 空文字列を許可: True 例: production取得方法または入力方法: A または B の名前のキーワードに一致させます。 |
パラメータ補足説明¶
この 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 | フィールドマッピング設定 |
| cloneConfig | json/null | クローンインデックスの完全な設定。クローンインデックスがない場合は null |
| is_disable | boolean | 無効化されているか |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/export?search=production&isDirectIndex=false' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
一致する内部ソースインデックステンプレートの配列。結果がない場合は []。クローンは A に内包され、独立した項目としては扱われません。 |
| content[].name | string | 新規作成時は必須。宣言上は最大 256 文字だが実際の保存列は 128 のため、128 文字以内を推奨。ES ログストレージではハイフンを使用できません。default の予約名や他のインデックス UUID は使用しないでください。通常のインデックスは modify で名前を変更できません。 |
| content[].desc | string | 任意の説明。最大 1024 文字。通常の modify では省略時は保持され、空文字列でクリアされます。外部バインディングの変更では省略するとクリアされます。 |
| content[].duration | string | 通常の新規作成では省略時は通常 3d。非 TLS ストレージでは pay はデフォルトで 3d/7d/14d/30d/60d/90d を許可し、enterprise/unlimited はデフォルトで 1d~1800d を許可します。具体的にはサイト設定に準じます。modify では省略時に保持されます。TLS では setting を参照し、このフィールドで実際の期間を制御しません。 |
| content[].storagePolicy | json | 任意の完全な長期ポリシーオブジェクト。通常の新規作成では省略時 {}。変更時は省略で保持され、{} は無効に正規化され、明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きくする必要があり、単位は引き続き日です。 |
| content[].storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合はデフォルト false。無効化すると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 |
| content[].storagePolicy.longStorageDuration | string | 有効化時は条件付きで必須。フィールドは d を含む文字列で、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 |
| content[].directIndex | boolean | 任意。新規作成時のデフォルトは false。直接書き込みは通常のマッチ順序で振り分けられません。通常の modify にはこのフィールドがなく、インポートの recover でも既存インデックスのモードは変換されません。 |
| content[].isFullLineIndex | int | 0/1 またはブール値のみ受け付けます。scopedb の新規作成では省略時 1 で、0 は許可されません。既存の Message は 0→1 に可能ですが、1→0 にはできません。切り替えると message フィールドインデックスが同期され、元に戻せません。modify では省略時に保持されます。 |
| content[].setting | json | TLS の新規作成では hot_retention を必ず指定します。合計 duration は 3 つの時間数の合計から日に換算されます。通常の変更で setting を指定する場合は、ホットストレージおよび必要なステージを完全に指定し、cold_retention だけを渡さないでください。その他のストレージでは、このフィールドを TLS として解釈しません。 |
| content[].setting.hot_retention | integer | TLS では条件付きで必須。デフォルト範囲は 1~1800 日で、24..43200 時間に対応し、24 の倍数です。コールドストレージを使用する場合、ホットストレージは少なくとも 7 日、アーカイブを使用する場合は少なくとも 30 日必要です。 |
| content[].setting.cold_retention | integer | 任意。デフォルトは 30..1800 日で、整数日の時間数です。0 は省略を表すため使用しません。合計は 1800 日を超えません。 |
| content[].setting.archive_retention | integer | 任意。デフォルトは 60..1800 日で、整数日の時間数です。ホットストレージは少なくとも 30 日、合計は 1800 日を超えません。 |
| content[].extend | json | 任意の拡張オブジェクト。実際のマッチ条件および表示設定を含みます。通常の modify では第一階層のキーでマージされ、指定されていないキーは保持され、配列またはネストしたオブジェクトは全体が置き換えられます。{} は既存の filters を消去しません。null は避けてください。一部の変更分岐では 500 になります。インポートの recover では extend 全体が置き換えられます。 |
| content[].extend.matchMode | string | 省略/空値の場合は basic として扱います。advanced では advancedFilter、basic では filters を使用し、モードを切り替える際は対応する完全な条件も同時に指定してください。 |
| content[].extend.filters | array | basic のリーフ配列。空でない条件は conditions を生成します。新規作成/変更の basic では operation が match または not match の場合は明確に拒否されます。テキスト包含などの複雑なセマンティクスには、advanced の対応する演算を優先して使用してください。 |
| content[].extend.filters[].name | string | 実際のフィールド名。バッククォートは付けません。 |
| content[].extend.filters[].condition | string | 前の条件との and/or 関係。先頭項目の連結子は無視されます。 |
| content[].extend.filters[].operation | string | 一般的に =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist を使用します。basic では match/not match は禁止です。 |
| content[].extend.filters[].value | array | 条件値の配列。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 |
| content[].extend.filters[] | json | 条件オブジェクト。フィールド名/演算/値は完全に指定してください。 |
| content[].extend.filters[].value[] | JSON | 単一の比較値。表示名で実際の値を代用しないでください。 |
| content[].extend.advancedFilter | json | advanced 時に必須のルート group オブジェクト。グループは type=group、condition、filters を使用し、リーフは type=rule、name、operation、value を使用します。 |
| content[].extend.advancedFilter.type | string | ルートノードの型。rule にはできません。 |
| content[].extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係。 |
| content[].extend.advancedFilter.filters | array | 子ノードの配列。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 |
| content[].extend.advancedFilter.filters[] | json | rule リーフまたは group オブジェクト。 |
| content[].extend.advancedFilter.filters[].type | string | rule はリーフ、group は再帰グループです。 |
| content[].extend.advancedFilter.filters[].name | string | rule では必須の空でないフィールド名。 |
| content[].extend.advancedFilter.filters[].operation | string | rule では =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist を使用できます。 |
| content[].extend.advancedFilter.filters[].value | array | rule では必須の配列。exist/not_exist では [] を使用できますが、それ以外では空配列は許可されません。 |
| content[].extend.advancedFilter.filters[].condition | string | group の子グループでは and/or を使用します。 |
| content[].extend.advancedFilter.filters[].filters | array | group の子グループの再帰配列。ルールのリーフでは省略します。 |
| content[].extend.advancedFilter.filters[].value[] | JSON | 単一の文字列または数値。regexp の値にバッククォートは含めません。 |
| content[].extend.extendFields | array | 任意のキーフィールド配列。tag/alias 構造で送信し、tag は空でない必要があります。新規追加ではこの構造の検証は強制されませんが、変更時には検証されます。インポートではフィールド高速化スイッチに従って追加でフィールドインデックスを同期しますが、直接 modify する場合はこの設定を保存するだけです。 |
| content[].extend.extendFields[] | json | tag/alias キーのみ許可されます。 |
| content[].extend.extendFields[].tag | string | 条件付きで必須の空でないキー。 |
| content[].extend.extendFields[].alias | string | 任意の表示エイリアス。 |
| content[].extend.topFields | array | 任意の表示設定。同じ tag/alias オブジェクトで使用します。通常の modify はトップ表示用の独立したインターフェースではありません。 |
| content[].extend.topFields[] | json | 単一の表示フィールドオブジェクト。 |
| content[].extend.topFields[].tag | string | フィールドキー。 |
| content[].extend.topFields[].alias | string | 任意のエイリアス。 |
| content[].extend.services | array | 任意のエコー情報。filters の実際のマッチ条件の代わりにはなりません。 |
| content[].extend.services[] | string | 単一のサービス表示値。 |
| content[].conditions | string | エクスポート互換の条件文字列。インポート時の作成/上書きでは実際には extend から再生成され、このフィールドで範囲を直接決定するわけではありません。 |
| content[].fields | array | フィールドマッピング。省略時は既存のマッピングを保持し、明示的な [] は空で上書きします。外部 modify の空配列の動作とは異なります。 |
| content[].fields[] | json | 単一の field/originalField マッピング。 |
| content[].fields[].field | string | プラットフォームのフィールド名。 |
| content[].fields[].originalField | string | 実際のソースフィールド。 |
| content[].is_disable | boolean | エクスポート/インポートの状態キーは正確に is_disable です。デフォルトは false で、recover 時に元が無効で true を渡していない場合は有効になります。 |
| content[].cloneConfig | json | 任意のクローン B テンプレート。ない場合は null/省略。これによって対象に既存の B が削除されることはなく、通常の add/modify ではこの公開パラメータはサポートされません。 |
| content[].cloneConfig.name | string | クローンの新規作成では必須の空でない名前で、A の名前と同じにできません。recover で既存の B がある場合は対象の元の UUID と名前を使用し、インポート名で名前を変更しません。 |
| content[].cloneConfig.desc | string | 任意の説明。最大 1024 文字。通常の modify では省略時は保持され、空文字列でクリアされます。外部バインディングの変更では省略するとクリアされます。 |
| content[].cloneConfig.duration | string | 通常の新規作成では省略時は通常 3d。非 TLS ストレージでは pay はデフォルトで 3d/7d/14d/30d/60d/90d を許可し、enterprise/unlimited はデフォルトで 1d~1800d を許可します。具体的にはサイト設定に準じます。modify では省略時に保持されます。TLS では setting を参照し、このフィールドで実際の期間を制御しません。 |
| content[].cloneConfig.storagePolicy | json | 任意の完全な長期ポリシーオブジェクト。通常の新規作成では省略時 {}。変更時は省略で保持され、{} は無効に正規化され、明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きくする必要があり、単位は引き続き日です。 |
| content[].cloneConfig.storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合はデフォルト false。無効化すると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 |
| content[].cloneConfig.storagePolicy.longStorageDuration | string | 有効化時は条件付きで必須。フィールドは d を含む文字列で、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 |
| content[].cloneConfig.isFullLineIndex | int | 0/1 またはブール値のみ受け付けます。scopedb の新規作成では省略時 1 で、0 は許可されません。既存の Message は 0→1 に可能ですが、1→0 にはできません。切り替えると message フィールドインデックスが同期され、元に戻せません。modify では省略時に保持されます。 |
| content[].cloneConfig.setting | json | TLS の新規作成では hot_retention を必ず指定します。合計 duration は 3 つの時間数の合計から日に換算されます。通常の変更で setting を指定する場合は、ホットストレージおよび必要なステージを完全に指定し、cold_retention だけを渡さないでください。その他のストレージでは、このフィールドを TLS として解釈しません。 |
| content[].cloneConfig.setting.hot_retention | integer | TLS では条件付きで必須。デフォルト範囲は 1~1800 日で、24..43200 時間に対応し、24 の倍数です。コールドストレージを使用する場合、ホットストレージは少なくとも 7 日、アーカイブを使用する場合は少なくとも 30 日必要です。 |
| content[].cloneConfig.setting.cold_retention | integer | 任意。デフォルトは 30..1800 日で、整数日の時間数です。0 は省略を表すため使用しません。合計は 1800 日を超えません。 |
| content[].cloneConfig.setting.archive_retention | integer | 任意。デフォルトは 60..1800 日で、整数日の時間数です。ホットストレージは少なくとも 30 日、合計は 1800 日を超えません。 |
| content[].cloneConfig.extend | json | クローンでは空でないマッチ条件を生成できる extend を必ず指定します。A の条件と組み合わせてマッチし、空のグループは使用できません。recover では全体が置き換えられます。 |
| content[].cloneConfig.extend.matchMode | string | 省略/空値の場合は basic として扱います。advanced では advancedFilter、basic では filters を使用し、モードを切り替える際は対応する完全な条件も同時に指定してください。 |
| content[].cloneConfig.extend.filters | array | basic のリーフ配列。空でない条件は conditions を生成します。新規作成/変更の basic では operation が match または not match の場合は明確に拒否されます。テキスト包含などの複雑なセマンティクスには、advanced の対応する演算を優先して使用してください。 |
| content[].cloneConfig.extend.filters[].name | string | 実際のフィールド名。バッククォートは付けません。 |
| content[].cloneConfig.extend.filters[].condition | string | 前の条件との and/or 関係。先頭項目の連結子は無視されます。 |
| content[].cloneConfig.extend.filters[].operation | string | 一般的に =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist を使用します。basic では match/not match は禁止です。 |
| content[].cloneConfig.extend.filters[].value | array | 条件値の配列。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 |
| content[].cloneConfig.extend.filters[] | json | 条件オブジェクト。フィールド名/演算/値は完全に指定してください。 |
| content[].cloneConfig.extend.filters[].value[] | JSON | 単一の比較値。表示名で実際の値を代用しないでください。 |
| content[].cloneConfig.extend.advancedFilter | json | advanced 時に必須のルート group オブジェクト。グループは type=group、condition、filters を使用し、リーフは type=rule、name、operation、value を使用します。 |
| content[].cloneConfig.extend.advancedFilter.type | string | ルートノードの型。rule にはできません。 |
| content[].cloneConfig.extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係。 |
| content[].cloneConfig.extend.advancedFilter.filters | array | 子ノードの配列。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 |
| content[].cloneConfig.extend.advancedFilter.filters[] | json | rule リーフまたは group オブジェクト。 |
| content[].cloneConfig.extend.advancedFilter.filters[].type | string | rule はリーフ、group は再帰グループです。 |
| content[].cloneConfig.extend.advancedFilter.filters[].name | string | rule では必須の空でないフィールド名。 |
| content[].cloneConfig.extend.advancedFilter.filters[].operation | string | rule では =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist を使用できます。 |
| content[].cloneConfig.extend.advancedFilter.filters[].value | array | rule では必須の配列。exist/not_exist では [] を使用できますが、それ以外では空配列は許可されません。 |
| content[].cloneConfig.extend.advancedFilter.filters[].condition | string | group の子グループでは and/or を使用します。 |
| content[].cloneConfig.extend.advancedFilter.filters[].filters | array | group の子グループの再帰配列。ルールのリーフでは省略します。 |
| content[].cloneConfig.extend.advancedFilter.filters[].value[] | JSON | 単一の文字列または数値。regexp の値にバッククォートは含めません。 |
| content[].cloneConfig.extend.extendFields | array | 任意のキーフィールド配列。tag/alias 構造で送信し、tag は空でない必要があります。新規追加ではこの構造の検証は強制されませんが、変更時には検証されます。インポートではフィールド高速化スイッチに従って追加でフィールドインデックスを同期しますが、直接 modify する場合はこの設定を保存するだけです。 |
| content[].cloneConfig.extend.extendFields[] | json | tag/alias キーのみ許可されます。 |
| content[].cloneConfig.extend.extendFields[].tag | string | 条件付きで必須の空でないキー。 |
| content[].cloneConfig.extend.extendFields[].alias | string | 任意の表示エイリアス。 |
| content[].cloneConfig.extend.topFields | array | 任意の表示設定。同じ tag/alias オブジェクトで使用します。通常の modify はトップ表示用の独立したインターフェースではありません。 |
| content[].cloneConfig.extend.topFields[] | json | 単一の表示フィールドオブジェクト。 |
| content[].cloneConfig.extend.topFields[].tag | string | フィールドキー。 |
| content[].cloneConfig.extend.topFields[].alias | string | 任意のエイリアス。 |
| content[].cloneConfig.extend.services | array | 任意のエコー情報。filters の実際のマッチ条件の代わりにはなりません。 |
| content[].cloneConfig.extend.services[] | string | 単一のサービス表示値。 |
| content[].cloneConfig.conditions | string | エクスポート互換の条件文字列。インポート時の作成/上書きでは実際には extend から再生成され、このフィールドで範囲を直接決定するわけではありません。 |
| content[].cloneConfig.fields | array | フィールドマッピング。省略時は既存のマッピングを保持し、明示的な [] は空で上書きします。外部 modify の空配列の動作とは異なります。 |
| content[].cloneConfig.fields[] | json | 単一の field/originalField マッピング。 |
| content[].cloneConfig.fields[].field | string | プラットフォームのフィールド名。 |
| content[].cloneConfig.fields[].originalField | string | 実際のソースフィールド。 |
| content[].cloneConfig.is_disable | boolean | エクスポート/インポートの状態キーは正確に is_disable です。デフォルトは false で、recover 時に元が無効で true を渡していない場合は有効になります。 |
| content[].declaration | object | 空でない各配列オブジェクトにワークスペース宣言が付与されます。インポート時にはこの追加フィールドを削除します。 |
{
"code": 200,
"content": [
{
"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,
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 404 | ft.LogIndexCfgNoExists | エクスポートで詳細を読み取る際に対象が同時に削除された | 指定されたログインデックス設定が存在しない | 再エクスポートして一覧を更新してください。 |
| 500 | ft.InternalServerError | 設定またはマッピングの読み取り/フォーマットに失敗 | 内部エラー | フィルタを絞って再試行し、継続的に失敗する場合は traceId を提供してください。 |
| 403 | ft.Forbidden | 権限不足、または現在のバージョンでこの API が許可されていない | 操作権限がありません | 対応するインデックス権限を持つ API Key とサポート対象バージョンを使用してください。 |