文档

ListAlerts - 查询告警发送历史

更新时间:

调用ListAlerts接口查询告警发送历史。

调试

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

授权信息

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

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

请求参数

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

告警名称。

告警测试
Statelong

告警状态:

  • 0:待处理
  • 1:处理中
  • 2:已处理
2
Severitystring

告警等级。告警严重程度从 P6、P5、P4、P3、P2、P1 逐级上升。

P6
DispatchRuleIdlong

通知策略 ID。

12345
IntegrationTypestring

集成类型。

  • ARMS
  • CLOUD_MONITOR
  • MSE
  • ARMS_CLOUD_DIALTEST
  • PROMETHEUS
  • LOG_SERVICE
  • CUSTOM
  • ARMS_PROMETHEUS
  • ARMS_APP_MON
  • ARMS_FRONT_MON
  • ARMS_CUSTOM
  • XTRACE
  • GRAFANA
  • ZABBIX
  • SKYWALKING
  • EVENT_BRIDGE
  • NAGIOS
  • OPENFALCON
  • ARMS_INSIGHTS
ARMS_APP_MON
StartTimestring

查询告警发送历史记录的开始时间,时间格式为YYYY-MM-DD HH:mm:ss

2021-12-10 00:00:00
EndTimestring

查询告警发送历史记录的结束时间,时间格式为YYYY-MM-DD HH:mm:ss

2021-12-22 23:59:59
ShowEventsboolean

是否查询告警对应的事件。

  • false(默认):不查询事件。
  • true:查询事件。
true
ShowActivitiesboolean

是否查询告警对应的活动记录。

  • false(默认):不查询活动记录。
  • true:查询活动记录,仅查询近 3 天的活动记录。
true
Pagelong

查询页数。

1
Sizelong

每页展示的告警数。

20
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2FC13182-B9AF-4E6B-BE51-72669B7C****
PageBeanobject

返回结构体。

Totallong

查询到的告警总数。

1
Pagelong

查询页数。

1
Sizelong

每页展示的告警数。

20
ListAlertsarray<object>

告警发送历史信息组。

object

返回对象结构体。

AlertNamestring

告警名称。

告警测试
Severitystring

告警等级。告警严重程度从 P6、P5、P4、P3、P2、P1 逐级上升。

P6
Statelong

告警状态:

  • 0:待处理
  • 1:处理中
  • 2:已处理
0
DispatchRuleIdfloat

通知策略 ID。

12345
DispatchRuleNamestring

通知策略名称。

钉群通知
CreateTimestring

告警创建时间。

2022-01-18 00:21:35
Activitiesarray<object>

活动列表。

object

活动对象。

Timestring

活动操作时间。

2021-12-20 19:08:57
Typelong

活动类型。

  • 1:认领
  • 2:取消认领
  • 3:评论
  • 4:关闭
  • 5:通知
1
HandlerNamestring

处理人名称。

运维A
Descriptionstring

活动描述。

[告警认领]认领了该告警
Contentstring

告警通知内容。

【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
AlertEventsarray<object>

事件列表。

object

事件对象。

AlertNamestring

事件名称。

测试触发的告警
Severitystring

事件等级。

  • critical
  • error
  • warning
  • info
warning
Statestring

事件状态。

  • Active:未恢复
  • Silenced:静默
  • Resolved:已恢复
Active
StartTimestring

事件开始时间。

2022-01-18 00:14:00
EndTimestring

事件结束时间。

2022-01-19 17:10:31
ReceiveTimestring

事件创建时间。

2022-01-19 17:05:42
IntegrationNamestring

事件对应的集成名称。

ARMS
IntegrationTypestring

事件对应的集成类型。

  • ARMS
  • CLOUD_MONITOR
  • MSE
  • ARMS_CLOUD_DIALTEST
  • PROMETHEUS
  • LOG_SERVICE
  • CUSTOM
  • ARMS_PROMETHEUS
  • ARMS_APP_MON
  • ARMS_FRONT_MON
  • ARMS_CUSTOM
  • XTRACE
  • GRAFANA
  • ZABBIX
  • SKYWALKING
  • EVENT_BRIDGE
  • NAGIOS
  • OPENFALCON
  • ARMS_INSIGHTS
ARMS_APP_MON
GeneratorURLstring

事件地址。

http://arms.console.aliyun.com
Descriptionstring

事件描述。

主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %
Annotationsstring

注释列表。

{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}
Labelsstring

标签列表。

{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}
AlertIdlong

告警 ID

2279
Solutionstring

告警解决方案

重启解决

示例

正常返回示例

JSON格式

{
  "RequestId": "2FC13182-B9AF-4E6B-BE51-72669B7C****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "ListAlerts": [
      {
        "AlertName": "告警测试",
        "Severity": "P6",
        "State": 0,
        "DispatchRuleId": 12345,
        "DispatchRuleName": "钉群通知",
        "CreateTime": "2022-01-18 00:21:35",
        "Activities": [
          {
            "Time": "2021-12-20 19:08:57",
            "Type": 1,
            "HandlerName": "运维A",
            "Description": "[告警认领]认领了该告警",
            "Content": "【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %"
          }
        ],
        "AlertEvents": [
          {
            "AlertName": "测试触发的告警",
            "Severity": "warning",
            "State": "Active",
            "StartTime": "2022-01-18 00:14:00",
            "EndTime": "2022-01-19 17:10:31",
            "ReceiveTime": "2022-01-19 17:05:42",
            "IntegrationName": "ARMS",
            "IntegrationType": "ARMS_APP_MON",
            "GeneratorURL": "http://arms.console.aliyun.com",
            "Description": "主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %",
            "Annotations": "{ \"_aliyun_arms_alert_value\":\"4.0\" \"_aliyun_arms_alert_traceId\":\"ac10c43116421327442277073d5461-105075299\"}",
            "Labels": "{ \"severity\":\"warning\" \"_aliyun_arms_alert_level\":\"ERROR\" \"_aliyun_arms_entropy\":\"0.30170457417889235\"}"
          }
        ],
        "AlertId": 2279,
        "Solution": "重启解决",
        "Owner": "",
        "Handler": "",
        "AcknowledgeTime": 0,
        "RecoverTime": 0,
        "NotifyRobots": "",
        "Describe": ""
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-11OpenAPI 返回结构发生变更查看变更详情
2023-12-08OpenAPI 返回结构发生变更查看变更详情
2023-12-08OpenAPI 返回结构发生变更查看变更详情
2023-08-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-05-25OpenAPI 返回结构发生变更查看变更详情
2023-05-11OpenAPI 返回结构发生变更查看变更详情
2022-01-14新增 OpenAPI查看变更详情