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

更改报警器状态

更改报警器状态

PUT/zstack/v1/zwatch/alarms/{uuid}/actions

操作 ID

ChangeAlarmState

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • uuid
    String必填

    资源的UUID，唯一标示该资源

请求体字段

  • stateEvent
    String必填

    状态事件

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

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

  • inventory
    AlarmInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String必填

      资源的详细描述

    • period
      Integer必填

      阈值持续时间

    • namespace
      String必填

      名字空间

    • metricName
      String必填

      监控项名称

    • threshold
      Double必填

      阈值

    • repeatInterval
      Integer必填

      报警重复时间

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • comparisonOperator
      ComparisonOperator必填

      详情参考comparisonOperator

      • name
        String必填

        资源名称

      • ordinal
        int必填

        ordinal数量。

    • status
      AlarmStatus必填

      详情参考status

      • OK
        AlarmStatus必填

        监控中

      • Alarm
        AlarmStatus必填

        已触发

      • InsufficientData
        AlarmStatus必填

        数据不足

    • labels
      List必填

      详情参考labels

      • uuid
        String必填

        资源的UUID，唯一标示该资源

      • key
        String必填

        标签键

      • operator
        String必填

        比较符

      • value
        String必填

        标签值

    • actions
      List必填

      详情参考actions

      • alarmUuid
        String必填

        报警器UUID

      • actionType
        String必填

        报警动作类型

      • actionUuid
        String必填

        报警动作UUID