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

查询资源报警器报警记录

查询资源报警器报警记录

GET/zstack/v1/zwatch/alarm-records

操作 ID

QueryAlarmRecord

起始版本

4.1.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • q
    String

    查询条件。

响应状态

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

  • histograms
    List必填

    暂无描述。

  • id
    long必填

    消息ID

  • createTime
    long必填

    创建时间

  • accountUuid
    String必填

    账户UUID

  • alarmName
    String必填

    报警器名称

  • alarmStatus
    String必填

    报警状态

  • alarmUuid
    String必填

    报警器UUID

  • comparisonOperator
    String必填

    阈值比较符

  • context
    String必填

    内容

  • dataUuid
    String必填

    消息UUID

  • emergencyLevel
    String必填

    报警等级

  • labels
    String必填

    标签列表

  • metricName
    String必填

    监控项名称

  • metricValue
    Double必填

    监控项值

  • namespace
    String必填

    名字空间

  • period
    int必填

    阈值持续时间

  • readStatus
    Boolean必填

    已读状态

  • resourceUuid
    String必填

    资源UUID

  • threshold
    Double必填

    阈值

  • 变更时间

    新增响应字段 accountUuid, alarmName, alarmStatus...
    查看 API