工作空间-索引模板配置¶
POST /api/v1/workspace/{workspace_uuid}/update_index_setting
概述¶
路由参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| workspace_uuid | string | Y | 工作空间UUID |
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| data_type | string | Y | data类型 允许为空: False 可选值: ['rum', 'logging', 'network', 'tracing', 'profiling', 'keyevent', 'security', 'backup_log', 'apm', 'dialtest'] |
| cfg_uuid | string | 其他索引配置UUID 允许为空: False 允许空字符串: True |
|
| hotRetention | int | 标准存储-热存储 允许为空: False |
|
| coldRetention | int | 低频存储-冷数据 允许为空: False |
|
| archiveRetention | int | 归档存储-归档数据 允许为空: False |
|
| openAdvancedConfig | int | 是否开启高级配置 允许为空: False |
|
| mappings | json | 其他索引配置UUID 允许为空: False |
|
| number_of_shards | int | 主分片 允许为空: False |
|
| number_of_replicas | int | 副本数 允许为空: False |
|
| rollover_max_size | int | 单个分片大小,该字段名kodo侧提供,字段名有歧义 允许为空: False |
|
| duration | string | 数据存储策略 单位d(天) 例子: 7d 允许为空: False |
参数补充说明¶
对外接口说明.
管理后台更新索引配置,调用kodo接口进行修改
1. **kodo更新索引配置 参数说明
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| workspace_uuid | String | 必须 | 对应空间的uuid |
| number_of_shards | int | 非必须 | 主分片数 |
| data_type | string | 必须 | 索引类型 为枚举值 |
| number_of_replicas | int | 必须（doris非必须） | 副本数 |
| rollover_max_size | int | 非必须 | 分片大小 |
**2. 管理后台索引配置 说明:
es—>all (包含, 分片/副本/热数据保留时长/ 高级配置) beaver(日志易)—>no doris—> 热存储 volctls(火山)—> 标准存储-热存储, 低频存储-冷数据, 归档存储-归档数据 sls—>no
3. 参数 说明
| key | 说明 |
|---|---|
| data_type | 非合并索引的 data_type 可选值为 backup_log, keyevent, logging, network, rum, security, tracing, profiling 合并索引的 data_type 可选值为 apm, backup_log, keyevent, logging, network |
| rollover_max_size | 表示索引滚动条件，即索引到达多大时候，滚动出新的索引，rollover_max_size = number_of_shards * 单个分片大小 |
注意:
实际rollover_max_size表示单个分片大小,而非最大size, kodo侧暂未提供新字段分片大小名,延用rollover_max_size表示单个分片大小,如需修改需kodo侧提供新字段来表示单个分片大小
4. 火山引擎存储 说明
- 对于火山引擎存储, 原有的每个类型的总存储时长 将会对应目前的 标准存储
- 对于火山引擎 修改存储策略 都将 进行 标准, 低频, 归档 三个类型进行修改, 不再有总时长的修改. 交互参考蓝湖 (涉及管理后台对应的 索引配置存储时长变更, 前台索引存储时长变更)
- 火山存储时长限制： 标准存储：即热数据存储，数据范围：1-1800 天。若有低频存储，则数据范围：7-1800 天；若有归档存储，则数据范围：30-1800 天。 低频存储：冷数据存储，数据范围：30-1800 天。 归档存储：即归档数据等存储，数据范围：60-1800 天。
- 火山存储时长限制： 总存储时长（标准存储 + 低频存储 + 归档存储）不可大于 1800 天。