コンテンツにスキップ

デフォルトタイプのインデックス設定を変更する



POST /api/v1/log_index_cfg/{cfg_uuid}/modify

概要

内部ログインデックスのマッチング、保持、表示設定を変更します。

呼び出し前の確認と使用手順

まず詳細を取得して既存設定をバックアップし、必要に応じて説明、マッチング条件、標準/長期保持、TLS ステージ、または全行モードを変更します。通常のインデックスでは、省略したフィールドは保持されます。extend は最上位のキーでマージされ、通常マッチングをクリアするには明示的に filters=[] を指定してください。{} を渡しても既存の filters はクリアされません。配列/ネストしたオブジェクトは対応するキーごとに全体置換されるため、extend=null は避けてください。インデックス名と directIndex はこの変更の Body には含まれません。

特殊な cfg_uuid=default では extend と isFullLineIndex のみを保存し、desc/duration/storagePolicy/setting はこの分岐で通常インデックスの保持設定として扱われません。成功レスポンスからデフォルトインデックスの保持期間が変更されたと推測しないでください。scopedb の 0→1 の全行モード切り替えは不可逆であり、ソース A のアップグレード時には既存の B も同時にアップグレードされます。B 自身の公開・編集可能な設定は直接調整できますが、この Body で B の名前やソースを変更したり、別の B を作成したりしないでください。

ストレージ設定、実際のダウンストリーム操作、データベースへのコミットは同一のアトミックなステップではありません。エラー/タイムアウトが発生した場合は、まず一覧と詳細で現在の設定を確認し、次にストレージの実際の状態を確認してください。すぐに新規作成を繰り返さないでください。インデックスの作成に成功しても、物理インデックスが作成済みであることやデータが存在することを保証するものではありません。保持期間を短縮する前に、データ保持要件を確認してください。

default のレスポンスは合成オブジェクトであり、そのデフォルトインデックスのフィールドおよび workspaceName/workspaceStatus のみが保証されます。通常エンティティの id、desc、creator、updator、setting、cloneConfig などの存在は保証されません。

ルートパラメータ

パラメータ名 型 必須 説明
cfg_uuid string Y パス設定 UUID であり、インデックス名ではありません。デフォルトインデックスは一部の変更のみ可能です。使用方法を参照してください。
例: lgim_example
取得または入力方法: ログインデックス一覧 の content.data[].uuid から本ワークスペースの設定を取得します。デフォルトインデックスは default を使用します。

リクエストヘッダー

パラメータ名 型 必須 説明
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
例: 生产服务日志。
取得または入力方法: 用途、ソース、保守責任の説明を入力します。
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 を保持します。
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 の場合にのみ長期ストレージを有効化できます。まずワークスペースの機能を確認してください。

パラメータ補足説明

extend 内のマッチング条件の説明

パラメータ名 type 必須 説明
matchMode String マッチングモードです。選択可能な値: basic、advanced。省略時は basic として処理されます。
filters Array[dict] 通常マッチングのフィルター条件一覧です。advanced モードでは空配列を渡すことを推奨します。
advancedFilter Dict 高度なマッチング条件ツリーです。matchMode=advanced 時に有効になります。

advancedFilter のルートノードは固定で group となり、group.filters 内に rule または group をネストできます。rule.operation の選択可能な値: =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist。value は統一して配列とし、exist / not_exist では空配列を使用します。matchMode=advanced の場合、バックエンドは DQL where スタイルで conditions を生成します。通常の filters は引き続き従来の生成形式を維持します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"desc":"生产服务日志已更新。","duration":"14d","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 作成者 ID。
content.updator string 最終更新者 ID。
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 作成者 ID。
content.cloneConfig.updator string 最終更新者 ID。
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 ワークスペースの共通宣言です。単一エンティティのレスポンスに付加されます。
content.workspaceName string default の合成レスポンスにのみ含まれるワークスペース名です。
content.workspaceStatus integer default の合成レスポンスにのみ含まれるワークスペースステータスです。
{
  "code": 200,
  "content": {
    "id": 100,
    "uuid": "lgim_example",
    "workspaceUUID": "wksp_example",
    "sourceIndexUUID": "",
    "name": "production_logs",
    "desc": "生产服务日志已更新。",
    "duration": "14d",
    "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": 1785427300,
    "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.InvalidLogIndexCfgKeyFields extendFields が配列でない、項目に tag がない、または tag/alias 以外のキーを含む 不正なログインデックスキーフィールドです 本ページの tag/alias 構造を使用してください。
404 ft.LogIndexCfgNoExists 現在のワークスペース設定が存在しない、または削除済み 指定されたログインデックス設定が存在しません 一覧から有効な UUID を再取得してください。
400 ft.LogIndexCloneRelationInvalid クローンとソースの関係が失効、または同時変更 ログインデックスのクローン関係が無効です A/B の設定を更新してから操作してください。
400 ft.LogIndexCloneSourceUnsupported ソースの状態または種別がクローン要件を満たさない 指定されたログインデックスはクローンソースとしてサポートされていません ソースがデフォルト以外、直接書き込み以外、バインドされていない通常の内部インデックスであることを確認してください。
403 ft.Forbidden 権限不足、または現在のバージョンでこのインターフェースが許可されていない 操作権限がありません 対応するインデックス権限を持つ API Key とサポートバージョンを使用してください。

フィードバック

このページは役に立ちましたか?