文档

ListActivatedAlerts - 查询已经触发的告警列表

更新时间:

调用ListActivatedAlerts接口查询已经触发的告警列表。

接口说明

当前接口已不再维护,请使用新版告警管理的 ListAlerts 接口查询告警发送历史。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:ListActivatedAlertsWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Filterstring

筛选条件,格式为{"key":"value"}。需要设置筛选条件的keyvalue

{"alertname":"容器CPU使用率大于80%"}
RegionIdstring

地域 ID。

cn-hangzhou
CurrentPageinteger

查询结果分页的页码。默认为1

1
PageSizeinteger

查询结果分页的每页项目数量。默认为10

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

BDB74B8F-4123-482A-ABB7-7F440349****
Pageobject

返回结构体。

PageSizeinteger

查询结果分页的每页项目数量。

20
Totalinteger

查询结果总数。

5
Pageinteger

查询结果分页页码。

1
Alertsobject []

告警信息。

Statusstring

告警状态。取值:

  • Active:未恢复。
  • Inhibited:抑制。
  • Silenced:静默。
  • Resolved:已恢复。
Active
Severitystring

告警等级。取值:

  • critical:严重。
  • error:错误。
  • warn:警告。
  • page:通知。
critical
IntegrationNamestring

告警关联对象名称。

testphp2
CreateTimelong

告警规则创建时间的时间戳。

1616466300000
Messagestring

告警描述信息。

报警名称:PodRestart_testphp2,\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%
AlertTypestring

告警类型。

ARMS-Prometheus监控
InvolvedObjectNamestring

告警来源集成的名称。

测试集成-prometheus
AlertNamestring

告警规则名称。

容器CPU使用率大于80%
Countinteger

告警事件接受次数。

598
ExpandFieldsobject

扩展字段(标签),标签来源包括:

  • 报警规则表达式指标中携带的标签。
  • 通过报警规则创建的标签。
  • ARMS 系统自带的默认标签。
"severity": "critical", "_aliyun_arms_alert_level": "ERROR", "pod": "night-test-group-1-1-5f5d6f4d84-pszns", "_aliyun_arms_alert_type": "101", "_aliyun_arms_integration_name": "测试集成-prometheus", "alertname": "PodRestart_jiubiantestphp2", "_aliyun_arms_userid": "1131971649496228", "_aliyun_arms_involvedObject_name": "jiubiantestphp2", "_aliyun_arms_involvedObject_id": "ccafb2763cfa7415eb2e2a60a74b1f825", "_aliyun_arms_region_id": "cn-beijing", "_aliyun_arms_involvedObject_kind": "cluster", "_aliyun_arms_product_type": "PROMETHEUS", "namespace": "default", "_aliyun_arms_integration_id": "80", "_aliyun_arms_involvedObject_type": "ManagedKubernetes", "_aliyun_arms_alert_rule_id": "3612229"
EndsAtlong

告警结束时间。

1616502540000
InvolvedObjectKindstring

告警关联对象类型。

cluster
IntegrationTypestring

告警来源集成的类型。

PROMETHEUS
StartsAtlong

告警开始时间。

1616466300000
AlertIdstring

告警规则 ID。

3888704
DispatchRulesobject []

通知策略。

RuleIdinteger

通知策略 ID。

7021
RuleNamestring

通知策略名称。

容器CPU使用率大于80%的通知策略

示例

正常返回示例

JSON格式

{
  "RequestId": "BDB74B8F-4123-482A-ABB7-7F440349****",
  "Page": {
    "PageSize": 20,
    "Total": 5,
    "Page": 1,
    "Alerts": [
      {
        "Status": "Active",
        "Severity": "critical",
        "IntegrationName": "testphp2",
        "CreateTime": 1616466300000,
        "Message": "报警名称:PodRestart_testphp2,\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%",
        "AlertType": "ARMS-Prometheus监控",
        "InvolvedObjectName": "测试集成-prometheus",
        "AlertName": "容器CPU使用率大于80%",
        "Count": 598,
        "ExpandFields": {
          "test": "test",
          "test2": 1
        },
        "EndsAt": 1616502540000,
        "InvolvedObjectKind": "cluster",
        "IntegrationType": "PROMETHEUS",
        "StartsAt": 1616466300000,
        "AlertId": "3888704",
        "DispatchRules": [
          {
            "RuleId": 7021,
            "RuleName": "容器CPU使用率大于80%的通知策略"
          }
        ]
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈