跳转到主要内容
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/报警器(Alarm)

获取资源报警器历史

获取资源报警器历史

GET/zstack/v1/zwatch/alarm-histories

操作 ID

GetAlarmData

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • startTime
    Long

    起始时间

  • endTime
    Long

    结束时间

  • limit
    Integer

    返回记录条数数量

  • conditions
    List

    条件列表,用于过滤结果

  • count
    boolean

    是否查询消息数量

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • histories
    List必填

    详情参考histories

    • alarmUuid
      String必填

      报警器UUID

    • namespace
      String必填

      名字空间名称

    • metricName
      String必填

      监控项名称

    • accountUuid
      String必填

      账户UUID

    • resourceUuid
      String必填

      资源UUID

    • resourceType
      String必填

      资源类型

    • alarmStatus
      String必填

      报警器状态

    • alarmName
      String必填

      报警器名称

    • threshold
      Double必填

      报警阈值

    • period
      Integer必填

      阈值持续周期

    • labels
      String必填

      标签列表

    • metricValue
      Double必填

      监控项当时值

    • time
      long必填

      报警纪录生成时间

  • 变更时间

    新增请求参数 start
    查看 API