You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API参考/告警历史/ListAlertGroup
ListAlertGroup
最近更新时间：2024.11.15 15:29:40首次发布时间：2022.10.27 19:53:20
我的收藏

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

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=ListAlertGroup&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是ListAlertGroup接口名称。当前 API 的名称为 ListAlertGroup。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。

Body

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

StartAt

Integer

否

1664176020

查询的告警消息发生的最早时间。格式为时间戳，秒级。

如果不填，最早时间是当前时间的前7天开始。

EndAt

Integer

否

1664262420

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

说明

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

RuleIds

Array of String

否

["15753124985155*****"]

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

ResourceIdString否kafka-cn-4ia***xia告警资源的ID。
NamespacesArray of String否["VCM_Kafka"]查询资源类型为指定Namespace的告警策略产生的告警消息。可多选。
LevelsArray of String否["warning","notice"]查询告警级别为指定Level的告警策略产生的告警消息。可多选。
RuleNameString否测试查询告警名称为指定的告警策略产生的告警消息。模糊匹配。

AlertStates

Array of String

否

["normal"]

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

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

PageNumber

Integer

否

1

列表的页码，取值 > 0，默认值为1。要查询的列表范围为：

  • 实际起始位置 = (PageNumber-1) * PageSize
  • 实际终止位置 = PageNumber * PageSize
PageSizeInteger否10分页查询时每页的行数，默认值为10。

返回参数

参数类型示例值描述
AscBooleanfalse告警历史的排序方式。
DataArray of AlertGroupVO-返回数据。
OrderByString-告警历史的的排序依据。
PageSizeInteger30分页查询参数，用于设置每页行数。默认值：30。
PageNumberInteger1分页查询参数，用于设置当前页码。默认值：1。
TotalCountInteger2时间段内的告警记录总数。

AlertGroupVO

参数类型示例值描述
RuleIdString1574655386982******产生此告警消息的告警规则ID。
RuleNameStringrule-01告警策略名称。
LevelStringnotice告警策略级别。
RegionStringcn-beijing告警所在的地域。
NamespaceStringVCM_Kafka告警策略绑定的资源类型。
ResourceTypeString消息队列Kafka版告警策略绑定的资源类型中文名。
SubNamespaceStringInstance告警策略绑定的资源类型子分类。
DimensionString实例告警策略绑定的资源类型子分类中文名。

AlertState

String

normal

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

  • normal：已恢复
  • alerting：告警中
ResourceIdStringkafka-cn-4ia***xia告警资源的ID。
ResourceNameStringkafka-cn-4ia***xia告警资源的名称。
StartAtString2022-09-27T07:01:44.676Z告警开始时间。时间格式为RFC 3399，时区为UTC+0。
EndAtString2022-09-27T07:02:43.289Z告警结束时间。时间格式为RFC 3399，时区为UTC+0。
DurationString59s告警持续时间。
IdString6735665**********a2f157告警历史ID。

AlertType

String

nodata

告警类型。

  • alert：阈值告警
  • nodata：无数据告警
  • alert_recovery：阈值告警已恢复
  • nodata_recovery：无数据告警已恢复

请求示例

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

错误码

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