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 Allowed 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 | Low-frequency storage - Cold data Allow empty: False |
|
| archiveRetention | int | Archive storage - Archive data 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 | Size of a single shard, this field name is provided by kodo side, the field name is ambiguous Allow empty: False |
|
| duration | string | Data storage policy unit d (day) Example: 7d Allow empty: False |
Parameter Supplementary Explanation¶
External interface description.
Management backend updates index configuration, calls kodo interface for modification
1. **kodo update index configuration Parameter Description
| Parameter Name | type | Required | Description |
|---|---|---|---|
| workspace_uuid | String | Required | Corresponding workspace uuid |
| number_of_shards | int | Optional | Number of primary shards |
| data_type | string | Required | Index type as enum value |
| number_of_replicas | int | Required (doris optional) | Number of replicas |
| rollover_max_size | int | Optional | Shard size |
**2. Management Backend Index Configuration Description:
es—>all (includes, shards/replicas/hot data retention period/ advanced configuration) beaver(logging)—>no doris—> Hot storage volctls(volcengine)—> Standard storage - Hot storage, Low-frequency storage - Cold data, Archive storage - Archive data sls—>no
3. Parameter Description
| key | Description |
|---|---|
| data_type | Non-merged index data_type allowed values are backup_log, keyevent, logging, network, rum, security, tracing, profiling Merged index data_type allowed values are apm, backup_log, keyevent, logging, network |
| rollover_max_size | Represents the index rollover condition, i.e., when the index reaches a certain size, it rolls over to a new index, rollover_max_size = number_of_shards * single shard size |
Note:
Actual rollover_max_size represents the size of a single shard, not the maximum size, kodo side has not provided a new field for shard size name, continue to use rollover_max_size to represent the size of a single shard, if modification is needed, kodo side needs to provide a new field to represent the size of a single shard
4. Volcengine Storage Description
- For Volcengine storage, the original total storage duration for each type will correspond to the current standard storage
- For Volcengine, modifying storage policies will modify the standard, low-frequency, and archive types, no longer modifying the total duration. Interaction reference Blue Lake (involves management backend corresponding index configuration storage duration changes, frontend index storage duration changes)
- Volcengine storage duration limits: Standard storage: Hot data storage, data range: 1-1800 days. If there is low-frequency storage, data range: 7-1800 days; if there is archive storage, data range: 30-1800 days. Low-frequency storage: Cold data storage, data range: 30-1800 days. Archive storage: Archive data storage, data range: 60-1800 days.
- Volcengine storage duration limits: Total storage duration (standard storage + low-frequency storage + archive storage) cannot exceed 1800 days.