Create 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		Front-end custom data Can be empty: True
duration	string		Data retention period Can be empty: False Example: 7d
setting	json		Related configuration information Can be empty: False
setting.hot_retention	int		Volcengine storage, standard storage-hot storage Can be empty: False
setting.cold_retention	int		Volcengine storage, infrequent storage-cold data Can be empty: False
setting.archive_retention	int		Volcengine storage, archive storage-archive data Can be empty: False

Additional Parameter Notes¶

1. Request Parameter Notes

Parameter Name	Type	Required	Description
name	String	Required	Index name
extend	Json		Extended information used for front-end display
duration	Json		Total index storage duration, example: 60d
setting	Json		When logs are stored in Volcengine, index configuration information

2. **setting Parameter Notes

Parameter Name	Type	Required	Description
hot_retention	int	Required	Standard storage - hot data, must be whole hours unit: hour h
cold_retention	int		Infrequent storage - cold data, must be whole hours unit: hour h
archive_retention	int		Archive storage - archived data, must be whole hours unit: hour h

2.1, Volcengine Storage Duration Limitations:
Standard storage: i.e., hot data storage, data range: 1-1800 days. If there is infrequent storage, the data range: 7-1800 days; if there is archive storage, the data range: 30-1800 days.
Infrequent storage: Cold data storage, data range: 30-1800 days.
Archive storage: i.e., archived data storage, data range: 60-1800 days.
2.2, Volcengine Storage Duration Limitations:
Total storage duration (standard storage + infrequent storage + archive storage) cannot exceed 1800 days.

3. **extend Parameter Notes

Parameter Name	Type	Required	Description
filters	Array[dict]		List of filtering conditions
extendFields	string		Index extended field information, multiple fields separated by commas (,)

4. extend.filters Main Structure Notes

Parameter Name	Type	Description
condition	string	Relationship with the previous filtering condition, optional values:`and`, `or`; default value: `and`
name	string	Field name to be filtered
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.guance.com/api/v1/log_index_cfg/add' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Accept-Language: en' \
-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"
}