文档

DescribeAlertLogList - 查询报警历史

更新时间:

调用DescribeAlertLogList接口查询报警历史。

接口说明

该接口只能查询到最近一年的报警历史。

本文将提供一个示例,从云产品product维度查询云服务器 ECS 的报警历史。

调试

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

授权信息

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

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

请求参数

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

查询报警历史的开始时间戳。

单位:毫秒。

您只能查询最近一年的报警历史,如果查询时间大于一年,则参数AlertLogList的返回值为空。

说明 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于 15 天,并且需要同时填写或同时不填写。如果不填,则默认查询最近 15 分钟的报警历史。
1609988009694
EndTimelong

查询报警历史的结束时间戳。

单位:毫秒。

您只能查询最近一年的报警历史,如果查询时间大于一年,则参数AlertLogList的返回值为空。

说明 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于 15 天,并且需要同时填写或同时不填写。如果不填,则默认查询最近 15 分钟的报警历史。
1610074409694
PageNumberinteger

页码。

默认值:1。

1
PageSizeinteger

分页大小。

默认值:10。

10
SearchKeystring

查询报警历史的搜索关键字。

alert
GroupIdstring

应用分组 ID。

7301****
Namespacestring

云产品的命名空间。

说明 关于云产品的命名空间,请参见云产品监控项
acs_ecs_dashboard
Productstring

云产品名称缩写。

关于如何获取云产品名称缩写,请参见 DescribeProductsOfActiveMetricRule

ECS
Levelstring

报警的级别和通知方式。取值:

  • P2:电话+短信+邮件+钉钉机器人。

  • P3:短信+邮件+钉钉机器人。

  • P4:邮件+钉钉机器人。

  • OK:无报警。

P4
SendStatusstring

报警状态。取值:

  • 0:发生报警或报警恢复正常。
  • 1:非生效期。
  • 2:通道沉默周期。
  • 3:主机重启中。
  • 4:不发送报警。

当报警状态为 0 时,如果 Level 的取值为 P2、P3 或 P4,则发生告警;如果 Level 的取值为 OK,则报警恢复正常。

0
ContactGroupstring

报警联系人组。

ECS_Group
RuleNamestring

报警规则名称。

test123
MetricNamestring

监控项名称。

说明 关于云产品的监控项,请参见云产品监控项
IntranetInRate
LastMinstring

获取日志的周期。单位:分钟。

360
GroupBystring

对数据进行空间维度聚合,相当于 SQL 中的 Group By。取值:

  • product:按照云产品统计。
  • level:按照报警级别统计。
  • groupId:按照应用分组统计。
  • contactGroup:按照报警联系人组统计。
  • product,metricName:按照云产品和监控项统计。
product
RuleIdstring

报警规则 ID。

关于如何查询报警规则 ID,请参见 DescribeMetricRuleList

bc369e8_30f87e517ed2fc****
SourceTypestring

报警规则类型。取值:METRIC,表示时序指标报警规则。

METRIC
EventTypestring

告警类型。取值:

  • TRIGGERED:告警触发。

  • RESOLVED:告警恢复。

TRIGGERED

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

1C4A3709-BF52-42EE-87B5-7435F0929585
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The specified resource is not found.
PageNumberinteger

页码。

1
PageSizeinteger

每页显示记录条数。

10
AlertLogListobject []

报警历史列表。

MetricNamestring

监控项名称。

cpu_total
EventNamestring

事件名称。

IOHang
Productstring

云产品标识。取值:

  • 如果是阿里云产品,则为云产品名称缩写,例如:ECS。

  • 如果非阿里云产品,则为acs_产品关键字,例如:acs_networkmonitor。

ECS
BlackListUUIDstring

命中的报警黑名单 UUID。

8410dbbd-7d30-41c5-94cb-****
Messagestring

报警相关信息,为一个 JSON 串。

{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}
Namespacestring

云产品的命名空间。

acs_ecs_dashboard
LevelChangestring

报警级别的变更。取值:

  • P4->OK:由 P4 级别报警到报警恢复。
  • P4->P4:P4 级别报警。
P4->OK
InstanceIdstring

资源 ID。

i-m5e1qg6uo38rztr4****
RuleNamestring

报警规则名称。

CPU使用率
RuleIdstring

报警规则 ID。

d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime
BlackListNamestring

命中的报警黑名单名称。

Black_Test
GroupNamestring

应用分组名称。

ECS_Instances
GroupIdstring

应用分组 ID。

7301****
AlertTimestring

发生报警的时间戳。

单位:毫秒。

1610043776621
InstanceNamestring

资源名称。

portalHost
BlackListDetailstring

命中的报警黑名单详情。

{"id":12****,"metricProject":"acs_ecs_dashboard","userId":173651113438****,"uuid":"8410dbbd-7d30-41c5-94cb-****","name":"alert-****","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4****"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}
Levelstring

报警级别和报警通知方式。取值:

  • P2:电话+短信+邮件+钉钉机器人。

  • P3:短信+邮件+钉钉机器人。

  • P4:邮件+钉钉机器人。

  • OK:无报警。

P4
SendStatusstring

报警状态。取值:

  • 0:发生报警或报警恢复正常。
  • 1:非生效期。
  • 2:通道沉默周期。
  • 3:主机重启中。
  • 4:不发送报警。

当报警状态为 0 时,如果 Level 的取值为 P2、P3 或 P4,则发生告警;如果 Level 的取值为 OK,则报警恢复正常。

0
ExtendedInfoobject []

报警的扩展信息。

Namestring

扩展字段名称。

userId
Valuestring

扩展字段值。

100931896542****
Dimensionsobject []

报警资源的维度。

Keystring

报警资源的 Key。

instanceId
Valuestring

报警资源的 Value。

i-m5e1qg6uo38rztr4****
WebhookListobject []

报警回调的 URL 地址列表。

codestring

报警回调的状态码。

200
urlstring

报警回调的 URL 地址。

https://www.aliyun.com/webhook.html
messagestring

报警回调的返回信息。

success
DingdingWebhookListarray
string

报警联系人的 Webhook 地址列表。

https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****
ContactOnCallListarray
string

报警联系人的电话通知列表。

说明 该参数仅适用于中国站。
1368888****
ContactMailListarray
string

报警联系人的邮件列表。

username@example.com
ContactGroupsarray
string

报警联系人组。

ECS_Group
ContactALIIWWListarray
string

报警联系人的旺旺列表。

说明 该参数仅适用于中国站。
Alice
ContactSMSListarray
string

报警联系人的短信通知列表。

说明 该参数仅适用于中国站。
1368888****
ContactDingListarray
string

报警联系人的钉钉列表。

CloudMonitor
SendDetailobject

报警推送结果详情。

ResultCodestring

报警信息推送状态。

  • success:推送成功。

  • 错误码:当配置错误时,无推送列表,显示错误码。

success
ChannelResultListobject []

按报警渠道推送的报警结果列表。

Channelstring

报警推送渠道。取值:

  • MAIL:邮件。

  • SMS:短信。

  • WEBHOOK:报警回调。

  • SLS:日志服务。

  • ONCALL:电话。

  • FC:函数计算

  • MNS:消息队列。

MAIL
ResultListobject []

云监控向报警渠道发送的报警信息结果列表。

Codestring

状态码。

  • ChannelWEBHOOK时,状态码为 200 或 500。

  • ChannelMAILSMSSLSONCALLFCMNS时,无该参数,或该参数为空。

200
RequestIdstring

调用其他云产品返回的请求 ID。

0BDAF8A8-04DC-5F0C-90E4-724D42C4****
Successboolean

调用目标的结果

  • true 成功

  • false 失败

true
Detailstring

返回结果详情。

{ }
notifyTargetListarray
string

渠道通知列表。

MAIL
Escalationobject

触发报警的规则。

Expressionstring

触发报警的规则描述。

说明 报警规则的主体,当监控数据满足报警条件时,触发报警规则。
$Average<90
Timesinteger

报警重试次数。

1
Levelstring

报警级别和报警通知方式。取值:

  • P2:电话+短信+邮件+钉钉机器人。

  • P3:短信+邮件+钉钉机器人。

  • P4:邮件+钉钉机器人。

  • OK:无报警。

P4
SendResultListobject []

报警的发送结果列表。

Keystring

发送报警渠道。取值:

  • MAIL:邮件。
  • ALIIM:旺旺。
  • SMS:短信。
  • CALL:电话。
  • DING:钉钉机器人。
  • Merged:报警合并。
MAIL
Valuearray

报警渠道对应的通知对象。

string

报警渠道对应的通知对象。

username@example.com
LogIdstring

日志 ID。

7510****::e8a472a0-46ae-4ac0-84b1-e46be368****

示例

正常返回示例

JSON格式

{
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 10,
  "AlertLogList": [
    {
      "MetricName": "cpu_total",
      "EventName": "IOHang",
      "Product": "ECS",
      "BlackListUUID": "8410dbbd-7d30-41c5-94cb-****",
      "Message": "{\"alertName\":\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\"}",
      "Namespace": "acs_ecs_dashboard",
      "LevelChange": "P4->OK",
      "InstanceId": "i-m5e1qg6uo38rztr4****",
      "RuleName": "CPU使用率",
      "RuleId": "d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime",
      "BlackListName": "Black_Test",
      "GroupName": "ECS_Instances",
      "GroupId": "7301****",
      "AlertTime": "1610043776621",
      "InstanceName": "portalHost",
      "BlackListDetail": "{\"id\":12****,\"metricProject\":\"acs_ecs_dashboard\",\"userId\":173651113438****,\"uuid\":\"8410dbbd-7d30-41c5-94cb-****\",\"name\":\"alert-****\",\"productCategory\":\"ecs\",\"instances\":[{\"instanceId\":\"i-m5e1qg6uo38rztr4****\"}],\"metrics\":null,\"scopeType\":\"USER\",\"scopeValue\":\"\",\"startTime\":\"0001-01-01T00:00:00Z\",\"endTime\":\"9999-12-31T23:59:59.999999999+08:00\",\"effectiveTime\":null,\"isEnable\":true,\"status\":1,\"gmtCreate\":\"2021-11-02T16:35:59+08:00\",\"gmtModified\":\"2021-11-02T16:35:59+08:00\",\"loadTime\":\"2021-11-02T16:36:15.213072177+08:00\"}",
      "Level": "P4",
      "SendStatus": "0",
      "ExtendedInfo": [
        {
          "Name": "userId",
          "Value": "100931896542****"
        }
      ],
      "Dimensions": [
        {
          "Key": "instanceId",
          "Value": "i-m5e1qg6uo38rztr4****"
        }
      ],
      "WebhookList": [
        {
          "code": "200",
          "url": "https://www.aliyun.com/webhook.html",
          "message": "success"
        }
      ],
      "DingdingWebhookList": [
        "https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****"
      ],
      "ContactOnCallList": [
        "1368888****"
      ],
      "ContactMailList": [
        "username@example.com"
      ],
      "ContactGroups": [
        "ECS_Group"
      ],
      "ContactALIIWWList": [
        "Alice"
      ],
      "ContactSMSList": [
        "1368888****"
      ],
      "ContactDingList": [
        "CloudMonitor"
      ],
      "SendDetail": {
        "ResultCode": "success",
        "ChannelResultList": [
          {
            "Channel": "MAIL",
            "ResultList": [
              {
                "Code": "200",
                "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C4****",
                "Success": true,
                "Detail": "{ }",
                "notifyTargetList": [
                  "MAIL"
                ]
              }
            ]
          }
        ]
      },
      "Escalation": {
        "Expression": "$Average<90",
        "Times": 1,
        "Level": "P4"
      },
      "SendResultList": [
        {
          "Key": "MAIL",
          "Value": [
            "username@example.com"
          ]
        }
      ],
      "LogId": "7510****::e8a472a0-46ae-4ac0-84b1-e46be368****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
409ResourceConflictConcurrent modification of resources.-
409ResourceExistResources already exist.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:EventType
2023-07-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:SourceType
2022-09-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:409
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)