デフォルトタイプのインデックス設定を変更¶
POST /api/v1/log_index_cfg/{cfg_uuid}/modify
概要¶
デフォルトのストレージタイプのインデックス設定を変更します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | はい | 設定 UUID |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| desc | string | いいえ | インデックスの説明 例: xxx 空を許可: いいえ 空文字列を許可: はい 最大長: 1024 |
| extend | json | いいえ | フロントエンドカスタムデータ 空を許可: はい |
| duration | string | いいえ | データ保持期間 空を許可: いいえ 例: 7d |
| storagePolicy | json | いいえ | 長期ストレージポリシー。ログは scopedb ストレージのワークスペースのみ有効。pay、enterprise、unlimited はログの長期ストレージをサポート。enterprise/unlimited の logging は最大 1800 日。enterprise/unlimited の rp はカスタム長期ストレージ期間(最大 3600 日)をサポート。unlimited は BossAccountSet 有効時、metric_point_total 課金タイプのみサポート。無効時は metric_point_total として処理。longStorageEnabled と longStorageDuration を含む。 例: {'longStorageEnabled': True, 'longStorageDuration': '180d'} 空を許可: いいえ |
| isFullLineIndex | int | いいえ | 全文インデックスかどうか。0/false は message フィールドのインデックスを保持、1/true は全文インデックス。デフォルトは 0。ログストレージが scopedb のワークスペースのみ 1 に設定可能。 空を許可: いいえ |
| setting | json | いいえ | 関連設定情報 空を許可: いいえ |
| setting.hot_retention | int | いいえ | Volcengine ストレージ、標準ストレージ - ホットストレージ 空を許可: いいえ |
| setting.cold_retention | int | いいえ | Volcengine ストレージ、低頻度ストレージ - コールドデータ 空を許可: いいえ |
| setting.archive_retention | int | いいえ | Volcengine ストレージ、アーカイブストレージ - アーカイブデータ 空を許可: いいえ |
パラメータ補足説明¶
extend 内のマッチ条件について
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_xxxx32/modify' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"duration":"7d","isFullLineIndex":1,"extend":{"filters":[{"condition":"and","name":"host","operation":"in","value":["guance"]}]}}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"conditions": "{ `host` in [ 'guance' ] }",
"createAt": 1698751853,
"creator": "xxx",
"deleteAt": -1,
"duration": "7d",
"extend": {
"filters": [
{
"condition": "and",
"name": "host",
"operation": "in",
"value": [
"guance"
]
}
]
},
"exterStoreName": "",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "",
"id": 1376,
"isBindCustomStore": 0,
"isFullLineIndex": 1,
"isPublicNetworkAccess": 0,
"name": "test_index",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 3,
"status": 0,
"storeType": "",
"updateAt": 1698752013.27368,
"updator": "xx",
"uuid": "lgim_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-09F7E56D-1DE5-48C9-A77A-108A53462A75"
}