接口说明
调用queryRule接口查询采集规则详情
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /paasopenapi/api/cmplogadmin/cmplog/collect/rule/query HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
ruleId | Long | query | 是 | 10 | 采集规则ID |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码 |
data | Object | 查询投递任务结果数据,详细见下表 | |
msg | String | "" | 返回信息 |
data 数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
CmplogCollectRule | Object | 采集规则详情 |
CmplogCollectRule数据结构:
名称 |
类型 | 示例 | 描述 |
---|---|---|---|
ruleId | Long | 1532 | 采集规则ID |
name | String | testAddRule | 采集规则名称 |
code | String | 6b6237b6-1311-44eb-9e24-0b4712633405 | 采集规则编码 |
remark | String | 备注 | |
collectPolicy | String | add | 采集策略,add - 增量采集,all - 全量采集 |
logPathJson | String | [{"path":"/var/log/pods/gray_yfcs-workflow-activiti-service-5-85c7bffcc5-p7lrv_bee49c92-d09f-47e8-a6a5-1900ecdccdaa/**/*.log"}] | 采集路径 |
resPoolCode | String | 6019b5007a0b11eab5db0242ac110002 | 资源池编码 |
logUnitId | Long | 100 | 日志单元ID |
createBy | Long | 100001 | 创建人 |
cretareTime | Long | 1692686759958 | 创建时间 |
updateTime | Long | 1692686759958 | 更新时间 |
updateBy | Long | 1692686759958 | 更新人 |
status | Byte | 1 | 采集规则状态,1 - 有效 2 - 无效 |
示例
请求示例
GET /paasopenapi/api/cmplogadmin/cmplog/collect/rule/query?ruleId=6019 HTTP/1.1
正常返回示例
{
"code": 0,
"msg": null,
"data": {
"ruleId": 6019,
"name": "ccse_ccse-l94wgd_gray_workflow-activiti-service",
"code": "kOooBQsUnzjrcjaC",
"remark": null,
"logPathBlacklistStatus": null,
"collectPolicy": "all",
"extractMode": 2,
"firstLinePattern": null,
"extractPattern": null,
"logPathJson": "[{\"path\":\"/var/log/pods/gray_yfcs-workflow-activiti-service-5-85c7bffcc5-p7lrv_bee49c92-d09f-47e8-a6a5-1900ecdccdaa/**/*.log\"}]",
"filterStatus": 0,
"filterJson": null,
"timestampKey": null,
"retainInvalidLog": null,
"invalidLogKey": null,
"resPoolCode": "6019b5007a0b11eab5db0242ac110002",
"logUnitId": 558,
"createBy": 857657,
"createTime": 1686608965000,
"updateBy": 857657,
"updateTime": 1686608965000,
"status": 1,
"openCutting": null,
"cuttingMode": null,
"delimeterVo": null,
"regexVo": null
}
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
400 | InvalidParameterValue | 请求参数取值错误。 |
500 | FailedOperation | 操作失败 |