文档

SearchAlertHistories - 查询报警规则的报警发送记录

更新时间:

调用SearchAlertHistories接口查询报警规则的报警发送记录。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

报警规则 ID,可调用 SearchAlertRules 接口获取(对应返回参数中的Id),详情请参见 SearchAlertRules

123
AlertTypeinteger

报警规则类型:

  • 1:基于下钻数据集的自定义监控报警规则。
  • 3:基于平铺数据集的自定义监控报警规则。
  • 4:前端监控报警规则,包含默认前端监控报警规则(AlertType=6)。
  • 5:应用监控报警规则,包含默认应用监控报警规则(AlertType=7)。
  • 6:默认前端监控报警规则。
  • 7:默认应用监控报警规则。
  • 8:链路追踪 Tracing Analysis 报警规则。
  • 101:Prometheus 报警规则。
4
CurrentPageinteger

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

1
PageSizeinteger

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

10
RegionIdstring

地域 ID。默认为cn-hangzhou

cn-hangzhou
StartTimelong

查询报警历史记录的开始时间的时间戳。格式为 Unix Timestamp Long,单位为毫秒。默认为当前时间的前 10 分钟。

1595568910000
EndTimelong

查询报警历史记录的结束时间的时间戳。格式为 Unix Timestamp Long,单位为毫秒。默认为当前时间。

1579499626000

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

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

返回结构体

PageNumberinteger

查询结果分页的页码

1
PageSizeinteger

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

10
TotalCountinteger

查询结果总数

2
AlarmHistoriesobject []

报警历史对象列表

AlarmTimelong

报警发送时间

1595564179000
StrategyIdstring

内部字段

""
AlarmResponseCodeinteger

报警投递返回的状态码

200
Emailsstring

接收报警的邮箱地址

someone@example.com
UserIdstring

用户 ID

113197164949****
AlarmSourcesstring

报警 Webhook(如钉钉机器人 Webhook 地址)

https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****
AlarmContentstring

报警内容

"报警名称:Alert1\n报警时间:2020-07-24 12:14:00\n报警内容:共有4条记录触发异常:****"
Phonesstring

接收报警的手机号码

1381111****
AlarmTypeinteger

报警规则类型(默认为 4):

  • 1:基于下钻数据集的自定义监控报警规则。
  • 3:基于平铺数据集的自定义监控报警规则。
  • 4:前端监控报警规则,包含默认前端监控报警规则(AlertType=6)。
  • 5:应用监控报警规则,包含默认应用监控报警规则(AlertType=7)。
  • 6:默认前端监控报警规则。
  • 7:默认应用监控报警规则。
  • 8:链路追踪 Tracing Analysis 报警规则。
  • 101:Prometheus 监控报警规则。
4
Targetstring

内部字段

""
Idlong

报警发送记录 ID

123

示例

正常返回示例

JSON格式

{
  "RequestId": "2FC13182-B9AF-4E6B-BE51-72669B7C****",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 2,
    "AlarmHistories": [
      {
        "AlarmTime": 1595564179000,
        "StrategyId": "\"\"",
        "AlarmResponseCode": 200,
        "Emails": "someone@example.com",
        "UserId": "113197164949****",
        "AlarmSources": "https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****",
        "AlarmContent": "\"报警名称:Alert1\\n报警时间:2020-07-24 12:14:00\\n报警内容:共有4条记录触发异常:****\"",
        "Phones": "1381111****",
        "AlarmType": 4,
        "Target": "\"\"",
        "Id": 123
      }
    ]
  }
}

错误码

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

变更历史

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