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

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

概要¶

デフォルトのストレージタイプのインデックス設定を変更します。

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
cfg_uuid	string	Y	設定 uuid

Body リクエストパラメータ¶

パラメータ名	タイプ	説明
desc	string	インデックスの説明例: xxx 空の許可: False 空文字列の許可: True 最大長: 1024
extend	json	フロントエンドのカスタムデータ空の許可: True
duration	string	データ保持期間空の許可: False 例: 7d
storagePolicy	json	長期保存ポリシー。ログが scopedb ストレージのみに保存されるワークスペースでのみ有効化できます。pay、enterprise、unlimited はログの長期保存に対応しています。enterprise/unlimited の logging は最大 1800d です。enterprise/unlimited の rp はカスタム長期保存期間（最大 3600d）をサポートしています。unlimited は BossAccountSet が有効な場合、metric_point_total 課金タイプのみサポートされ、無効な場合は metric_point_total として処理されます。longStorageEnabled と longStorageDuration を含みます例: {'longStorageEnabled': True, 'longStorageDuration': '180d'} 空の許可: False
isFullLineIndex	int	全行インデックスかどうか。整数 0/1 またはブール値 false/true をサポートします。既存の Scopedb Message インデックスは 0/false から 1/true に切り替えられますが、この切り替えは元に戻せません。未指定の場合は元の設定を保持します空の許可: False
setting	json	関連設定情報空の許可: False
setting.hot_retention	int	Volcengine ストレージ、標準ストレージ - ホットストレージ空の許可: False
setting.cold_retention	int	Volcengine ストレージ、低頻度ストレージ - コールドデータ空の許可: False
setting.archive_retention	int	Volcengine ストレージ、アーカイブストレージ - アーカイブデータ空の許可: False

パラメータ補足説明¶

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 '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"
}