接口说明
调用update接口更新告警规则
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /paasopenapi/api/cmplogadmin/cmplog/alert/rule/update/{id} HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
id | Long | Path | 是 | 10001 | 告警规则ID |
ruleName | String | Body | 是 | test_ruleName | 规则名称 |
queryMode | Byte | Body | 是 | 1 | 检查频率:1-固定频率;2-固定时间 |
triggerConds | List | Body | 是 | 触发条件,详情见下表 | |
logSearchVO | Object | Body | 是 | 检索条件,详情见下表 | |
alertMessageTemplate | String | Body | 是 | test_alertMessageTemplate | 告警通知模板 |
queryDuration | Integer | Body | 否 | 1 | 固定频率间隔 |
queryDurationUnit | Byte | Body | 否 | 1 | 固定频率间隔单位:1-分钟;2-小时;3-天 |
queryTime | String | Body | 否 | 00:00 | 按照固定时间。格式:hh:mm |
notifyStrategyId | Long | Body | 否 | 150 | 通知策略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 |
query数据结构如下:
名称 |
类型 | 位置 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|---|
num | Integer | Body | 否 | 1 | 搜索条件顺序序号 |
keyName | String | Body | 否 |
| 搜索字段名,默认是message,值为“__message__” |
| modeValue | String | Body | 否 | : | 搜索运算符: [:]表示包含; [=]表示等于 |
| inputValue | String[] | Body | 否 | ["test1","test2"] | 搜索字段条件值,支持多个 |
| targetParamType | String | Body | 否 | string | 字段类型.string, float, integer, bool |
| reverseFlag | String | Body | 否 | not | 搜索非条件标记: not; [不存在] |
| value | String | Body | 否 | and | 后连接条件的符号: and(默认) |
| mutiValueConnector | String | Body | 否 | or | 搜索条件inputValue之间的关系描述: inputValue元素为多个时才有意义: and |
返回数据
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 返回状态码 |
data | Long | 10001 | 告警规则ID |
msg | String | "" | 返回信息 |
示例
请求示例
POST /paasopenapi/api/cmplogadmin/cmplog/alert/rule/update/{id} HTTP/1.1
{
"id":10001,
"alertMessageTemplate": "test-alertMessageTemplate",
"logSearchVO": {
"appName": "test-appName",
"from": 1532568598,
"logProjectId": 207,
"logRuleIdList": [
949,950
],
"logUnitIdList": [
200,201
],
"pageNum": 1,
"pageSize": 10,
"query": [
{
"inputValue": [
"test1",
"test2"
],
"keyName": "message",
"modeValue": ":",
"mutiValueConnector": "or",
"num": null,
"reverseFlag": null,
"value": "and"
}
],
"queryModel": "1",
"resPoolCode": "d8bbd132b53a11e9b0e40242a",
"ruleName": "test-ruleName",
"searchDuration": 10,
"searchDurationUnit": "1",
"sqlDataDTOs": null,
"to": 1532568598
},
"notifyStrategyId": 150,
"queryDuration": 1,
"queryDurationUnit": "1",
"queryMode": "1",
"queryTime": "00:00",
"ruleName": "test-ruleName",
"triggerConds": [
{
"alertLevel": "1",
"compare": ">",
"triggerModel": "2",
"value": 0
}
]
}
正常返回示例
{
"code": 0,
"data": 10001,
"msg": ""
}
错误码
HTTP状态码(Status Code) | 错误码(Error Code) | 描述(Description) |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数。 |
400 | InvalidParameterValue | 请求参数取值错误。 |
409 | AlertRulerAlreadyExist | 告警规则名称已存在。 |
500 | FailedOperation | 操作失败 |