采集規則分頁列表
更新時間 2025-09-16 19:00:47
最近更新時間: 2025-09-16 19:00:47
分享文章
接口功能介紹
獲取采集規則分頁列表
接口約束
無
URI
GET /v1/collectorRule/page
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| unitCode | 是 | String | 單元ID，可從單元列表獲取 | d0512b90e44992 | |
| ruleCode | 否 | String | 采集規則編碼，可從采集規則列表獲取 | 776a7b1c2845a1 | |
| ruleName | 否 | String | 可根據采集規則名稱和原始名稱模糊匹配 | test-rule | |
| pageNum | 是 | Integer | 頁碼 | 1 | |
| pageSize | 是 | Integer | 每頁記錄數 | 10 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池編碼，請參考資源池列表 | 20000000***1852 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。0：代表正常；-1：代表嚴重錯誤；-2：代表普通錯誤 | 0 | |
| error | String | 業務錯誤碼，僅錯誤時返回，例LTS_XXXX | LTS_0001 | |
| message | String | 請求響應信息 | 成功 | |
| requestId | String | 請求ID | 3e31ebb2-572e5408e | |
| returnObj | Object | 規則分頁列表 | data | |
| 表 data |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| unitCode | String | 單元ID | 1b7cd64377bd7 | |
| ruleName | String | 采集規則原始名稱 | lmtagent | |
| ruleCode | String | 采集規則編碼 | d9b051ed09467de2 | |
| extractMode | Byte | 采集類型，1：云主機-文本日志；2：云容器引擎-標準輸出；3：云容器引擎-文本日志；4：syslog-協議; 5: 物理機-文本日志 | 1 | |
| logPaths | Array of Strings | 采集路徑 | ["/app"] | |
| cuttingMode | String | 切割模式，不同模式對應其他參數不同。1：單行正則；2：分隔符；3：多行正則；4：單行全文；5：json；6：多行全文 | 4 | |
| ruleConfig | Object | 采集規則高級配置 | RuleConfig | |
| 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 | 10 | |
| createTime | String | 創建時間 | 2024-08-23 15:55:07 | |
| collectPolicy | String | 采集策略。all：全量采集；add：增量采集 | all | |
| 表 RuleConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| maxPathDepth | Integer | 當采集路徑中帶""通配符時，該參數用于指定""通配符最大解析深度 | 5 | |
| excludeFilePaths | Array of Strings | 文件路徑黑名單(排除文件路徑符合條件的文件；必須為絕對路徑) | ["/app/cams/lmtagent/test/out.log"] | |
| excludeFiles | Array of Strings | 文件黑名單(排除文件名符合條件的文件；必須為文件名，不包含路徑) | ["info.log"] | |
| excludeDirs | Array of Strings | 目錄黑名單(排除文件所在目錄符合條件的文件；必須為絕對路徑) | ["/app/cams/lmtagent/access"] | |
| delimiter | Object | 分隔符，當切割模式為分隔符時返回 | DelimiterObj | |
| regex | String | 正則切割模式：當切割模式為正則時返回 | RegexObj | |
| 表 DelimiterObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| delimiter | String | 分隔符 | ||
| logContent | Array of Objects | 分割所得類型字段，輸入順序會被使用 | DelimiterLogContent | |
| 表 RegexObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regexStr | String | 正則表達式 | ^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\] | |
| logContent | Array of Objects | 分割所得類型字段，輸入順序會被使用 | RegexLogContent | |
| 表 DelimiterLogContent |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| key | String | 提取字段 | time | |
| type | String | 數據類型。text：字符串；double：數字 | text | |
| 表 RegexLogContent |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| key | String | 提取字段 | time | |
| type | String | 數據類型。text：字符串；double：數字 | text |
枚舉參數
無
請求示例
請求url
GET //[endpoint]/v1/hostGroup/ecsPageList/v1/collectorRule/page?unitCode=d0512b90e44992&pageNum=1&pageSize=10
請求頭header
regionId:20000000***1852
請求體body
無
響應示例
{
"statusCode": 0,
"requestId": "de71ecda-f722a65cb",
"error": null,
"message": null,
"returnObj": {
"total": 1,
"list": [
{
"unitCode": "1b7cd64377bd75",
"ruleName": "lmtagent-plugin",
"ruleCode": "d9b051ed09467de2",
"extractMode": 1,
"logPaths": [
"/app/cams/lmtagent/*.LOG"
],
"cuttingMode": "4",
"ruleConfig": {
"maxPathDepth": 5,
"delimiter": {
},
"regex": {
},
"logFilterVo": {
"include": {
},
"exclude": {
}
}
},
"accessType": 10,
"createTime": "2024-08-23 15:55:07",
"collectPolicy": "add"
}
]
}
}
狀態碼
請參考
錯誤碼
請參考
