You need to enable JavaScript to run this app.
导航
ModifyAlarmNotifyGroup
最近更新时间:2024.12.05 11:10:02首次发布时间:2022.05.11 11:26:48

调用 ModifyAlarmNotifyGroup 接口修改告警通知组。

使用说明

  • 此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
  • 告警功能优化后,以 GeneralWebhook 开头的参数用于绑定自定义 Webhook 地址;以 AlarmWebhook 开头的参数用于绑定 Webhook 集成配置。
    两种方式均可实现将告警通知发送给飞书群、钉钉群、企业微信群或其他自定义 Webhook 地址(例如自建系统、第三方告警系统等),推荐使用 Webhook 集成配置。关于 Webhook 集成配置的详细说明,请参考创建 Webhook 集成配置。两种方式的配置说明,请参考 ReceiverChannels 参数。
  • 修改时,如果配置了以 AlarmWebhook 开头的参数,则系统将清空以 GeneralWebhook开头的参数配置;如果配置了 AlarmContentTemplateId 参数,则系统将清空 GeneralWebhookBody 参数的配置;如果配置了 NoticeRules 参数,则系统将清空 NotifyTypeReceivers 参数的配置。

请求说明

  • 请求方式:PUT
  • 请求地址:https://tls-{Region}.ivolces.com/ModifyAlarmNotifyGroup

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Body

参数类型是否必选示例值描述
AlarmNotifyGroupIdStringp****告警通知组 ID。
AlarmNotifyGroupNameStringtest-alarm-nofify告警通知组名称。命名规则请参考资源命名规则

NotifyType

Array of String

["Recovery", "Trigger"]

告警通知的类型。支持设置为:

  • Trigger:告警触发
  • Recovery:告警恢复

说明

  • 如果配置了 NoticeRules 参数,则必须将 NotifyTypeReceivers 参数留空。
  • 如果 NoticeRules 参数为空,则必须配置 NotifyTypeReceivers 参数。

Receivers

Array of Receiver

[ { "ReceiverType": "User", "ReceiverNames": ["******"], "ReceiverChannels": ["Sms"], "StartTime": "00:00:00", "EndTime": "23:59:59" } ]

接收告警的 IAM 用户列表。可设置 1~10 个 IAM 用户。

说明

  • 如果配置了 NoticeRules 参数,则必须将 NotifyTypeReceivers 参数留空。
  • 如果 NoticeRules 参数为空,则必须配置 NotifyTypeReceivers 参数。

NoticeRules

Array of NoticeRule

/

告警通知组的相关配置。

说明

  • 如果配置了 NoticeRules 参数,则必须将 NotifyTypeReceivers 参数留空。
  • 如果 NoticeRules 参数为空,则必须配置 NotifyTypeReceivers 参数。

Receiver

参数类型是否必选示例值描述
EndTimeString23:59:59可接收告警通知的结束时间。24 小时制,格式为 HH:mm:ss,时间范围为 00:00:00~23:59:59StartTime 不能大于 EndTime
StartTimeString00:00:00可接收告警通知的开始时间。24 小时制,格式为HH:mm:ss,时间范围为 00:00:00~23:59:59StartTime 不能大于 EndTime

ReceiverType

String

User

接收对象类型。可设置为:

  • User:IAM 用户。
  • UserGroup:IAM 用户组。
ReceiverNamesArray of String["Andy"]IAM 用户或用户组名称。

ReceiverChannels

Array of String

["Sms"]

通知接收渠道。支持设置一个或多个渠道。可设置为:

  • Email:邮件。
    日志服务使用的告警邮箱的域名为 mail.tls.volcengine.com ,您可以将该域名添加到目标邮箱的白名单中,以免告警邮件被拦截。
  • Sms:短信。
  • Phone:电话。
    • 如果电话未接通,不会重复拨打,将免费发送一次短信通知。
    • 日志服务使用 02132222528、02132222527 号码发送告警通知,您可将上述号码添加到手机白名单中,以免告警电话被拦截。
  • GeneralWebhook:自定义 Webhook 地址。
  • Lark:飞书。
  • DingTalk:钉钉。
  • WeChat:企业微信。

说明

  • ReceiverChannels 中包含 Lark、DingTalk
    或 WeChat 时,必须配置 AlarmWebhookIntegrationIdAlarmWebhookIntegrationNameAlarmContentTemplateId 参数,且将以 GeneralWebhook 开头的各个参数留空。
  • ReceiverChannels 中包含 GeneralWebhook 且不包含 Lark、DingTalk 和 WeChat 时,配置说明如下:
    • (推荐)配置 AlarmWebhookIntegrationIdAlarmWebhookIntegrationNameAlarmContentTemplateId 参数,且将以 GeneralWebhook 开头的各个参数留空。
    • 配置以 GeneralWebhook 开头的各个参数,且将以 AlarmWebhook 开头和以 AlarmContent 开头的参数留空。
GeneralWebhookUrlStringhttps://xxxx.feushu.com/xxxx自定义接口回调地址。
GeneralWebhookBodyString/自定义 WebHook 请求体。建议根据对应服务的回调接口格式要求设置请求体内容。

AlarmWebhookAtUsers

Array of String

user1

通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,需要提醒的用户名。

说明

  • 设置 ReceiverChannels 参数为 DingTalk 或 WeChat 时,才支持指定提醒人。
  • 配置了以 AlarmWebhook 开头的参数时,表示您选择使用 Webhook 集成配置方式管理 Webhook 地址,此时请将 GeneralWebhook 开头的参数留空,无需配置。
  • 指定提醒人后,企业微信的通知内容为普通文本格式,不支持 Markdown 格式。
  • 指定提醒人后,IAM 用户的手机号码必须为中国内地号码。

AlarmWebhookIsAtAll

Boolean

true

通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,是否提醒所有人。
true:提醒所有人。
false:不提醒所有人。

说明

  • 配置了以 AlarmWebhook 开头的参数时,表示您选择使用 Webhook 集成配置方式管理 Webhook 地址,此时请将 GeneralWebhook 开头的参数留空,无需配置。
  • 指定提醒所有人后,企业微信的通知内容为普通文本格式,不支持 Markdown 格式。

AlarmWebhookAtGroups

Array of String

group1

通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时,需要提醒的用户组名称。

说明

配置了以 AlarmWebhook 开头的参数时,表示您选择使用 Webhook 集成配置方式管理 Webhook 地址,此时请将 GeneralWebhook 开头的参数留空,无需配置。

GeneralWebhookMethodStringPOST自定义接口回调方法,仅支持设置为 POST 或 PUT。
GeneralWebhookHeadersArray of GeneralWebhookHeaderKV/自定义接口回调请求头。
AlarmContentTemplateIdStringal****告警内容模版 ID。

AlarmWebhookIntegrationId

String

1f4a9e21****

告警 Webhook 集成配置的 ID。

说明

配置了以 AlarmWebhook 开头的参数时,表示您选择使用 Webhook 集成配置方式管理 Webhook 地址,此时请将 GeneralWebhook 开头的参数留空,无需配置。

AlarmWebhookIntegrationName

String

test

告警 Webhook 集成配置的名称。

说明

配置了以 AlarmWebhook 开头的参数时,表示您选择使用 Webhook 集成配置方式管理 Webhook 地址,此时请将 GeneralWebhook 开头的参数留空,无需配置。

NoticeRule

参数类型是否必选示例值描述
HasNextBooleantrue是否继续进入下一层的条件判断。
RuleNodeObject of RuleNode/规则节点。
HasEndNodeBooleantrue后面是否存在结束节点。
ReceiverInfosArray of Receiver/通知渠道相关信息。

GeneralWebhookHeaderKV

参数类型是否必选示例值描述
keyStringContent-Type自定义请求头的 Key。
valueStringapplication/json自定义请求头的 Value。

RuleNode

参数类型是否必选示例值描述

Type

String

Operation

当前节点类型。可选值:

  • Operation:操作节点。
  • Condition:条件节点
ValueArray of String/节点值。
ChildrenArray 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 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
400AlarmNoticeUserNotExistAlarm notice user %s not exist告警通知用户不存在。
404AlarmNotifyGroupNotExistAlarmNotify Group does not exist.告警通知组不存在。
409NotifyGroupAlreadyExistNotify group already exist告警通知组已存在。
500InternalServerErrorWe encountered an unexpected server error . Please try again later.服务器内部错误。