接口说明
调用getById接口查询单个告警规则
请求头
该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。
请求语法
GET /paasopenapi/api/cmplogadmin/cmplog/alert/rule/{id} HTTP/1.1
请求参数
| 名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|---|
| id | Long | Path | 是 | 10001 | 告警规则ID |
返回数据
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | Integer | 0 | 返回状态码 |
| data | CmplogAlertRuleDTO | 告警规则对象，详情如下表 | |
| msg | String | "" | 返回信息 |
CmplogAlertRuleDTO数据结构如下：
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| projectName | String | test-projectName | 项目名称 |
| projectId | Long | 10001 | 项目ID |
| unitNames | List | test-unitNames | 单元名称 |
| logSearchVO | Object | 检索条件,详情如下表 | |
| triggerConds | List | 触发条件,详情如下表 | |
| ruleStatusName | String | test-ruleStatusName | 状态名称 |
| ruleId | Long | 10001 | 告警规则ID |
| ruleName | String | test-ruleName | 告警规则名称 |
| resPoolCode | String | d8bbd132b53a11e9b0e40242ac | 资源池编码 |
| queryMode | Byte | 1 | 检查频率：1-固定频率；2-固定时间 |
| alertMessageTemplate | String | test_alertMessageTemplate | 告警通知模板 |
| queryDuration | Integer | 1 | 固定频率间隔 |
| queryDurationUnit | Byte | 1 | 固定频率间隔单位：1-分钟；2-小时；3-天 |
| queryTime | String | 00:00 | 按照固定时间。格式：hh:mm |
| notifyStrategyId | Long | 150 | 通知策略ID |
| status | Byte | 1 | 状态：0-已启用；1-启用中；2-停用中；3-失败；4-停用 |
| createTime | Date | 2023-01-01T18:18:18Z | 告警规则创建时间 |
| createBy | Long | 3552 | 告警规则创建租户ID |
| updateTime | Date | 2023-01-01T18:28:18Z | 告警规则更新时间 |
| updateBy | Long | 3552 |
告警规则更新租户ID |
triggerConds数据结构如下：
| 名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|---|
| triggerModel | Byte | Body | 是 | 2 | 触发模式：1-有数据；2-有特定数据 |
| alertLevel | Byte | Body | 是 | 1 | 告警等级 |
| compare | String | Body | 否 | > | 比较值：>,<,>=,<=,= |
| value | Long | Body | 否 | 0 | 具体值 |
logSearchVO数据结构如下：
| 名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|---|
| resPoolCode | String | Body | 是 | d8bbd132b53a11e9b0e40242a | 资源池编码 |
| from | Long | Body | 是 | 1532568598 | 日志时间查询开始时间，单位毫秒 |
| to | Long | Body | 是 | 1532568598 | 日志时间查询开始时间，单位毫秒 |
| logProjectId | Long | Body | 是 | 207 | 日志项目ID |
| logUnitIdList | List | Body | 否 | [949,950] | 日志单元ID,为空或者Null表示搜索全部 |
| logRuleIdList | List | Body | 否 | [200,201] | 日志规则ID,为空或者Null表示搜索全部 |
| ruleName | String | Body | 否 | test-ruleName | 日志规则名 |
| appName | String | Body | 否 | test-appName | 应用名称 |
| queryModel | Byte | Body | 否 | 1 | 检索模式：1-快捷模式；2-交互模式 |
| query | List | Body | 否 | 检索条件，详情见下表 | |
| searchDuration | Integer | Body | 否 | 10 | 检索时间范围 |
| searchDurationUnit | Byte | Body | 否 | 1 | 检索时间范围单位,1-分钟,2-小时,3-天 |
| pageSize | Integer | Body | 是 | 10 | 每页大小,不传默认10 |
| pageNum | Integer | Body | 是 | 1 | 起始页，不传默认1 |
query数据结构如下：
| 名称 |
类型 | 位置 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|---|
| num | Integer | Body | 否 | 1 | 搜索条件顺序序号 |
| keyName | String | Body | 否 |
示例
请求示例
GET /paasopenapi/api/cmplogadmin/cmplog/alert/rule/{1001} HTTP/1.1
正常返回示例
{
"code": 0,
"data": {
"alertMessageTemplate": "test-alertMessageTemplate",
"createBy": 3552,
"createTime": "2023-01-01T18:18:18Z",
"jobId": null,
"logSearchJson": "{"resPoolCode":"d8bbd132b53a11e9b0e40242a","from":1,"to":1,"logProjectId":162,"logUnitIdList":[394,395,396,397,398],"logRuleIdList":null,"ruleName":null,"pageSize":10,"pageNum":1,"queryModel":2,"query":[{"num":null,"keyName":"message","modeValue":":","inputValue":["test"],"reverseFlag":null,"value":"and","mutiValueConnector":"or"}],"searchDuration":1,"searchDurationUnit":2}",
"logSearchVO": {
"appName": null,
"from": 1,
"logProjectId": 162,
"logRuleIdList": null,
"logUnitIdList": [394,395,396,397,398],
"pageNum": 1,
"pageSize": 10,
"query": [
{
"inputValue": [
"test"
],
"keyName": "message",
"modeValue": ":",
"mutiValueConnector": "or",
"num": null,
"reverseFlag": null,
"value": "and"
}
],
"queryModel": "2",
"resPoolCode": "d8bbd132b53a11e9b0e40242a",
"ruleName": "test-ruleName",
"searchDuration": 1,
"searchDurationUnit": "2",
"sqlDataDTOs": null,
"to": 1
},
"notifyStrategyId": 150,
"projectId": 10001,
"projectName": "test-projectName",
"queryDuration": 1,
"queryDurationUnit": "1",
"queryMode": "1",
"queryTime": "00:00",
"remark": null,
"resPoolCode": "d8bbd132b53a11e9b0e40242a",
"ruleId": 10001,
"ruleName": "test-ruleName",
"ruleStatusName": "test-ruleStatusName",
"status": "2",
"tenantCode": "un383f848c3fc346791663554548",
"tenantId": 3452,
"triggerCondJson": "[{"triggerModel":2,"compare":">=","value":0,"alertLevel":1}]",
"triggerConds": [
{
"alertLevel": "1",
"compare": ">=",
"triggerModel": "2",
"value": 0
}
],
"unitNames": null,
"updateBy": 3552,
"updateTime": "2023-01-01T18:28:18Z"
},
"msg": ""
}
错误码
| HTTP状态码（Status Code） | 错误码（Error Code） | 描述（Description） |
|---|---|---|
| 400 | MissingParameter | 缺少必要的请求参数。 |
| 400 | InvalidParameterValue | 请求参数取值错误。 |
| 500 | FailedOperation | 操作失败 |
