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

文档中心

立即注册

导航

日志服务

DescribeAlarmNotifyGroups

最近更新时间：2024.05.20 11:32:00首次发布时间：2022.05.11 11:26:48

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

使用说明

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

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

请求参数

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

Query

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

返回参数

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

参数	类型	描述
AlarmNotifyGroups	Array of AlarmNotifyGroupInfo	告警通知组列表。
Total	Integer	符合条件的告警通知组总数。

请求示例

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": 1,
    "AlarmNotifyGroups": [
        {
            "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"
        }
    ]
}

错误码

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

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