外部告警
外部告警：发送通知
接口功能介绍
调用此接口可发送自定义消息。
接口约束
无。
URI
POST /v4/monitor/send-message
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| method | 是 | Array of Strings | 发送方式 | 本参数表示发送方式，取值范围：1.email：邮箱2.sms：短信 | |
| token | 是 | String | token | 1411668ec8c13f57472576d5d1603226 | |
| content | 是 | String | 发送内容 | 这里的内容是测试 | |
| subject | 否 | String | 邮件主题 | 邮件主题测试 | |
| webhookURL | 否 | Array of Strings | 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
请求示例
请求url
/v4/monitor/send-token
请求头header
无
请求体body
{
"method": [
"email"
],
"token": "1411668ec8c13f57472576d5d1603226",
"subject": "邮件主题测试",
"content": "邮件内容测试",
"webhookURL": ["https://www.ctyun.cn"]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
