一键告警:批量修改产品通知策略
更新时间 2026-06-09 10:53:23
最近更新时间: 2026-06-09 10:53:23
接口功能介绍
此接口用于修改一个产品的已启用的一键报警通知策略, 对禁用的一键报警通知策略不生效。
接口约束
无。
URI
POST /v4/monitor/alert-onekey/update-service-notify-config
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| dimension | 是 | String | ecs | ||
| dimension | 是 | String | 本参数表示云监控维度。取值范围: ecs:云主机。 disk:磁盘。 pms:物理机。 ... 详见云监控:查询服务维度及监控项 | ecs | |
| alarmType | 是 | String | 本参数表示告警类型。 取值范围: series:时序指标。 event:事件。 根据以上范围取值。 | series | |
| service | 是 | String | 本参数表示产品名称。取值范围: ecs:云主机。 evs:云硬盘。 ... 详见“[一键报警:产品列表]”接口返回。 | ecs | |
| repeatTimes | 否 | Integer | 重复告警通知次数,默认为0 | 0 | |
| silenceTime | 否 | Integer | 告警接收策略静默时间,多久重复通知一次,单位为秒。默认值:300 | 300 | |
| recoverNotify | 否 | Integer | 本参数表示恢复是否通知。默认值0。取值范围: 0:否。 1:是。 根据以上范围取值。 | 0 | |
| notifyType | 否 | Array of Strings | 本参数表示告警接收策略。取值范围: email:邮件告警。 sms:短信告警。 根据以上范围取值。 | ||
| contactGroupList | 否 | Array of Strings | 告警联系人组 | ||
| notifyWeekdays | 否 | Array of Integers | 本参数表示通知周期。默认值[0,1,2,3,4,5,6]。取值范围: 0:周日。 1:周一。 2:周二。 3:周三。 4:周四。 5:周五。 6:周六。 根据以上范围取值。 | ||
| notifyStart | 否 | String | 通知起始时段,默认为00:00:00 | 00:00:00 | |
| notifyEnd | 否 | String | 通知结束时段,默认为23:59:59 | 23:59:59 | |
| webhookUrl | 否 | String | 告警状态变更webhook推送地址 | https://www.ctyun.cn/ | |
| noticeStrategyID | 否 | String | 通知策略ID | 3ec4a76a-35ba-57b8-91c6-c4fd923351d6 | |
| defaultContact | 否 | Integer | 是否使用天翼云默认联系人发送通知。默认值:0 0:否 1:是 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
| errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
| message | String | 失败时的错误描述,一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
枚举参数
无
请求示例
请求url
/v4/monitor/alert-onekey/update-service-notify-config
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"alarmType":"series",
"repeatTimes":0,
"silenceTime":300,
"recoverNotify":0,
"notifyType":[
"email"
],
"contactGroupList":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751ccc"
],
"notifyWeekdays":[
0,
1,
2,
3,
4,
5,
6
],
"notifyStart":"00:00:00",
"notifyEnd":"23:59:59",
"webhookUrl":"https://www.ctyun.cn/"
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
请参考 状态码
错误码
请参考 错误码