告警事件:推送
更新時(shi)間 2023-07-19 11:40:59
最(zui)近更(geng)新時間: 2023-07-19 11:40:59
分享(xiang)文章
接口功能介紹
用戶可以自(zi)(zi)行推送的告(gao)警事件,非系(xi)統(tong)自(zi)(zi)動產生,可以在告(gao)警歷史中查(cha)詢到。
接口約束
triggerID(監控(kong)平臺告警(jing)規(gui)則ID)、issueID(告警(jing)事件(jian)ID)存在(zai),status(狀態(tai))、clock(告警(jing)事件(jian)觸(chu)發時間)滿足(zu)取值范圍(wei),具體范圍(wei)見請求參數說(shuo)明。
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |