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 | Infrequent Access Storage - Cold Data Allow empty: False |
|
| archiveRetention | int | Archive Storage - Archived Data Allow empty: False |
|
| storagePolicy | json | Long-term storage policy, only workspaces with scopedb storage for logs are allowed to enable, unlimited version does not support; enterprise version supports custom long-term storage duration, logging max 1800d, rp max 3600d; includes 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 the kodo side, the field name is ambiguous Allow empty: False |
|
| duration | string | Data storage policy unit d (days) Example: 7d Allow empty: False |
Parameter Supplementary Description¶
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 is an enumeration value |
| number_of_replicas | int | Required (not required for doris) | Number of replicas |
| rollover_max_size | int | Optional | Shard size |
**2. Management Backend Index Configuration Description:
es—>all (includes, shards/replicas/hot data retention duration/ advanced configuration) beaver—>no doris—> Hot Storage volctls (Volcengine)—> Standard Storage - Hot Storage, Infrequent Access Storage - Cold Data, Archive Storage - Archived Data sls—>no
3. Parameter Description
| key | Description |
|---|---|
| data_type | For non-merged indices, data_type optional values are backup_log, keyevent, logging, network, rum, security, tracing, profiling. For merged indices, data_type optional 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, roll over to a new index, 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 temporarily used to represent the single shard size. If modification is needed, the kodo side needs to provide a new field to represent the single shard size.
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 the storage policy will modify the Standard, Infrequent Access, and Archive three types, and there will no longer be modifications to the total duration. Interaction reference Blue Lake (involving management backend corresponding index configuration storage duration changes, frontend index storage duration changes).
- Volcengine storage duration limits: Standard Storage: i.e., hot data storage, data range: 1-1800 days. If Infrequent Access storage exists, then data range: 7-1800 days; if Archive storage exists, then data range: 30-1800 days. Infrequent Access Storage: cold data storage, data range: 30-1800 days. Archive Storage: i.e., archived data storage, data range: 60-1800 days.
- Volcengine storage duration limits: Total storage duration (Standard Storage + Infrequent Access Storage + Archive Storage) cannot exceed 1800 days.