采集規則列表
更新時間 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 //[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
}
}]
}
狀態碼
請參考
錯誤碼
請參考
