创建报警器

POST/zstack/v1/zwatch/alarms

操作 ID

CreateAlarm

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

params
Object必填
请求体参数结构
- name
  String必填
  资源名称
- description
  String
  资源的详细描述
- comparisonOperator
  String必填
  阈值比较符
- period
  Integer
  阈值持续时间
- namespace
  String必填
  名字空间
- metricName
  String必填
  监控项名
- threshold
  Double必填
  阈值
- repeatInterval
  Integer
  报警重复时间
- labels
  List
  标签列表
- actions
  List
  报警动作列表
- resourceUuid
  String
  可选。
- repeatCount
  Integer
  报警重复次数
- type
  String
  报警器类型
- enableRecovery
  Boolean必填
  开启恢复通知
- emergencyLevel
  String
  报警等级
systemTags
List
系统标签
userTags
List
用户标签

响应状态

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必填
  报警重复时间
- enableRecovery
  Boolean必填
  开启恢复通知
- 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

请求示例

curl -X POST '{host}/zstack/v1/zwatch/alarms' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "description": "{description}",
    "comparisonOperator": "{comparisonOperator}",
    "period": "{period}",
    "namespace": "{namespace}",
    "metricName": "{metricName}",
    "threshold": "{threshold}",
    "repeatInterval": "{repeatInterval}",
    "labels": [
      "{labels}"
    ],
    "actions": [
      "{actions}"
    ],
    "resourceUuid": "{resourceUuid}",
    "repeatCount": "{repeatCount}",
    "type": "{type}",
    "enableRecovery": "{enableRecovery}",
    "emergencyLevel": "{emergencyLevel}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

响应示例

{
  "inventory": {
    "uuid": "6ff094db7e8b4640880751c5a17e7b63",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@c2e79f0",
    "threshold": 30,
    "repeatInterval": 1800,
    "repeatCount": -1,
    "status": "Alarm",
    "state": "Enabled",
    "enableRecovery": true,
    "createDate": "Jul 6, 2018 1:51:02 PM",
    "lastOpDate": "Jul 6, 2018 1:51:02 PM",
    "labels": [
      {
        "uuid": "cccd980c3bb84f4486d96a960eb08edb",
        "key": "VMUuid",
        "operator": "=",
        "value": "f486fd81583747459d8a6cd47f9228e5"
      }
    ],
    "actions": [
      {
        "alarmUuid": "8a6a98e3cc484388a746d725265886b3",
        "actionType": "sns",
        "actionUuid": "86a2b51fbc7f406c906711081852fa49"
      }
    ]
  }
}

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口