コンテンツにスキップ

デフォルトタイプインデックスの作成


POST /api/v1/log_index_cfg/add

概要

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
name string Y インデックス名
例: xxx
空を許可: False
最大長: 256
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
directIndex boolean ネイティブ直接書き込みインデックス。デフォルト false。2025-06-25 イテレーションで追加。
空を許可: False
isFullLineIndex int 全行インデックスかどうか。0/false は message フィールドインデックスを保持、1/true は全行インデックス。デフォルト 0。ログストレージが scopedb のワークスペースのみ 1 に設定可能。
空を許可: False
setting json 関連設定情報
空を許可: False
setting.hot_retention int Volcengine ストレージ、標準ストレージ - ホットデータ
空を許可: False
setting.cold_retention int Volcengine ストレージ、低頻度ストレージ - コールドデータ
空を許可: False
setting.archive_retention int Volcengine ストレージ、アーカイブストレージ - アーカイブデータ
空を許可: False

パラメータ補足説明

1. リクエストパラメータ説明

パラメータ名 型 必須 説明
name String 必須 インデックス名
desc String インデックスの説明
extend Json フロントエンド表示用の拡張情報
duration Json インデックスの総保持期間。例: 60d
directIndex Boolean ネイティブ直接書き込みインデックス。デフォルト false。2025-06-25 イテレーションで追加。
setting Json ログが Volcengine ストレージの場合のインデックス設定情報

2. setting 内のパラメータ説明

パラメータ名 型 必須 説明
hot_retention int 必須 標準ストレージ - ホットデータ。全日単位の時間数。単位: 時間 h
cold_retention int 低頻度ストレージ - コールドデータ。全日単位の時間数。単位: 時間 h
archive_retention int アーカイブストレージ - アーカイブデータ。全日単位の時間数。単位: 時間 h

2.1、Volcengine ストレージ期間制限：
標準ストレージ：ホットデータストレージ。データ範囲：1～1800 日。低頻度ストレージがある場合、データ範囲：7～1800 日。アーカイブストレージがある場合、データ範囲：30～1800 日。
低頻度ストレージ：コールドデータストレージ。データ範囲：30～1800 日。
アーカイブストレージ：アーカイブデータ等のストレージ。データ範囲：60～1800 日。
2.2、Volcengine ストレージ期間制限：
総保持期間（標準ストレージ + 低頻度ストレージ + アーカイブストレージ）は 1800 日を超えることはできません。

3. extend 内のパラメータ説明

パラメータ名 型 必須 説明
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 の基本構造説明

パラメータ名 型 必須 説明
condition string 前のフィルター条件との関係。選択可能な値：and、or。デフォルト値：and。
name string フィルター対象のフィールド名。
operation string 演算子。選択可能な値：in、not_in。
value array 値のリスト。
value[#] string/int/boolean 文字列、数値、またはブール型。

5. extend.advancedFilter の基本構造説明

パラメータ名 型 必須 説明
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 'https://openapi.guance.com/api/v1/log_index_cfg/add' \
-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 '{"name":"test_index","duration":"14d","isFullLineIndex":0,"extend":{"filters":[{"condition":"and","name":"host","operation":"in","value":["custom_host1"]}]}}' \
--compressed

レスポンス

{
    "code": 200,
    "content": {
        "conditions": "{  `host` in [ 'custom_host1' ] }",
        "createAt": 1698751853,
        "creator": "xxx",
        "deleteAt": -1,
        "duration": "14d",
        "extend": {
            "filters": [
                {
                    "condition": "and",
                    "name": "host",
                    "operation": "in",
                    "value": [
                        "custom_host1"
                    ]
                }
            ]
        },
        "exterStoreName": "",
        "exterStoreProject": "",
        "externalResourceAccessCfgUUID": "",
        "id": null,
        "isBindCustomStore": 0,
        "isFullLineIndex": 0,
        "isPublicNetworkAccess": 0,
        "name": "test_index",
        "queryType": "logging",
        "region": "",
        "setting": {},
        "sortNo": 3,
        "status": 0,
        "storeType": "",
        "updateAt": 1698751853,
        "updator": "xxx",
        "uuid": "lgim_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-600346C3-6C89-4391-9CA3-2152D10149D8"
}

フィードバック

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