采集规则列表
更新时间 2025-09-16 19:00:40
最近更新时间: 2025-09-16 19:00:40
接口功能介绍
采集规则列表
接口约束
无
URI
GET /v1/collectorRule/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| unitCode | 是 | String | 单元ID，可从单元列表获取 | 10da3bf265bbbf | |
| ruleCode | 否 | String | 采集规则编码，可从采集规则列表获取 | 10ddfewbbbf | |
| ruleName | 否 | String | 可根据采集规则名称和原始名称模糊匹配 | rule01 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码，请参考资源池列表 | 20000000***1852 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。0：代表正常；-1：代表严重错误；-2：代表普通错误 | 0 | |
| error | String | 业务错误码，仅错误时返回，例LTS_XXXX | ||
| message | String | 请求响应信息 | 成功 | |
| requestId | String | 请求ID | 98be0891-a518ac061 | |
| returnObj | Object | 规则列表 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleCode | String | 采集规则编码 | wayFcPspWeNGvdUb | |
| unitCode | String | 单元ID | 10da3bf265bbbf | |
| ruleName | String | 采集规则原始名称 | ccse_seed-cluster_default_armscmpfrontend | |
| extractMode | Byte | 采集类型，1： 云主机-文本日志；2：云容器引擎-标准输出；3：云容器引擎-文本日志；4：syslog-协议; 5: 物理机-文本日志 | 1 | |
| cuttingMode | String | 切割模式，不同模式对应其他参数不同。1：单行正则；2：分隔符；3：多行正则；4：单行全文；5：json；6：多行全文 | 4 | |
| ruleConfig | Object | 规则属性 | RuleConfig | |
| 表 RuleConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| maxPathDepth | Integer | 当采集路径中带""通配符时，该参数用于指定""通配符最大解析深度 | 5 | |
| regex | Object | 正则切割模式，当切割模式为正则时返回 | RegexVO | |
| delimiter | Object | 分隔符，当切割模式为分隔符时必填 | DelimiterVO | |
| 表 RegexVO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| delimiter | String | 分隔符 | ||
| logContent | Array of Objects | 分割所得类型字段 | RegexLogContent | |
| 表 DelimiterVO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regexStr | String | 正则表达式 | ^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] | |
| logContent | Array of Objects | 正则分词所得类型字段 | DelimiterLogContent | |
| 表 RegexLogContent |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| key | String | 提取字段 | time | |
| type | String | 数据类型。text：字符串；double：数字 | text | |
| 表 DelimiterLogContent |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 数据类型。text：字符串；double：数字 | text | |
| key | String | 提取字段 | time |
枚举参数
无
请求示例
请求url
GET https://[endpoint]/v1/collectorRule/list?unitCode=10da3bf265bbbf
请求头header
regionId:20000000***1852
请求体body
无
响应示例
{
"statusCode": 0,
"error": null,
"requestId": "98be0891-a518ac061",
"message": null,
"returnObj": [
{
"unitCode": "df7b7c8d7f26ed",
"ruleName": "ccse_seed-cluster_default_armscmpfrontend",
"ruleCode": "wayFcPspWeNGvdUb",
"extractMode": 2,
"cuttingMode": "4",
"ruleConfig": {
"maxPathDepth": 5
}
}]
}
状态码
请参考 状态码
错误码
请参考 错误码
