调用 ModifyAlarmNotifyGroup 接口修改告警通知组。
GeneralWebhook
开头的参数用于绑定自定义 Webhook 地址;以 AlarmWebhook
开头的参数用于绑定 Webhook 集成配置。AlarmWebhook
开头的参数,则系统将清空以 GeneralWebhook
开头的参数配置;如果配置了 AlarmContentTemplateId 参数,则系统将清空 GeneralWebhookBody 参数的配置;如果配置了 NoticeRules 参数,则系统将清空 NotifyType 和 Receivers 参数的配置。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AlarmNotifyGroupId | String | 是 | p**** | 告警通知组 ID。 |
AlarmNotifyGroupName | String | 否 | test-alarm-nofify | 告警通知组名称。命名规则请参考资源命名规则。 |
NotifyType | Array of String | 否 |
| 告警通知的类型。支持设置为:
说明
|
Receivers | Array of Receiver | 否 |
| 接收告警的 IAM 用户列表。可设置 1~10 个 IAM 用户。 说明
|
NoticeRules | Array of NoticeRule | 否 |
| 告警通知组的相关配置。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
EndTime | String | 是 | 23:59:59 | 可接收告警通知的结束时间。24 小时制,格式为 HH:mm:ss ,时间范围为 00:00:00~23:59:59 。 StartTime 不能大于 EndTime。 |
StartTime | String | 是 | 00:00:00 | 可接收告警通知的开始时间。24 小时制,格式为HH:mm:ss ,时间范围为 00:00:00~23:59:59 。 StartTime 不能大于 EndTime。 |
ReceiverType | String | 是 |
| 接收对象类型。可设置为:
|
ReceiverNames | Array of String | 是 | ["Andy"] | IAM 用户或用户组名称。 |
ReceiverChannels | Array of String | 是 |
| 通知接收渠道。支持设置一个或多个渠道。可设置为:
说明
|
GeneralWebhookUrl | String | 否 | https://xxxx.feushu.com/xxxx | 自定义接口回调地址。 |
GeneralWebhookBody | String | 否 | / | 自定义 WebHook 请求体。建议根据对应服务的回调接口格式要求设置请求体内容。 |
AlarmWebhookAtUsers | Array of String | 否 |
| 通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,需要提醒的用户名。 说明 配置了以 |
AlarmWebhookIsAtAll | Boolean | 否 |
| 通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,是否提醒所有人。 说明 配置了以 |
AlarmWebhookAtGroups | Array of String | 否 |
| 通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,需要提醒的用户组名称。 说明 配置了以 |
GeneralWebhookMethod | String | 否 | POST | 自定义接口回调方法,仅支持设置为 POST 或 PUT。 |
GeneralWebhookHeaders | Array of GeneralWebhookHeaderKV | 否 | / | 自定义接口回调请求头。 |
AlarmContentTemplateId | String | 否 | al**** | 告警内容模版 ID。 |
AlarmWebhookIntegrationId | String | 否 |
| 告警 Webhook 集成配置的 ID。 说明 配置了以 |
AlarmWebhookIntegrationName | String | 否 |
| 告警 Webhook 集成配置的名称。 说明 配置了以 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
HasNext | Boolean | 否 | true | 是否继续进入下一层的条件判断。 |
RuleNode | Object of RuleNode | 否 | / | 规则节点。 |
HasEndNode | Boolean | 否 | true | 后面是否存在结束节点。 |
ReceiverInfos | Array of Receiver | 否 | / | 通知渠道相关信息。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
key | String | 否 | Content-Type | 自定义请求头的 Key。 |
value | String | 否 | application/json | 自定义请求头的 Value。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Type | String | 否 |
| 当前节点类型。可选值:
|
Value | Array of String | 否 | / | 节点值。 |
Children | Array of RuleNode | 否 | [ "AND"] | 子节点。 |
本接口无特有的返回参数。更多信息请见返回结构。
PUT https://tls-{Region}.ivolces.com/ModifyAlarmNotifyGroup HTTP/1.1 Content-Type: application/json { "AlarmNotifyGroupId": "7456eb3e****", "AlarmNotifyGroupName": "yyj-test001", "NoticeRules": [ { "ReceiverInfos": [ { "StartTime": "00:00:00", "EndTime": "23:59:59", "ReceiverChannels": [ "Lark" ], "ReceiverNames": [], "ReceiverType": "User", "Webhook": "", "TemplateIDs": null, "AlarmContentTemplateId": "default-template", "AlarmWebhookIntegrationId": "ca2eb341****", "AlarmWebhookAtGroups": [], "AlarmWebhookAtUsers": [], "AlarmWebhookIsAtAll": false } ], "HasNext": true, "HasEndNode": true }, { "RuleNode": { "Children": [ { "Children": [], "Type": "Condition", "Value": [ "NotifyType", "in", "[\"1\"]" ] }, { "Children": [], "Type": "Condition", "Value": [ "Severity", "in", "[\"notice\",\"critical\",\"warning\"]" ] } ], "Type": "Operation", "Value": [ "OR" ] }, "ReceiverInfos": [ { "StartTime": "00:00:00", "EndTime": "23:59:59", "ReceiverChannels": [ "Lark" ], "ReceiverNames": [], "ReceiverType": "User", "Webhook": "", "TemplateIDs": null, "AlarmContentTemplateId": "default-template", "AlarmWebhookIntegrationId": "40959044-****", "AlarmWebhookAtGroups": [], "AlarmWebhookAtUsers": [], "AlarmWebhookIsAtAll": false } ], "HasNext": false, "HasEndNode": false } ] }
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
400 | AlarmNoticeUserNotExist | Alarm notice user %s not exist | 告警通知用户不存在。 |
404 | AlarmNotifyGroupNotExist | AlarmNotify Group does not exist. | 告警通知组不存在。 |
409 | NotifyGroupAlreadyExist | Notify group already exist | 告警通知组已存在。 |
500 | InternalServerError | We encountered an unexpected server error . Please try again later. | 服务器内部错误。 |