跳转到主要内容
API Explorer|API Explorer
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/报警器（Alarm）
POSTAlarm Operations起始版本 2.3同步需要认证

创建报警器

创建报警器

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • comparisonOperatorString必填

      阈值比较符

    • periodInteger

      阈值持续时间

    • namespaceString必填

      名字空间

    • metricNameString必填

      监控项名

    • thresholdDouble必填

      阈值

    • repeatIntervalInteger

      报警重复时间

    • labelsList

      标签列表

    • actionsList

      报警动作列表

    • resourceUuidString

      可选。

    • repeatCountInteger

      报警重复次数

    • typeString

      报警器类型

    • enableRecoveryBoolean必填

      开启恢复通知

    • emergencyLevelString

      报警等级

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryAlarmInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • periodInteger必填

      阈值持续时间

    • namespaceString必填

      名字空间

    • metricNameString必填

      监控项名称

    • thresholdDouble必填

      阈值

    • repeatIntervalInteger必填

      报警重复时间

    • enableRecoveryBoolean必填

      开启恢复通知

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • comparisonOperatorComparisonOperator必填

      详情参考comparisonOperator

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

    • statusAlarmStatus必填

      详情参考status

      • OKAlarmStatus必填

        监控中

      • AlarmAlarmStatus必填

        已触发

      • InsufficientDataAlarmStatus必填

        数据不足

    • labelsList必填

      详情参考labels

      • uuidString必填

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

      • keyString必填

        标签键

      • operatorString必填

        比较符

      • valueString必填

        标签值

    • actionsList必填

      详情参考actions

      • alarmUuidString必填

        报警器UUID

      • actionTypeString必填

        报警动作类型

      • actionUuidString必填

        报警动作UUID

请求地址

POST/zstack/v1/zwatch/alarms

/zstack/v1/zwatch/alarms

操作 ID

CreateAlarm

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/zwatch/alarms' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","comparisonOperator":"<comparisonOperator>","period":1,"namespace":"<namespace>","metricName":"<metricName>","threshold":1,"repeatInterval":1,"labels":["<labels>"],"actions":["<actions>"],"resourceUuid":"<resourceUuid>","repeatCount":1,"type":"<type>","enableRecovery":true,"emergencyLevel":"<emergencyLevel>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "6ff094db7e8b4640880751c5a17e7b63", "name": "VM CPU Alarm", "comparisonOperator": "LessThanOrEqualTo", "period": 60.0, "namespace": "ZStack/VM", "metricName": "org.zstack.zwatch.datatype.Metric@c2e79f0", "threshold": 30.0, "repeatInterval": 1800.0, "repeatCount": -1.0, "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": "\u003d", "value": "f486fd81583747459d8a6cd47f9228e5" } ], "actions": [ { "alarmUuid": "8a6a98e3cc484388a746d725265886b3", "actionType": "sns", "actionUuid": "86a2b51fbc7f406c906711081852fa49" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史