接入外部告警
更新時間 2023-09-15 09:33:54
最近(jin)更新時間: 2023-09-15 09:33:54
分享文章
接口功能介紹
調用此接口可發送(song)自定義消息。
接口約束
無。
URI
POST /v4/monitor/send-message
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| method | Array of String | 是 | 本參數表示發送方式，取值范圍：1.email：郵箱2.sms：短信 | 發送方式 | |
| token | String | 是 | 1411668ec8c13f57472576d5d1603226 | token | |
| content | String | 是 | 這里的內容是測試 | 發送內容 | |
| subject | String | 否 | 郵件主題測試 | 郵件主題 | |
| webhookURL | String | 否 | //qyapi.weixin.qq.com/cgi-bin/webhook/send?key=65f3223d-xxxxxxxx | webhook推送url |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表(biao)returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
POST /v4/monitor/send-token
請求體body
{
"method": [
"email"
],
"token": "1411668ec8c13f57472576d5d1603226",
"subject": "郵件主題測試",
"content": "郵件內容測試",
"webhookURL": "//qyapi.weixin.qq.com/cgi-bin/webhook/send?key=65f3223d-xxxxxxxx"
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
