ListAlertGroup--云监控-火山引擎

文档中心

立即注册

导航

ListAlertGroup

最近更新时间：2025.06.04 16:21:46首次发布时间：2022.10.27 19:53:20

查询资源的告警历史列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListAlertGroup&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAlertGroup	接口名称。当前 API 的名称为 `ListAlertGroup`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
StartAt	Integer	否	1664176020	查询告警消息发生的最早时间。格式为时间戳，秒级。如果不填，最早时间是当前时间的前 7 天开始。
EndAt	Integer	否	1664262420	查询告警消息发生的最晚时间。格式为时间戳，秒级。如果不填，则为当前时间。说明 `StartAt`与`EndAt`间隔必须大于等于 1 分钟，如果小于 1 分钟，则默认查询过去 7 天的数据。
RuleIds	Array of String	否	["15753124985155*****"]	根据 RuleId 查询对应告警策略产生的告警消息。支持配置多个。如果使用 RuleId，则不会使用`Namespaces`、`Levels`、`RuleName`过滤参数。
ResourceId	String	否	kafka-cn-4ia***xia	告警资源的 ID。
Namespaces	Array of String	否	["VCM_Kafka"]	查询资源类型为指定 Namespace 的告警策略产生的告警消息。支持多选。
Levels	Array of String	否	["warning","notice"]	查询告警级别为指定 Level 的告警策略产生的告警消息。支持多选。
RuleName	String	否	测试	查询告警名称为指定的告警策略产生的告警消息。模糊匹配。
AlertStates	Array of String	否	["normal"]	查询告警状态为指定状态的告警策略产生的告警消息。支持多选。 alerting：告警中 normal：已恢复
PageNumber	Integer	否	1	列表的页码，取值 > 0，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
PageSize	Integer	否	10	分页查询时每页的行数，默认值为10。

请求示例

POST https://open.volcengineapi.com?Action=ListAlertGroup&Version=2018-01-01
Content-Type: application/json
{
    "StartAt": 1664335767,
    "EndAt": 1664422167,
    "ResourceId": "kafka-cn-4ia***xia",
    "PageSize": 30,
    "PageNumber": 1
}

返回参数

参数	类型	示例值	描述
Asc	Boolean	false	告警历史的排序方式。
Data	Array of AlertGroupVO	-	返回数据。
OrderBy	String	-	告警历史的的排序依据。
TotalCount	Integer	2	时间段内的告警记录总数。

AlertGroupVO

参数	类型	示例值	描述
RuleId	String	1574655386982******	产生此告警消息的告警规则 ID。
RuleName	String	rule-01	告警策略名称。
Level	String	notice	告警策略级别。
Region	String	cn-beijing	告警所在的地域。
Namespace	String	VCM_Kafka	告警策略绑定的资源类型。
ResourceType	String	消息队列Kafka版	告警策略绑定的资源类型中文名。
SubNamespace	String	Instance	告警策略绑定的资源类型子分类。
Dimension	String	实例	告警策略绑定的资源类型子分类中文名。
AlertState	String	normal	当前的告警状态。 normal：已恢复 alerting：告警中说明如果最近 5 分钟内没有产生告警，系统会认为此资源的告警状态为已恢复。
ResourceId	String	kafka-cn-4ia***xia	告警资源的 ID。
ResourceName	String	kafka-cn-4ia***xia	告警资源的名称。
StartAt	String	2022-09-27T07:01:44.676Z	告警开始时间。时间格式为 RFC 3399，时区为 UTC+0。
EndAt	String	2022-09-27T07:02:43.289Z	告警结束时间。时间格式为 RFC 3399，时区为 UTC+0。
Duration	String	59s	告警持续时间。
Id	String	6735665**********a2f157	告警历史 ID。
AlertType	String	nodata	告警类型。 alert：阈值告警 nodata：无数据告警 alert_recovery：阈值告警已恢复 nodata_recovery：无数据告警已恢复

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****44C52",
        "Action": "ListAlertGroup",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": "cn-beijing"
    },
    "Result": {
        "Data": [
            {
                "Namespace": "VCM_Kafka",
                "ResourceType": "消息队列Kafka版",
                "SubNamespace": "Instance",
                "Dimension": "实例",
                "AlertState": "normal",
                "ResourceId": "kafka-cn-4ia***xia",
                "ResourceName": "kafka-cn-4ia***xia",
                "StartAt": "2022-09-27T03:39:43.025Z",
                "EndAt": "2022-09-27T03:39:42.244Z",
                "Duration": "0s",
                "Id": "6735665**********a2f157",
                "Level": "notice",
                "Region": "cn-beijing",
                "RuleId": "15743*****768640",
                "RuleName": "rule-01"
            }
        ],
        "PageNumber": 1,
        "PageSize": 30,
        "TotalCount": 2,
        "OrderBy": "",
        "Asc": false
    }
}

错误码

本接口无特有的错误码，更多信息请参见错误码。