修改默认类型索引配置¶
POST /api/v1/log_index_cfg/{cfg_uuid}/modify
概述¶
修改默认存储类型索引配置
路由参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| cfg_uuid | string | Y | 配置 uuid |
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| desc | string | 索引描述 例子: xxx 允许为空: False 允许为空字符串: True 最大长度: 1024 |
|
| extend | json | 前端自定义数据 允许为空: True |
|
| duration | string | 数据保留时长 允许为空: False 例子: 7d |
|
| storagePolicy | json | 长期存储策略,仅日志为 scopedb 存储的工作空间允许开启,unlimited 版本不支持;enterprise 版本支持自定义长期存储时长,logging 最大 1800d,rp 最大 3600d;包含 longStorageEnabled 和 longStorageDuration 例子: {'longStorageEnabled': True, 'longStorageDuration': '180d'} 允许为空: False |
|
| isFullLineIndex | int | 是否为全行索引;0/false 表示保留 message 字段索引,1/true 表示全行索引,默认 0;仅日志存储为 scopedb 的工作空间允许设置为 1 允许为空: False |
|
| setting | json | 相关配置信息 允许为空: False |
|
| setting.hot_retention | int | 火山引擎存储, 标准存储-热存储 允许为空: False |
|
| setting.cold_retention | int | 火山引擎存储, 低频存储-冷数据 允许为空: False |
|
| setting.archive_retention | int | 火山引擎存储, 归档存储-归档数据 允许为空: False |
参数补充说明¶
extend 中的匹配条件说明
| 参数名 | type | 必选 | 说明 |
|---|---|---|---|
| matchMode | String | 匹配模式,可选值:basic、advanced;缺省按 basic 处理 |
|
| filters | Array[dict] | 普通匹配过滤条件列表,advanced 模式下建议传空数组 |
|
| advancedFilter | Dict | 进阶匹配条件树,matchMode=advanced 时生效 |
advancedFilter 根节点固定为 group,group.filters 中可以嵌套 rule 或 group。rule.operation 可选值:=, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist。value 统一为数组,exist / not_exist 使用空数组。matchMode=advanced 时,后端会按 DQL where 风格生成 conditions;普通 filters 仍保持历史生成格式。
请求例子¶
curl 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_xxxx32/modify' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"duration":"7d","isFullLineIndex":1,"extend":{"filters":[{"condition":"and","name":"host","operation":"in","value":["guance"]}]}}' \
--compressed
响应¶
{
"code": 200,
"content": {
"conditions": "{ `host` in [ 'guance' ] }",
"createAt": 1698751853,
"creator": "xxx",
"deleteAt": -1,
"duration": "7d",
"extend": {
"filters": [
{
"condition": "and",
"name": "host",
"operation": "in",
"value": [
"guance"
]
}
]
},
"exterStoreName": "",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "",
"id": 1376,
"isBindCustomStore": 0,
"isFullLineIndex": 1,
"isPublicNetworkAccess": 0,
"name": "test_index",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 3,
"status": 0,
"storeType": "",
"updateAt": 1698752013.27368,
"updator": "xx",
"uuid": "lgim_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-09F7E56D-1DE5-48C9-A77A-108A53462A75"
}