绑定索引配置修改¶

POST /api/v1/external_log_index_cfg/{cfg_uuid}/modify

概述¶

修改一个绑定索引的配置

路由参数¶

参数名	类型	必选	说明
cfg_uuid	string	Y	配置 uuid

Body 请求参数¶

参数名	类型	必选	说明
extend	json		前端自定义数据允许为空: True
exterStoreName	string	Y	与 name 互为映射的外部存储的名字(SLS 类型对应 StoreName, 火山云的 TLS 对应 topic_name) 允许为空: False
name	string	Y	索引名字例子: xxx 允许为空: False
desc	string		索引描述例子: xxx 允许为空: False 允许为空字符串: True
exterStoreProject	string		外部存储索引对应的 project(SLS 类型对应 StoreProject, 火山云的 TLS 对应 project_name) 允许为空: False
region	string		指定外部资源的地域允许为空: False
isPublicNetworkAccess	boolean		是否公网访问, storeType 为 sls 时生效, 默认为 False(2024-07-10迭代添加) 允许为空: True
accessCfg	json	Y	外部资源访问配置信息允许为空: False
accessCfg.cloudAccountId	string		云账号 ID 允许为空: False
accessCfg.ak	string		密钥 Id 允许为空: False
accessCfg.sk	string		密钥允许为空: False
accessCfg.url	string		链接地址允许为空: False
accessCfg.username	string		用户名允许为空: False 允许为空字符串: True
accessCfg.password	string		密码允许为空: False 允许为空字符串: True
accessCfg.iamProjectName	string		火山云 TLS 的 iam_project_name 允许为空: False 允许为空字符串: True
accessCfg.iamProjectDisplayName	string		火山云 TLS 的 iam_project_name 的显示名允许为空: False 允许为空字符串: True
accessCfg.projectId	string		火山云 TLS project_id 允许为空: False 允许为空字符串: True
accessCfg.topicId	string		火山云 TLS topic_id 允许为空: False 允许为空字符串: True
fields	array		待更新的字段映射配置列表允许为空: False
fields[*]	None
fields[*].field	string	Y	字段名例子: message 允许为空: False
fields[*].originalField	string	Y	原始字段名例子: content 允许为空: False 允许为空字符串: True

参数补充说明¶

请求例子¶

curl 'https://openapi.guance.com/api/v1/external_log_index_cfg/lgim_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accessCfg":{"url":"aabb.com","username":"test33"},"exterStoreName":"aa_uuid","fields":[{"field":"time","originalField":"time"},{"field":"__docid","originalField":"__docid"},{"field":"message","originalField":"message"}]}' \
--compressed

响应¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-63EE56F5-8EFB-4FF9-994D-11848B6EFA80"
}