You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /
  • 云监控

ListAlertGroup

最近更新时间：2024.04.10 15:10:55

首次发布时间：2022.10.27 19:53:20

我的收藏

调用ListAlertGroup接口查询资源的告警历史列表。

注意事项

每条记录以资源为最小单位，如果一条告警策略下面的N个资源告警，那么会有N条记录。最多返回5000条记录。

Request URL

POST https://open.volcengineapi.com?Action=ListAlertGroup&Version=2018-01-01


ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

参数

类型

是否必填

示例值

描述

StartAt

Interger

否

1664176020

查询的告警消息发生的最早时间。格式为时间戳，秒级。
如果不填，最早时间是当前时间的前7天开始。

EndAt

Interger

否

1664262420

查询的告警消息发生的最晚时间。格式为时间戳，秒级。
如果不填，则为当前时间。

说明

StartAt与EndAt间隔须大于等于1分钟，如果小于1分钟，则默认查询过去7天的数据。

RuleIds

Array

否

["15753124985155*****"]

根据RuleId查询对应告警策略产生的告警消息。可传递多个。
如果使用RuleId，就不会使用Namespaces、Levels、RuleName过滤参数。

ResourceId

String

否

kafka-cn-4ia***xia

告警资源的ID。

Namespaces

Array

否

["VCM_Kafka"]

查询资源类型为指定Namespace的告警策略产生的告警消息。可多选。

Levels

Array

否

["warning","notice"]

查询告警级别为指定Level的告警策略产生的告警消息。可多选。

RuleName

String

否

测试

查询告警名称为指定的告警策略产生的告警消息。模糊匹配。

AlertStates

Array

否

["normal"]

查询告警状态为指定状态的告警策略产生的告警消息。可多选。

  • alerting：告警中
  • normal：已恢复

PageNumber

Interger

否

1

从第几页开始。
如果不填则不分页。

PageSize

Interger

否

10

每页的数据行数。
如果不填则只返回前10条。

返回参数

参数

类型

示例值

说明

Data

Array

-

返回数据。具体格式，请参见Data数据结构。

PageNumber

Interger

1

当前页码。

PageSize

Interger

10

当前分页的行数。

TotalCount

Interger

2

时间段内的告警记录总数。

OrderBy

String

-

告警历史的的排序依据。

Asc

Boolean

false

告警历史的排序方式。

Data数据结构

参数

类型

示例值

描述

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

当前的告警状态。
当最近5分钟内没有产生告警的话，系统会认为此资源的告警状态为已恢复。

  • normal：已恢复
  • alerting：告警中

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

告警持续时间。

请求示例

POST https://open.volcengineapi.com?Action=ListAlertGroup&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "StartAt":1664335767,
    "EndAt":1664422167,
    "ResourceId":"kafka-cn-4ia***xia",
    "PageSize":10,
    "PageNumber":1
}

返回示例

{
    "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",
                "Level":"notice",
                "Region":"cn-beijing",
                "RuleId":"15743*****768640",
                "RuleName":"rule-01"
            }
        ],
        "PageNumber":1,
        "PageSize":10,
        "TotalCount":1,
        "OrderBy":"",
        "Asc":false
    }
}