接口功能介绍
调用此接口可设置指定告警规则的告警联系人及通知方式。
接口约束
告警规则存在。
URI
POST /v4/monitor/set-alarm-rule-contact
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| alarmRuleID | String | 是 | 2c2472df-f633-5b4b-be45-9609fc9f8154 | 告警规则ID | |
| contactGroupList | Array of String | 是 | ["7e6b4ac7-cf07-561d-b381-fea74c401f50"] | 告警接收策略通知人ID列表 | |
| notifyType | Array of String | 是 | ["sms"] | 告警接受策略通知方式。取值范围：sms：短信通知。email：邮件通知。根据以上范围取值。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
请求示例
POST /v4/monitor/set-alarm-rule-contact
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "2c2472df-f633-5b4b-be45-9609fc9f8154",
"contactGroupList": ["7e6b4ac7-cf07-561d-b381-fea74c401f50"],
"notifyType": ["sms"]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmRule.AlarmRuleNotFoundError | 告警规则不存在错误 |
| 其他 | 参见公共错误码说明 |
