更新采集规则
更新时间 2026-03-30 15:18:44
最近更新时间: 2026-03-30 15:18:44
接口功能介绍
更新采集规则
接口约束
无
URI
POST /v1/collectorRule/update
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码，请参考资源池列表 | 20000000***1852 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| unitCode | 是 | String | 日志单元ID，可通过采集规则详情接口获取 | 5799****33c5795e | |
| ruleCode | 是 | String | 采集规则ID，可通过采集规则详情接口获取 | c660****a5dc3792 | |
| logPaths | 是 | Array of Strings | 待采集的日志文件路径列表（目前仅限1个路径）。路径中支持使用*和通配符，其中通配符仅能出现一次且仅限用于文件名前 | ||
| cuttingMode | 是 | String | 提取模式，不同模式对应其他参数不同。1：单行正则；2：分隔符；3：多行正则；4：单行全文；5：json；6：多行全文；7：组合解析；8：nginx模板解析 | 1 | |
| extractMode | 是 | Byte | 采集类型。1：云主机-文本日志；2：云容器引擎-标准输出；3：云容器引擎-文本日志；4：syslog-协议；5：物理机-文本日志；6：windows事件日志；7：对象存储文件；8：Kafka数据导入；9：Systemd Journal日志；10：审计日志；11：k8s节点文件日志 | 1 | |
| accessType | 是 | Byte | 接入类型。1：ccse；2：msap；3：csm；4：faas；5：msegw；6：ctgcache；7：kafka；8：mq2；9：amqp；10：host；11：mqtt；12：ebm；13： rcc；14：oss_import；15：kafka_data；16：audit_import；17：cce_one；18：cae | 10 | |
| firstLinePattern | 否 | String | 首行正则，例如：\d+-\d+-\d+\s\d+:\d+:\d+.\d+\s.* | ||
| customTime | 否 | Object | 自定义时间戳提取格式 | customTime |
表 customTime
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| key | 是 | String | 提取字段名 | time | |
| timeFormat | 是 | String | 提取时间格式，如yyyy-MM-dd HH:MM:SS | yyyy-MM-dd HH:MM:SS |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。0：代表正常； -1：代表严重错误； -2：代表普通错误 | 0 | |
| error | String | 业务错误码，仅错误时返回，例LTS_XXXX | LTS_0001 | |
| message | String | 请求响应信息 | 成功 | |
| requestId | String | 请求ID | 0daaff11-63ab365d7 | |
| returnObj | Object | 请求响应数据体 |
枚举参数
无
请求示例
请求url
POST https://[endpoint]/v1/collectorRule/update
请求头header
regionId:20000000***1852
请求体body
{
"unitCode":"adgfghkba",
"ruleCode":"nmwsrfjhew",
"cuttingMode":"1",
"extractMode": 1,
"logPaths":[
"/var/logs/test.log"
]
}
响应示例
{
"statusCode":0,
"error":null,
"requestId":"3e31ebb2-572e5408e",
"message":"成功",
"returnObj":null
}
状态码
请参考 状态码
错误码
请参考 错误码
