接口功能介绍
用户可以自行推送的告警事件,非系统自动产生,可以在告警历史中查询到。
接口约束
triggerID(监控平台告警规则ID)、issueID(告警事件ID)存在,status(状态)、clock(告警事件触发时间)满足取值范围,具体范围见请求参数说明。
URI
POST /v4/monitor/push-alert-issue
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
issueList | Array of Objects | 是 | 告警事件列表 | issue |
表issue
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
status | Integer | 是 | 1 | 本参数表示状态。取值范围:0:正常。1:告警。根据以上范围取值。 | |
clock | Integer | 是 | 告警事件触发时间 | 1666147320 | |
triggerID | String | 是 | 监控平台告警规则ID | 63411d5f39fa5e7ce08eac73 | |
issueID | String | 是 | 告警事件ID | 62368ada39fa5e2ea0cfe901 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
success | Boolean | 是否推送成功 | true |
请求示例
POST /v4/monitor/push-alert-issue
请求体body
{
"issueList": [
{
"status":1,
"clock":1666147320,
"triggerID":"63411d5f39fa5e7ce08eac73",
"issueID":"62368ada39fa5e2ea0cfe901"
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {"success": true},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |