告警回調測試：告警回調測試
更新時間 2024-09-25 16:20:56
最近更新時間: 2024-09-25 16:20:56
分享文章
告警回調
告警回調測試
接口功能介紹
此接口用于客戶配置webhook推送地址時，測試該地址是否可以正常推送消息。
當code=800時，代表用戶填寫的url返回的http狀態碼為200，但不一定推送成功，需要客戶根據響應內容和實際消息接收結果來確認。
接口約束
無。
URI
POST /v4/monitor/test-webhook
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| webhookUrl | 是 | String | webhook推送url | //www.daliqc.cn/ |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| data | Object | 返回內容 | 返回內容，此處的內容不是固定的 | |
| httpStatusCode | Integer | 狀態碼 | 200 | |
| message | String | 提示信息 | success | |
| successResponse | Boolean | 是否成功 | true |
請求示例
請求url
/v4/monitor/webhook-testing
請求頭header
無
請求體body
{
"webhookUrl": "//www.daliqc.cn/"
}
響應示例
{
"statusCode":800,
"returnObj":{
"httpStatusCode":"200",
"data":{
"result":"HTTP SERVER OK"
},
"message":"success",
"successResponse":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
