デフォルトタイプのインデックスを作成¶
POST /api/v1/log_index_cfg/add
概要¶
内部ログインデックス設定を新規作成します。
呼び出し前の確認と使用手順¶
まず、ワークスペースでマルチインデックスが有効化され、クォータがあることを確認します。内部インデックスのデフォルト上限は 30 ですが、ワークスペース設定で調整できます。内部インデックスの有効化、無効化、クローンはいずれも数に含まれ、外部インデックスのバインドはこの内部クォータでは集計されません。新規作成時は name、duration、extend を完全に指定することを推奨します。scopedb の新規作成では全行インデックスになります。directIndex=true はネイティブ直接書き込みを表します。条件による振り分けと直接書き込み方式は収集側と一致させる必要があります。
本公開の新規作成 Body では cloneConfig を宣言していないため、隠しフィールドを付加してクローンを作成することはできません。一括テンプレートおよびクローン設定が必要な場合は、インポートインターフェースの公開構造を参照してください。
ストレージ設定、実際の下流操作、データベースコミットは同一のアトミックステップではありません。エラー/タイムアウトが発生した場合は、まず一覧および詳細で現在の設定を確認し、次にストレージの実際の状態を確認してください。そのまま重複して新規作成しないでください。インデックスの作成が成功しても、物理インデックスが作成済みであることやデータが存在することを保証するものではありません。保持期間を短縮する前に、データ保持要件を確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合はデフォルト false です。無効にすると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 例: false取得または入力方法: true で長期ストレージを有効化、false で無効化します。JSON のブール値を明示することを推奨します。 |
|
| storagePolicy.longStorageDuration | string | 有効時は条件付き必須です。値は d を含む文字列であり、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 例: 180d取得または入力方法: pay ではデフォルトで 90d/120d/180d/360d を選択します。enterprise/unlimited ではデフォルトで 1d から 1800d までで、duration より厳密に大きくする必要があります。 |
|
| extend.matchMode | string | 省略/空値の場合は basic として扱います。advanced では advancedFilter を使用し、basic では filters を使用します。モードを切り替える際は、対応する完全な条件も同時に指定してください。 例: basic取得または入力方法: 通常マッチは basic、高度なマッチは advanced です。 |
|
| extend.filters | array | basic のリーフ配列です。空でない条件は conditions を生成します。basic の新規作成/変更では operation が match または not match の指定を明示的に拒否します。テキスト包含などの複雑なセマンティクスには advanced の対応する演算を優先してください。 例: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]取得または入力方法: 実際のログフィールド条件です。通常マッチをクリアする必要がある場合は filters=[] を明示的に渡します。 |
|
| extend.filters[*].name | string | 実際のフィールド名です。バッククォートを付けません。 例: env取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| extend.filters[*].condition | string | 直前の条件との and/or 関係です。先頭項目の連結子は無視されます。 例: and取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| extend.filters[*].operation | string | 一般的な値は =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist です。basic では match/not match を禁止します。 例: =取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| extend.filters[*].value | array | 条件値の配列です。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 例: ["production"]取得または入力方法: 実際のログフィールド、値、マッチ関係に従って入力します。 |
|
| extend.filters[*] | json | 条件オブジェクトです。フィールド名/演算/値を完全に指定してください。 例: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}取得または入力方法: 各項目は 1 つの基本条件を表します。 |
|
| extend.filters[*].value[*] | JSON | 単一の比較値です。表示名を実際の値の代わりに使用しないでください。 例: production取得または入力方法: ログの元のフィールド値を使用し、文字列/数値型を保持します。 |
|
| 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 のフラット形式をコピーしないでください。 |
|
| extend.advancedFilter.type | string | ルートノードの型です。rule にはできません。 例: group取得または入力方法: ルートノードは固定で group です。 |
|
| extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係です。 例: and取得または入力方法: and/or を使用します。デフォルトは and です。 |
|
| extend.advancedFilter.filters | array | 子ノードの配列です。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 例: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]取得または入力方法: リーフ rule または再帰 group の子ノードを指定します。 |
|
| extend.advancedFilter.filters[*] | json | rule リーフまたは group オブジェクトです。 例: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}取得または入力方法: リーフは実際のログフィールドで指定し、グループは同じ構造で再帰的に指定します。 |
|
| extend.advancedFilter.filters[*].type | string | rule はリーフ、group は再帰グループです。 例: rule取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].name | string | rule では空でないフィールド名が必須です。 例: env取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].operation | string | rule で許可される値は =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist です。 例: =取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].value | array | rule では配列が必須です。exist/not_exist では [] を使用できますが、それ以外では空配列を許可しません。 例: ["production"]取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].condition | string | group の子グループでは and/or を使用します。 例: and取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].filters | array | group の子グループの再帰配列です。ルールリーフでは省略します。 例: []取得または入力方法: 対応する group/rule ノード構造に従って入力します。 |
|
| extend.advancedFilter.filters[*].value[*] | JSON | 単一の文字列または数値です。regexp の値にバッククォートを含めません。 例: production取得または入力方法: ログの元の値を使用します。 |
|
| extend.extendFields | array | 任意のキーフィールド配列です。tag/alias 構造で送信し、tag は空でない必要があります。新規作成ではこの構造のバリデーションは強制されませんが、変更時には検証されます。インポートではフィールドアクセラレーションスイッチに従ってフィールドインデックスも同期されます。直接 modify した場合はこの設定のみ保存されます。 例: [{"tag": "service", "alias": "服务"}]取得または入力方法: 実際のログフィールドから主要な表示フィールドを選択します。 |
|
| extend.extendFields[*] | json | tag/alias キーのみ許可します。 例: {"tag": "service", "alias": "服务"}取得または入力方法: フィールドキーおよび表示エイリアスに従って入力します。 |
|
| extend.extendFields[*].tag | string | 条件付きで空でないキーが必須です。 例: service取得または入力方法: 実際のログフィールド名です。 |
|
| extend.extendFields[*].alias | string | 任意の表示エイリアスです。 例: 服务取得または入力方法: 業務上の表示名です。省略できます。 |
|
| extend.topFields | array | 任意の表示設定です。同じ tag/alias オブジェクトで使用します。通常の modify は独立したピン留めインターフェースではありません。 例: [{"tag": "host", "alias": "主机"}]取得または入力方法: コンソールのピン留めフィールドリストを保持します。 |
|
| extend.topFields[*] | json | 単一の表示フィールドオブジェクトです。 例: {"tag": "host", "alias": "主机"}取得または入力方法: 既存のリストに基づいて設定します。 |
|
| extend.topFields[*].tag | string | フィールドキーです。 例: host取得または入力方法: 実際のフィールド名です。 |
|
| extend.topFields[*].alias | string | 任意のエイリアスです。 例: 主机取得または入力方法: 表示エイリアスです。 |
|
| extend.services | array | 任意のエコー情報です。filters の実際のマッチ条件の代わりにはなりません。 例: ["checkout-api"]取得または入力方法: コンソールの関連サービス表示設定を保持します。 |
|
| extend.services[*] | string | 単一のサービス表示値です。 例: checkout-api取得または入力方法: 実際のサービス名です。 |
|
| desc | string | 任意の説明です。最大 1024 文字です。通常の modify では省略時は保持され、空文字列でクリアされます。外部バインディングの変更では省略するとクリアされます。 空文字列を許可: True null を許可: False 最大長: 1024 例: 生产服务日志。取得または入力方法: 用途、ソース、保守責任の説明を入力します。 |
|
| directIndex | boolean | 任意です。新規作成時のデフォルトは false です。直接書き込みでは通常マッチの順序に従って振り分けません。通常の modify にはこのフィールドがなく、インポート recover でも既存のインデックスモードは変換されません。 null を許可: False 例: false取得または入力方法: 通常マッチで振り分けるインデックスは false、インデックス名で直接書き込むネイティブ直接書き込みインデックスは true です。 |
|
| duration | string | 通常の新規作成では省略時のデフォルトは通常 3d です。非 TLS ストレージでは、pay はデフォルトで 3d/7d/14d/30d/60d/90d を許可し、enterprise/unlimited はデフォルトで 1d から 1800d までを許可します。詳細はサイト設定に従います。modify で省略した場合は保持されます。TLS では setting を参照し、このフィールドで実際の期間を制御しません。 null を許可: False 例: 7d取得または入力方法: 現在のワークスペースのバージョンとログストレージに応じて標準保持日数を選択し、整数+d を使用します。 |
|
| extend | json | 任意の拡張オブジェクトです。実際のマッチおよび表示設定を含みます。通常の modify では第一階層のキーでマージし、未指定のキーは保持され、配列またはネストしたオブジェクトは全体置換されます。{} は既存の filters をクリアしません。null を避けてください。一部の変更分岐では 500 になります。インポート recover では extend 全体を置換します。 null を許可: True 例: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}取得または入力方法: マッチ条件は実際のログフィールドと値から構築します。その他の表示設定は元の詳細から保持します。 |
|
| isFullLineIndex | int | 0/1 またはブール値のみ受け付けます。scopedb の新規作成では省略時のデフォルトは 1 で、0 は許可されません。既存の Message は 0→1 に変更できますが、1→0 にはできません。切り替えると message フィールドインデックスも同期され、元に戻せません。modify で省略した場合は保持されます。 null を許可: False 例: 1取得または入力方法: scopedb ログの新規作成では 1/true が必須で、その他のログストレージでは 0/false を保持します。 |
|
| name | string | Y | 新規作成では必須です。宣言上は最大 256 文字ですが、実際の保存列は 128 であるため、128 文字以内を推奨します。ES ログストレージではハイフンを許可しません。default 予約名や他のインデックス UUID を使用しないでください。通常のインデックスは modify で名前を変更できません。 null を許可: False 最大長: 256 例: production_logs取得または入力方法: 業務に沿って命名し、まずログインデックス一覧で本ワークスペースの使用済み名を確認します。 |
| setting | json | TLS の新規作成では hot_retention を必ず指定します。合計 duration は 3 つの時間数の合計を日数に換算します。通常の変更で setting を指定する場合は、ホットストレージと必要なステージを完全に指定し、cold_retention だけを渡さないでください。その他のストレージではこのフィールドを TLS として解釈しません。 null を許可: False 例: {"hot_retention": 168}取得または入力方法: ワークスペースのログストレージが volctls の場合のみ、標準/低頻度/アーカイブ保持を設定します。数値の単位は時間です。 |
|
| setting.archive_retention | int | 任意です。デフォルトは 60..1800 日で、1 日単位の時間数である必要があります。ホットストレージは少なくとも 30 日で、合計は 1800 日を超えてはなりません。 null を許可: False 例: 1440取得または入力方法: アーカイブ日数×24(例: 60 日 = 1440 時間)。このステージを有効にしない場合は省略します。 |
|
| setting.cold_retention | int | 任意です。デフォルトは 30..1800 日で、1 日単位の時間数である必要があります。0 は省略を表すため使用しません。合計は 1800 日を超えてはなりません。 null を許可: False 例: 720取得または入力方法: 低頻度ストレージ日数×24(例: 30 日 = 720 時間)。このステージを有効にしない場合は省略します。 |
|
| setting.hot_retention | int | TLS では条件付き必須です。デフォルト範囲は 1 から 1800 日で、24..43200 時間に対応し、24 の倍数である必要があります。コールドストレージを使用する場合、ホットストレージは少なくとも 7 日、アーカイブを使用する場合は少なくとも 30 日必要です。 null を許可: False 例: 168取得または入力方法: 日数×24 で入力します(例: 7 日 = 168 時間)。 |
|
| storagePolicy | json | 任意の完全な長期ポリシーオブジェクトです。通常の新規作成では省略時は {} です。変更で省略した場合は保持され、{} は無効に正規化され、明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きくする必要があり、単位は引き続き日です。 null を許可: False 例: {"longStorageEnabled": false}取得または入力方法: ログストレージが scopedb で、バージョンが pay/enterprise/unlimited の場合にのみ長期ストレージを有効にできます。まずワークスペースの機能を確認してください。 |
パラメータ補足説明¶
1. リクエストパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | String | 必須 | インデックス名 |
| desc | String | インデックス説明 | |
| extend | Json | フロントエンド表示用の拡張情報 | |
| duration | Json | インデックスの総保存期間、例: 60d | |
| directIndex | Boolean | ネイティブ直接書き込みインデックス、デフォルト false、2025-06-25 のイテレーションで追加 | |
| setting | Json | ログが Volcengine ストレージの場合のインデックス設定情報 |
2. setting 内のパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| hot_retention | int | 必須 | 標準ストレージ - ホットデータ、1 日単位の時間数である必要があります。単位: 時間 h |
| cold_retention | int | 低頻度ストレージ - コールドデータ、1 日単位の時間数である必要があります。単位: 時間 h | |
| archive_retention | int | アーカイブストレージ - アーカイブデータ、1 日単位の時間数である必要があります。単位: 時間 h |
2.1 Volcengine ストレージの期間制限:
標準ストレージ: ホットデータストレージです。データ範囲: 1-1800 日。低頻度ストレージがある場合、データ範囲: 7-1800 日。アーカイブストレージがある場合、データ範囲: 30-1800 日。
低頻度ストレージ: コールドデータストレージです。データ範囲: 30-1800 日。
アーカイブストレージ: アーカイブデータなどのストレージです。データ範囲: 60-1800 日。
2.2 Volcengine ストレージの期間制限:
総保存期間(標準ストレージ + 低頻度ストレージ + アーカイブストレージ)は 1800 日を超えてはなりません。
3. extend 内のパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| matchMode | String | マッチモード。指定可能な値: basic、advanced。省略時は basic として処理します |
|
| filters | Array[dict] | 通常マッチのフィルタ条件リストです。ネイティブ直接書き込みインデックスでは設定不要です。advanced モードでは空配列を渡すことを推奨します |
|
| advancedFilter | Dict | 高度なマッチ条件ツリーです。matchMode=advanced 時に有効になります |
|
| extendFields | Array | インデックス拡張フィールド情報 | |
| extendFields[*].tag | String | 必須 | 主要フィールド名 |
| extendFields[*].alias | String | 主要フィールドのエイリアス | |
| services | String | マッチ対象サービス |
4. extend.filters の基本構造の説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| condition | string | 直前のフィルタ条件との関係。指定可能な値: and、or。デフォルト値: and |
|
| name | string | フィルタ対象のフィールド名 | |
| operation | string | 演算子。指定可能な値: in、not_in |
|
| value | array | 値リスト | |
| value[#] | string/int/boolean | 文字列/数値/ブール値を指定可能 |
5. extend.advancedFilter の基本構造の説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| type | string | 必須 | ルートノードは固定で group |
| condition | string | 必須 | 現在のグループ内の子ノード関係。指定可能な値: and、or |
| filters | array | 必須 | 子ノードリスト。要素は rule または group |
| filters[#].type | string | 必須 | ノードタイプ。指定可能な値: rule、group |
| filters[#].name | string | rule 必須 | ログフィールド名 |
| filters[#].operation | string | rule 必須 | 演算子。指定可能な値: =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist |
| filters[#].value | array | rule 必須 | 値リスト。exist / not_exist では空配列を使用 |
matchMode=advanced の場合、バックエンドは DQL where スタイルで conditions を生成します。例: IN、NOT IN、= match('xxx')、= wildcard('xxx')。通常の filters は従来の生成形式を維持します。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"production_logs","desc":"生产服务日志。","duration":"7d","directIndex":false,"isFullLineIndex":1,"extend":{"matchMode":"basic","filters":[{"name":"env","condition":"and","operation":"=","value":["production"]}]}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | データベースレコード番号です。新規作成の送信前スナップショットでは null の可能性があります。操作には uuid を使用します。 |
| content.uuid | string | lgim_ インデックス設定 UUID です。デフォルトインデックスでは default を使用します。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.sourceIndexUUID | string | クローンインデックス B のソース A UUID です。通常のインデックスでは空です。 |
| content.name | string | インデックス名。 |
| content.desc | string | 説明。 |
| content.conditions | string | extend に基づいて生成される実際の条件文字列です。通常のリクエストでこのフィールドを直接変更しないでください。 |
| content.sortNo | integer または string | マッチ順序識別子です。ネイティブ直接書き込みまたはクローンでは通常 0 です。 |
| content.duration | string | 標準ストレージ期間です。TLS ではコールド/ホット/アーカイブの合計日数です。 |
| content.isBindCustomStore | integer または boolean | 1/true は外部ストレージにバインドされます。 |
| content.directIndex | integer または boolean | 1/true はネイティブ直接書き込みです。 |
| content.isFullLineIndex | integer | 1 は全行、0 は Message です。 |
| content.queryType | string | クエリ種別です。例: logging/standard、または外部 SLS が返すモード。 |
| content.exterStoreProject | string | 外部プロジェクト/データベース識別子です。内部インデックスでは通常空です。 |
| content.exterStoreName | string | 外部リソース名です。内部では通常空です。 |
| content.externalResourceAccessCfgUUID | string | アクセス設定識別子です。資格情報の原文ではありません。 |
| content.storeType | string | 内部インデックスでは通常空です。外部にバインドした場合は実際の型になります。 |
| content.region | string | 外部リージョンコード。 |
| content.isPublicNetworkAccess | integer または boolean | パブリックネットワークアクセスのフラグ。 |
| content.status | integer | 0 有効、2 無効、3 削除。 |
| content.creator | string | 作成者。 |
| content.updator | string | 最終更新者。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.storagePolicy | object | 任意の完全な長期ポリシーオブジェクトです。通常の新規作成では省略時は {} です。変更で省略した場合は保持され、{} は無効に正規化され、明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きくする必要があり、単位は引き続き日です。 |
| content.storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合はデフォルト false です。無効にすると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 |
| content.storagePolicy.longStorageDuration | string | 有効時は条件付き必須です。値は d を含む文字列であり、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 |
| content.setting | object | 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 日で、1 日単位の時間数である必要があります。0 は省略を表すため使用しません。合計は 1800 日を超えてはなりません。 |
| content.setting.archive_retention | integer | 任意です。デフォルトは 60..1800 日で、1 日単位の時間数である必要があります。ホットストレージは少なくとも 30 日で、合計は 1800 日を超えてはなりません。 |
| content.extend | object | 任意の拡張オブジェクトです。実際のマッチおよび表示設定を含みます。通常の 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.cloneConfig | object または null | ソース A に関連するクローン B の完全なエンティティです。存在しない場合は null です。クローン自体のレスポンスには必ずしもこのキーが含まれるわけではありません。 |
| content.cloneConfig.id | integer または null | データベースレコード番号です。新規作成の送信前スナップショットでは null の可能性があります。操作には uuid を使用します。 |
| content.cloneConfig.uuid | string | lgim_ インデックス設定 UUID です。デフォルトインデックスでは default を使用します。 |
| content.cloneConfig.workspaceUUID | string | 所属ワークスペース。 |
| content.cloneConfig.sourceIndexUUID | string | クローンインデックス B のソース A UUID です。通常のインデックスでは空です。 |
| content.cloneConfig.name | string | インデックス名。 |
| content.cloneConfig.desc | string | 説明。 |
| content.cloneConfig.conditions | string | extend に基づいて生成される実際の条件文字列です。通常のリクエストでこのフィールドを直接変更しないでください。 |
| content.cloneConfig.sortNo | integer または string | マッチ順序識別子です。ネイティブ直接書き込みまたはクローンでは通常 0 です。 |
| content.cloneConfig.duration | string | 標準ストレージ期間です。TLS ではコールド/ホット/アーカイブの合計日数です。 |
| content.cloneConfig.isBindCustomStore | integer または boolean | 1/true は外部ストレージにバインドされます。 |
| content.cloneConfig.directIndex | integer または boolean | 1/true はネイティブ直接書き込みです。 |
| content.cloneConfig.isFullLineIndex | integer | 1 は全行、0 は Message です。 |
| content.cloneConfig.queryType | string | クエリ種別です。例: logging/standard、または外部 SLS が返すモード。 |
| content.cloneConfig.exterStoreProject | string | 外部プロジェクト/データベース識別子です。内部インデックスでは通常空です。 |
| content.cloneConfig.exterStoreName | string | 外部リソース名です。内部では通常空です。 |
| content.cloneConfig.externalResourceAccessCfgUUID | string | アクセス設定識別子です。資格情報の原文ではありません。 |
| content.cloneConfig.storeType | string | 内部インデックスでは通常空です。外部にバインドした場合は実際の型になります。 |
| content.cloneConfig.region | string | 外部リージョンコード。 |
| content.cloneConfig.isPublicNetworkAccess | integer または boolean | パブリックネットワークアクセスのフラグ。 |
| content.cloneConfig.status | integer | 0 有効、2 無効、3 削除。 |
| content.cloneConfig.creator | string | 作成者。 |
| content.cloneConfig.updator | string | 最終更新者。 |
| content.cloneConfig.createAt | integer | 作成 Unix 秒。 |
| content.cloneConfig.updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.cloneConfig.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.cloneConfig.storagePolicy | object | 任意の完全な長期ポリシーオブジェクトです。通常の新規作成では省略時は {} です。変更で省略した場合は保持され、{} は無効に正規化され、明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きくする必要があり、単位は引き続き日です。 |
| content.cloneConfig.storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略した場合はデフォルト false です。無効にすると longStorageDuration は空に正規化されますが、履歴データが直ちに削除されるわけではありません。 |
| content.cloneConfig.storagePolicy.longStorageDuration | string | 有効時は条件付き必須です。値は d を含む文字列であり、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 |
| content.cloneConfig.setting | object | 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 日で、1 日単位の時間数である必要があります。0 は省略を表すため使用しません。合計は 1800 日を超えてはなりません。 |
| content.cloneConfig.setting.archive_retention | integer | 任意です。デフォルトは 60..1800 日で、1 日単位の時間数である必要があります。ホットストレージは少なくとも 30 日で、合計は 1800 日を超えてはなりません。 |
| content.cloneConfig.extend | object | 任意の拡張オブジェクトです。実際のマッチおよび表示設定を含みます。通常の modify では第一階層のキーでマージし、未指定のキーは保持され、配列またはネストしたオブジェクトは全体置換されます。{} は既存の filters をクリアしません。null を避けてください。一部の変更分岐では 500 になります。インポート recover では extend 全体を置換します。 |
| 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.declaration | object | ワークスペースの共通宣言です。単一エンティティのレスポンスに付加されます。 |
{
"code": 200,
"content": {
"id": null,
"uuid": "lgim_example",
"workspaceUUID": "wksp_example",
"sourceIndexUUID": "",
"name": "production_logs",
"desc": "生产服务日志。",
"duration": "7d",
"directIndex": false,
"isFullLineIndex": 1,
"extend": {
"matchMode": "basic",
"filters": [
{
"name": "env",
"condition": "and",
"operation": "=",
"value": [
"production"
]
}
]
},
"conditions": "{ `env` = 'production' }",
"sortNo": 1,
"isBindCustomStore": 0,
"queryType": "logging",
"exterStoreProject": "",
"exterStoreName": "",
"externalResourceAccessCfgUUID": "",
"storeType": "",
"region": "",
"isPublicNetworkAccess": 0,
"setting": {},
"storagePolicy": {},
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"cloneConfig": null,
"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 オブジェクトを使用します。 |
| 429 | ft.OperationTooFrequently | 同一ワークスペースのストレージ書き込み/インデックス関係の同時操作、またはロックリースの失効 | 操作が頻繁すぎます。しばらくしてから再試行してください | 進行中の操作が完了するまで待ってからバックオフして再試行し、まず現在の状態を照会します。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、下流接続/通常の 5xx、またはフィールド形状の異常 | 内部エラーです | まず設定を読み取り、実際のストレージの現在の状態を確認します。継続的に失敗する場合は traceId を提供してください。エラーを未保存とみなしたり、そのまま重複して新規作成したりしないでください。 |
| 406 | ft.InvalidDuration | 保持文字列の形式、または現在のバージョンで許可される段階と一致しない | 無効な duration です | 整数+d を使用し、バージョンごとの選択可能な期間を確認します。 |
| 406 | ft.InvalidDurationRange | 標準/長期保持が範囲を超えている、または長期が標準期間以下 | 有効なデータ保持期間の範囲を超えています | 2 つの期間と現在のワークスペースの機能を確認します。 |
| 400 | ft.InvalidActionForbiddenChange | バージョンまたはログストレージタイプが長期ポリシーの有効化を許可していない | インデックス統合状態スイッチの変更は禁止されています | サポートされているバージョンと scopedb ログでのみ有効化します。 |
| 406 | ft.CurrentVersionUnsupportRp | 現在のバージョンがストレージポリシーの変更をサポートしていない | 現在のバージョンはrp:{}をサポートしていません |
管理者がワークスペースのバージョン機能を確認します。 |
| 404 | ft.MissingVolctlsHotRetention | TLS setting にゼロ以外の hot_retention がない | Volcengine ストレージで標準ストレージ(ホットストレージ)フィールドがありません | ホットストレージの時間数と、必要なコールド/ホット/アーカイブフィールドを完全に指定します。 |
| 400 | ft.InvalidHotRetention | TLS のホット期間が 1 日単位の時間数でない | Volcengine ストレージでホットデータ保存期間が無効です。1 日単位の時間数である必要があります | 日数×24 を使用します。 |
| 400 | ft.InvalidRetention | TLS のいずれかのステージ期間が範囲外 | Volcengine ストレージで {} の保存期間が無効です。範囲は {} 日です | 本ページのコールド/ホット/アーカイブ範囲に従って時間数を入力します。 |
| 400 | ft.InvalidRetentionFullDayhours | コールド/アーカイブが 1 日単位の時間数でない | Volcengine ストレージで {} の保存期間が無効です。1 日単位の時間数である必要があります | 24 の整数倍を使用します。 |
| 400 | ft.InvalidColdRententionHot | コールドストレージがある場合にホットステージが 7 日未満 | ストレージエンジンに低頻度ストレージが存在する場合、標準ストレージは {} 日以上である必要があります | ホットステージは少なくとも 168 時間です。 |
| 400 | ft.InvalidArchiveRententionHot | アーカイブがある場合にホットステージが 30 日未満 | ストレージエンジンにアーカイブストレージが存在する場合、標準ストレージは {} 日以上である必要があります | ホットステージは少なくとも 720 時間です。 |
| 400 | ft.InvalidAllRetention | TLS の総保持期間が許可範囲を超えている | Volcengine ストレージで総保存期間が無効です。範囲は {} 日です | 合計が 1800 日に対応する 43200 時間を超えないようにします。 |
| 406 | ft.InvalidParameter | advanced ノードの型、構造、値配列、または論理関係のエラー | パラメータ{}が無効です |
group/rule 構造を使用します。存在系以外の value 配列は空にしません。 |
| 406 | ft.InvalidOperationSymbol | フィルタ演算子がサポートされていない | 無効な演算子{}です |
basic/advanced の対応する演算を選択します。 |
| 400 | ft.SpecialCharactersExist | フィールド名または正規表現に許可されないバッククォートが存在 | 演算子の左側に特殊文字が存在します | 実際のフィールドまたは正規表現値を渡し、人為的にバッククォートを追加しません。 |
| 406 | ft.UnsupportRuleType | basic 条件で operation=match/not match を使用 | サポートされていないルールタイプ:{}です |
サポートされている basic 条件を使用するか、advanced に切り替えます。 |
| 400 | ft.NotEnabledLogIndexCfg | ワークスペースでマルチインデックスが有効化されていない | ワークスペースでログマルチインデックスが有効化されていないか、既に無効化されています | 管理者が有効化し、ワークスペースのサポートを確認します。 |
| 400 | ft.ForIndexCfgNameExists | 現在のワークスペースに削除されていない同名インデックスが既に存在 | 指定されたインデックス設定名は既に存在します | 一意の名前に変更します。 |
| 400 | ft.LogIndexCfgQuantityExceedsMaximumValue | 内部インデックス/クローン数がワークスペースのクォータを超過 | カスタムログインデックス設定数が最大値 {} を超えています | 既存のインデックスを確認してから構成またはクォータを調整します。無効化してもクォータは解放されません。 |
| 400 | ft.InvalidLogIndexName | ES ログストレージの新規名にハイフンが含まれる | 無効なインデックス名です | ハイフンを含まない名前に変更します。 |
| 403 | ft.Forbidden | 権限不足、または現在のバージョンがこのインターフェースを許可していない | 操作する権限がありません | 対応するインデックス権限を持つ API Key とサポート対象バージョンを使用します。 |