Create a Single Index Configuration¶

POST /api/v1/log_index_cfg/add

Overview¶

Modify a single default storage index configuration

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Index name Example: xxx Can be empty: False Maximum length: 256
extend	json		Frontend custom data Can be empty: True
duration	string		Data retention period Can be empty: False Example: 7d
setting	json		Configuration information Can be empty: False
setting.hot_retention	int		Volc Engine Storage, Standard Storage - Hot Data Can be empty: False
setting.cold_retention	int		Volc Engine Storage, Infrequent Access Storage - Cold Data Can be empty: False
setting.archive_retention	int		Volc Engine Storage, Archive Storage - Archived Data Can be empty: False

Additional Parameter Explanation¶

1. Request Parameter Explanation

Parameter Name	Type	Required	Description
name	String	Required	Index name
extend	Json		Extended information for frontend display
duration	Json		Total storage duration of the index, Example: 60d
setting	Json		Configuration information when logs are stored in Volc Engine Storage

2. Parameter Explanation within setting

Parameter Name	Type	Required	Description
hot_retention	int	Required	Standard Storage - Hot Data, must be whole hours, Unit: hours h
cold_retention	int		Infrequent Access Storage - Cold Data, must be whole hours, Unit: hours h
archive_retention	int		Archive Storage - Archived Data, must be whole hours, Unit: hours h

2.1. Volc Engine Storage Duration Limits:
Standard Storage: Hot Data Storage, Data range: 1-1800 days. If Infrequent Access Storage is used, the data range is: 7-1800 days; if Archive Storage is used, the data range is: 30-1800 days.
Infrequent Access Storage: Cold Data Storage, Data range: 30-1800 days.
Archive Storage: Archived Data Storage, Data range: 60-1800 days.
2.2. Volc Engine Storage Duration Limits:
Total storage duration (Standard Storage + Infrequent Access Storage + Archive Storage) cannot exceed 1800 days.

3. Parameter Explanation within extend

Parameter Name	Type	Required	Description
filters	Array[dict]		List of filter conditions

4. Main Structure of extend.filters

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

Request Example¶

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