Create Default Type Index¶

POST /api/v1/log_index_cfg/add

Overview¶

Create a default storage type index configuration.

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Index name Example: xxx Allow empty: False Max length: 256
desc	string		Index description Example: xxx Allow empty: False Allow empty string: True Max length: 1024
extend	json		Frontend custom data Allow empty: True
duration	string		Data retention period Allow empty: False Example: 7d
directIndex	boolean		Native direct-write index, default false, added in 2025-06-25 iteration Allow empty: False
setting	json		Related configuration information Allow empty: False
setting.hot_retention	int		Volcengine storage, Standard storage - Hot storage Allow empty: False
setting.cold_retention	int		Volcengine storage, Infrequent Access storage - Cold data Allow empty: False
setting.archive_retention	int		Volcengine storage, Archive storage - Archive data Allow empty: False

Parameter Supplementary Description¶

1. Request Parameter Description

Parameter Name	type	Required	Description
name	String	Required	Index name
desc	String		Index description
extend	Json		Extended information for frontend display
duration	Json		Total index storage duration, example: 60d
directIndex	Boolean		Native direct-write index, default false, added in 2025-06-25 iteration
setting	Json		Index configuration information when logs use Volcengine storage

2. Parameter Description in setting

Parameter Name	type	Required	Description
hot_retention	int	Required	Standard storage - Hot data, must be a whole number of days in hours. Unit: hour h
cold_retention	int		Infrequent Access storage - Cold data, must be a whole number of days in hours. Unit: hour h
archive_retention	int		Archive storage - Archive data, must be a whole number of days in hours. Unit: hour h

2.1. Volcengine Storage Duration Limits:
Standard storage: i.e., hot data storage, data range: 1-1800 days. If Infrequent Access storage exists, data range: 7-1800 days; if Archive storage exists, data range: 30-1800 days.
Infrequent Access storage: Cold data storage, data range: 30-1800 days.
Archive storage: i.e., archive data storage, data range: 60-1800 days.
2.2. Volcengine Storage Duration Limits:
Total storage duration (Standard storage + Infrequent Access storage + Archive storage) cannot exceed 1800 days.

3. Parameter Description in extend

Parameter Name	type	Required	Description
filters	Array[dict]		Filter condition list, native direct-write index does not require configuration
extendFields	Array		Index extended field information
extendFields[*].tag	String	Yes	Key field name
extendFields[*].alias	String		Key field alias
services	String		Matching services

4. Main Structure Description of extend.filters

Parameter Name	type	Description
condition	string	Relationship with the previous filter condition, optional values: `and`, `or`; default value: `and`
name	string	Field name to filter
operation	string	Operator, optional values: `in`, `not_in`
value	array	Value list
value[#]	string/int/boolean	Can be string/numeric/boolean type

Request Example¶

curl 'https://openapi.truewatch.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","extend":{"filters":[{"condition":"and","name":"host","operation":"in","value":["custom_host1"]}]}}' \
--compressed

Response¶

{
    "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,
        "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"
}