DescribeAlarmNotifyGroups--日志服务-火山引擎

文档中心

立即注册

导航

DescribeAlarmNotifyGroups

最近更新时间：2024.08.02 11:18:43首次发布时间：2022.05.11 11:26:48

调用 DescribeAlarmNotifyGroups 接口获取告警通知组列表。

使用说明

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

请求说明

请求方式：GET
请求地址：https://tls-{Region}.ivolces.com/DescribeAlarmNotifyGroups

请求参数

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

Query

参数	类型	是否必选	示例值	描述
AlarmNotifyGroupName	String	否	`group1`	告警通知组名称。
AlarmNotifyGroupId	String	否	`a*****`	告警通知组 ID。
ReceiverName	String	否	`zhangsan`	接收告警的 IAM 用户名称。
IamProjectName	String	否	`default`	根据告警组所属的 IAM 项目名称进行筛选。精确匹配。
PageNumber	Integer	否	`1`	分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSize	Integer	否	`20`	分页大小。默认为 20，最大为 100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AlarmNotifyGroups	Array of NotifyGroupsInfo	`[ { "AlarmNotifyGroupName": "test1", "AlarmNotifyGroupId": "6ef**********", "NotifyType": [ "Recovery", "Trigger" ], "Receivers": [ { "ReceiverType": "User", "ReceiverNames": [ "****" ], "ReceiverChannels": [ "Sms" ], "StartTime": "00:00:00", "EndTime": "23:59:59" } ], "IamProjectName": "default", "CreateTime": "2022-04-21 07:31:09", "ModifyTime": "2022-04-21 07:31:09" } ]`	告警通知组列表。
Total	Integer	`1`	符合条件的告警通知组总数。

NotifyGroupsInfo

参数	类型	示例值	描述
Receivers	Array of Receiver	`/`	接收告警的 IAM 用户列表。可设置 1~10 个 IAM 用户。
CreateTime	String	`2024-07-23 11:41:29`	告警通知组创建的时间。
ModifyTime	String	`2024-07-23 11:41:32`	告警通知组修改的时间。
NotifyType	Array of String	`Trigger`	告警通知的类型。可选值，选择一个或者多个： Trigger - 告警触发 Recovery - 告警恢复
IamProjectName	String	`default`	告警组所属的 IAM 项目。
AlarmNotifyGroupId	String	`t****`	告警通知组 ID。
AlarmNotifyGroupName	String	`test-alarm-nofify`	告警通知组名称。
NoticeRules	Array of NoticeRule	`/`	通知组规则。

Receiver

参数	类型	示例值	描述
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	`User`	接收对象类型。可设置为： User：IAM 用户。 UserGroup：IAM 用户组。
ReceiverNames	Array of String	`["Andy"]`	IAM 用户或用户组名称。
ReceiverChannels	Array of String	`["Sms"]`	通知接收渠道。 Email：邮件。 Sms：短信。 Phone：电话。 GeneralWebhook：自定义 Webhook 地址。 Lark：飞书。 DingTalk：钉钉。 WeChat：企业微信。
GeneralWebhookUrl	String	`https://xxxx.feushu.com/xxxx`	自定义接口回调地址。
GeneralWebhookBody	String	`/`	自定义 WebHook 请求体。建议根据对应服务的回调接口格式要求设置请求体内容。
AlarmWebhookAtUsers	Array of String	`user1`	通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时，需要提醒的用户名。说明配置了以 `AlarmWebhook` 开头的参数时，表示您选择使用 Webhook 集成配置方式管理 Webhook 地址，此时请将 `GeneralWebhook` 开头的参数留空，无需配置。
AlarmWebhookIsAtAll	Boolean	`true`	通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时，是否提醒所有人。 true：提醒所有人。 false：不提醒所有人。说明配置了以 `AlarmWebhook` 开头的参数时，表示您选择使用 Webhook 集成配置方式管理 Webhook 地址，此时请将 `GeneralWebhook` 开头的参数留空，无需配置。
AlarmWebhookAtGroups	Array of String	`group1`	通过 Webhook 集成配置发送通知到飞书、钉钉或企业微信时，需要提醒的用户组名称。说明配置了以 `AlarmWebhook` 开头的参数时，表示您选择使用 Webhook 集成配置方式管理 Webhook 地址，此时请将 `GeneralWebhook` 开头的参数留空，无需配置。
GeneralWebhookMethod	String	`POST`	自定义接口回调方法，仅支持设置为 POST 或 PUT。
GeneralWebhookHeaders	Array of GeneralWebhookHeaderKV	`/`	自定义接口回调请求头。
AlarmContentTemplateId	String	`al****`	告警内容模版 ID。
AlarmWebhookIntegrationId	String	`1f4a9e21****`	告警 Webhook 集成配置的 ID。说明配置了以 `AlarmWebhook` 开头的参数时，表示您选择使用 Webhook 集成配置方式管理 Webhook 地址，此时请将 `GeneralWebhook` 开头的参数留空，无需配置。
AlarmWebhookIntegrationName	String	`test`	告警 Webhook 集成配置的名称。说明配置了以 `AlarmWebhook` 开头的参数时，表示您选择使用 Webhook 集成配置方式管理 Webhook 地址，此时请将 `GeneralWebhook` 开头的参数留空，无需配置。

NoticeRule

参数	类型	示例值	描述
HasNext	Boolean	`true`	是否继续进入下一层的条件判断。
RuleNode	Object of RuleNode	`/`	规则节点。
HasEndNode	Boolean	`true`	后面是否存在结束节点。
ReceiverInfos	Array of Receiver	`/`	通知渠道相关信息。

GeneralWebhookHeaderKV

参数	类型	示例值	描述
key	String	`Content-Type`	自定义请求头的 Key。
value	String	`application/json`	自定义请求头的 Value。

RuleNode

参数类型示例值描述

参数	类型	示例值	描述
Type	String	`Operation`	当前节点类型。可选值： Operation：操作节点。 Condition：条件节点
Value	Array of String	`/`	节点值。
Children	Array of RuleNode	`[ "AND"]`	子节点。

Type

String

Operation

当前节点类型。可选值：

Operation：操作节点。
Condition：条件节点

Value Array of String / 节点值。

Children Array of RuleNode [ "AND"] 子节点。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeAlarmNotifyGroups?AlarmNotifyGroupName=test HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{
    "Total": 5,
    "AlarmNotifyGroups": [
        {
            "AlarmNotifyGroupName": "test001",
            "AlarmNotifyGroupId": "7456eb3e****",
            "ReceiverNums": 2,
            "CreateTime": "2024-07-23 10:24:22",
            "ModifyTime": "2024-07-23 10:26:06"
        },
        {
            "AlarmNotifyGroupName": "aaa-yyj",
            "AlarmNotifyGroupId": "366a0ecd****",
            "ReceiverNums": 1,
            "CreateTime": "2024-07-15 22:12:49",
            "ModifyTime": "2024-07-16 17:58:53"
        },
        {
            "AlarmNotifyGroupName": "yyj-test",
            "AlarmNotifyGroupId": "cf6527e5****",
            "ReceiverNums": 1,
            "CreateTime": "2024-07-15 22:10:03",
            "ModifyTime": "2024-07-15 23:08:00"
        },
        {
            "AlarmNotifyGroupName": "aaa2",
            "AlarmNotifyGroupId": "e308b604****",
            "ReceiverNums": 1,
            "CreateTime": "2024-03-01 18:12:29",
            "ModifyTime": "2024-07-16 12:01:41"
        },
        {
            "AlarmNotifyGroupName": "aaa",
            "AlarmNotifyGroupId": "cf3285a7****",
            "ReceiverNums": 1,
            "CreateTime": "2024-02-05 11:32:43",
            "ModifyTime": "2024-04-09 20:19:37"
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
500	InternalServerError	We encountered an unexpected server error . Please try again later.	服务器内部错误。