Workspace - Index Template Configuration¶
POST /api/v1/workspace/{workspace_uuid}/update_index_setting
Overview¶
Route Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| workspace_uuid | string | Y | Workspace UUID |
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| data_type | string | Y | Data type Allow empty: False Optional values: ['rum', 'logging', 'network', 'tracing', 'profiling', 'keyevent', 'security', 'backup_log', 'apm', 'dialtest'] |
| cfg_uuid | string | Other index configuration UUID Allow empty: False Allow empty string: True |
|
| hotRetention | int | Standard storage - hot storage Allow empty: False |
|
| coldRetention | int | Cold storage - cold data Allow empty: False |
|
| archiveRetention | int | Archive storage - archive data Allow empty: False |
|
| storagePolicy | json | Long-term storage policy. Only workspaces with scopedb storage for logs can enable this; pay, enterprise, unlimited support long-term log storage. For enterprise/unlimited, logging max is 1800d; for enterprise/unlimited, rp supports custom long-term storage duration (max 3600d). Unlimited uses metric_point_total billing type when BossAccountSet is enabled, otherwise metric_point_total. Contains longStorageEnabled and longStorageDuration Allow empty: False |
|
| openAdvancedConfig | int | Whether to enable advanced configuration Allow empty: False |
|
| mappings | json | Other index configuration UUID Allow empty: False |
|
| number_of_shards | int | Primary shards Allow empty: False |
|
| number_of_replicas | int | Number of replicas Allow empty: False |
|
| rollover_max_size | int | Single shard size. This field name is provided by kodo, and the field name is ambiguous Allow empty: False |
|
| duration | string | Data storage policy in days (d) Example: 7d Allow empty: False |
Additional Parameter Notes¶
External interface notes.
Update index configuration in the admin backend, call kodo API to modify.
1. **kodo Update Index Configuration Parameter Description
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| workspace_uuid | String | Required | UUID of the corresponding workspace |
| number_of_shards | int | Optional | Number of primary shards |
| data_type | string | Required | Index type, enum value |
| number_of_replicas | int | Required (not required for doris) | Number of replicas |
| rollover_max_size | int | Optional | Shard size |
1. Admin Backend Index Configuration Description:
- es -> all (includes shards, replicas, hot data retention duration, advanced configuration)
- beaver (LogEasy) -> no
- doris -> hot storage
- volctls (Volcengine) -> standard storage (hot storage), cold storage (cold data), archive storage (archive data)
- sls -> no
1. Parameter Description
| Key | Description |
|---|---|
| data_type | For non-merged indexes, optional values are backup_log, keyevent, logging, network, rum, security, tracing, profiling. For merged indexes, optional values are apm, backup_log, keyevent, logging, network. |
| rollover_max_size | Indicates the index rollover condition, i.e., when the index reaches a certain size, a new index is rolled out. rollover_max_size = number_of_shards * single shard size. |
Note:
The actual rollover_max_size represents the single shard size, not the maximum size. The kodo side has not yet provided a new field name for shard size, so rollover_max_size is reused to indicate the single shard size. To modify it, the kodo side needs to provide a new field to represent the single shard size.
1. Volcengine Storage Description
- For Volcengine storage, the original total storage duration for each type will correspond to the current standard storage.
- For Volcengine, modifying the storage policy will modify the three types (standard, cold, archive) together. There will be no more modification of total duration. Refer to Blue Lake for interaction (involving the change of index configuration storage duration in the admin backend and the change of index storage duration in the frontend).
- Volcengine storage duration limits:
- Standard storage: hot data storage, range: 1-1800 days. If cold storage exists, range: 7-1800 days. If archive storage exists, range: 30-1800 days.
- Cold storage: cold data storage, range: 30-1800 days.
- Archive storage: archive data storage, range: 60-1800 days.
- Volcengine storage duration limit:
- Total storage duration (standard storage + cold storage + archive storage) cannot exceed 1800 days.