链接复制成功!
批量修改开启状态的一键告警关联告警规则的告警通知
功能介绍
批量修改开启状态的一键告警关联告警规则的告警通知
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/notifications
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ |
one_click_alarm_id |
是 |
String |
一键告警ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 |
X-Auth-Token |
是 |
String |
用户Token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
notification_enabled |
是 |
Boolean |
是否开启告警通知,值为true时,其他字段均必选,值为false时,其他字段可不选 |
alarm_notifications |
否 |
Array of Notification objects |
告警触发的动作 |
ok_notifications |
否 |
Array of Notification objects |
告警恢复触发的动作 |
notification_begin_time |
否 |
String |
告警通知开启时间 |
notification_end_time |
否 |
String |
告警通知关闭时间 |
effective_timezone |
否 |
String |
时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00" |
notification_manner |
否 |
String |
NOTIFICATION_GROUP(通知组)/TOPIC_SUBSCRIPTION(主题订阅)/NOTIFICATION_POLICY(通知策略) 枚举值:
|
notification_policy_ids |
否 |
Array of strings |
关联的通知策略ID列表 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
通知类型。notification为SMN通知,contact为云账号联系人,contactGroup为通知组,autoscaling为AS通知。 枚举值:
|
notification_list |
是 |
Array of strings |
告警状态发生变化时,被通知对象的列表。topicUrn可从SMN获取,具体操作请参考查询Topic列表。当type为notification时,notification_list列表不能为空;当type为autoscaling时,列表必须为[]。 说明:若alarm_action_enabled为true,对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时,notification_list值保持一致。 |
响应参数
状态码:204
No Content
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
请求示例
{
"notification_enabled" : true,
"alarm_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:123" ]
} ],
"ok_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:123" ]
} ],
"notification_begin_time" : "00:00",
"notification_end_time" : "23:59",
"notification_manner" : "NOTIFICATION_POLICY",
"notification_policy_ids" : [ "np15563156337845e8A2Wv63" ]
}
响应示例
无
状态码
状态码 |
描述 |
---|---|
204 |
No Content |
400 |
参数校验失败 |
401 |
未认证 |
403 |
认证鉴权失败 |
404 |
资源不存在 |
500 |
系统内部错误 |
错误码
请参见错误码。