告警回调
告警回调测试
接口功能介绍
此接口用于客户配置webhook推送地址时，测试该地址是否可以正常推送消息。
当code=800时，代表用户填写的url返回的http状态码为200，但不一定推送成功，需要客户根据响应内容和实际消息接收结果来确认。
接口约束
无。
URI
POST /v4/monitor/test-webhook
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| webhookUrl | 是 | String | webhook推送url | https://www.ctyun.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": "https://www.ctyun.cn/"
}
响应示例
{
"statusCode":800,
"returnObj":{
"httpStatusCode":"200",
"data":{
"result":"HTTP SERVER OK"
},
"message":"success",
"successResponse":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
