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

修改一键报警模板

修改一键报警模板

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • uuidString必填

    模板UUID

查询参数

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

请求体字段

  • updateactivealarmtemplateObject必填

    updateactivealarmtemplate 请求体结构

    • alarmNameString

      模板名称

    • comparisonOperatorString

      阈值比较符

    • periodInteger

      阈值持续时间

    • thresholdDouble

      阈值

    • repeatIntervalInteger

      报警重复时间

    • repeatCountInteger

      报警重复次数

    • emergencyLevelString

      报警等级

    • labelsString

      可选。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • inventoryActiveAlarmTemplateInventory必填

    详情参考inventory

    • uuidString必填

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

    • alarmNameString必填

      暂无描述。

    • periodint必填

      时间周期。

    • repeatIntervalint必填

      重复周期。

    • repeatCountint必填

      重试次数。

    • namespaceString必填

      命名空间。

    • metricNameString必填

      监控项名称。

    • thresholddouble必填

      阈值。

    • labelsString必填

      标签列表。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • comparisonOperatorComparisonOperator必填

      详情参考comparisonOperator

      • GreaterThanOrEqualToComparisonOperator必填

        暂无描述。

      • GreaterThanComparisonOperator必填

        暂无描述。

      • LessThanComparisonOperator必填

        暂无描述。

      • LessThanOrEqualToComparisonOperator必填

        暂无描述。

    • emergencyLevelEmergencyLevel必填

      详情参考emergencyLevel

      • EmergentEmergencyLevel必填

        暂无描述。

      • ImportantEmergencyLevel必填

        暂无描述。

      • NormalEmergencyLevel必填

        正常。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/zwatch/activealarms/templates/{uuid}/actions

/zstack/v1/zwatch/activealarms/templates/{uuid}/actions

操作 ID

UpdateActiveAlarmTemplate

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/zwatch/activealarms/templates/{uuid}/actions?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updateactivealarmtemplate":{"alarmName":"<alarmName>","comparisonOperator":"<comparisonOperator>","period":1,"threshold":1,"repeatInterval":1,"repeatCount":1,"emergencyLevel":"<emergencyLevel>","labels":"<labels>"}}'

响应示例

200
{ "inventory": { "uuid": "ea8aa7b6b2e43d4a9f3a19ba121ab72a", "alarmName": "VM CPU Alarm", "comparisonOperator": "LessThanOrEqualTo", "period": 60, "repeatInterval": 60, "repeatCount": -1, "namespace": "zstack/VM", "metricName": "CPUIdleUtilization", "threshold": 30.0, "emergencyLevel": "Emergent", "labels": "[{\"uuid\":\"48cc4d3273a249009ea2166b71495785\",\"key\":\"VMUuid\",\"operator\":\"\u003d\",\"value\":\"c69d93586ca349b9a3bc074e2739e20a\"}]", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史