操作指南

API 文档

云产品监控指标

文档中心 > 云监控 > 最佳实践 > 使用 API 创建告警策略

使用 API 创建告警策略

最近更新时间:2022-05-11 16:01:15

本文将为您介绍如何通过 创建告警策略接口API绑定策略对象API 创建告警策略并绑定告警对象。

准备工作

在调用创建 创建告警策略接口API 前需要准备以下入参资料。

  1. 登录访问管理控制台 API 密钥管理 页面。
  2. 单击显示即可获取 SecretKey。
    说明:

    如未创建密钥,请单击新建密钥创建密钥。

实践步骤

本文提供以下示例,为您介绍如何使用 创建告警策略接口API等接口创建云服务器-基础监控告警策略。

创建告警策略

  1. 登录 API Explorer 在线调试控制台
  2. 准备好的个人密钥 对应复制到对应的 SecretId、SecretKey 文本框。
  3. 输入参数配置项找到 Region,选择相关地域。
  4. 在 Module 中填写“monitor”,PolicyName 中填写策略名称(策略名称由您自定义),MonitorType 中填写“MT_QCE”。
  5. 在 Namespace 中填写上述 准备告警策略类型 步骤中获取的告警策略类型。例如,云服务器-基础监控告警策略类型为 cvm_device。
  6. 在云服务器-基础监控场景下 Remark、Enable 为选填,ProjectId 为必填。
    • Remark:备注,可不填。
    • Enable:是否启用告警策略。0=停用,1=启用。可不传,默认为1。
    • ProjectId:项目 Id。云服务器-基础监控需填写0
      说明:

      ProjectId 项目 Id,-1=无项目,0=默认项目,根据策略类型而定可不传,默认为-1。例如部分告警策略类型下无项目概念(例如私有网络),可使用默认传参-1 。若该告警策略类型有项目概念(例如云服务器-基础监控),默认传参-1会报错,入参需要修改为0。

  7. Condition 配置说明如下:
    参数名称 是否必填 说明
    IsUnionRule 指标触发与或条件,0=或,1=与,或表示触发任一条件时发送告警,与为触发所有条件后发送告警
    Rules.N 告警触发条件列表。可参考在线调用 AlarmPolicyRule 参数说明进行配置
    • MetricName:填写 准备指标列表 步骤返回中的 MetricName(Metrics.N.MetricName)
    • Period:填写 准备指标列表 步骤返回中的 Period(Metrics.N.MetricConfig.Period)
    • Operator:填写 准备指标列表 步骤返回中的 Operator(Metrics.N.MetricConfig.Operator)
    • Value:填写阈值,不需要填写单位,例如80
    • ContinuePeriod:填写 准备指标列表 步骤返回中的 ContinuePeriod(Metrics.N.MetricConfig.ContinuePeriod)
    • NoticeFrequency:告警频率(按秒计算)。参数说明:告警间隔,0=不重复 ;300=每5分钟告警一次; 600=每10分钟告警一次 ;900=每15分钟告警一次 1800=每30分钟告警一次;3600=每1小时告警一次; 7200=每2小时告警一次 ;10800=每3小时告警一次; 21600=每6小时告警一次; 43200=每12小时告警一次 ;86400=每1天告警一次
    • IsPowerNotice:告警频率是否指数增长,0=否,1=是
    • 其他参数无需填写
  8. 在 NoticeIds.N 填写告警通知模板 Id ,例如 notice-qvq836vc。可通过 查询通知模板列表API 获得。
  9. 填写完以上参数后,单击在线调用 > 发送请求,如下图为成功创建云服务器—基础监控告警策略。
  10. 创建成功后,即可在云监控控制台 告警策略 页面查看该告警策略。

绑定告警对象

  1. 登录 API Explorer 在线调试控制台
  2. 准备好的个人密钥 对应复制到对应的 SecretId、SecretKey 文本框。
  3. 输入参数配置项找到 Region,选择相关地域。
  4. 在 Module 中填写“monitor”。
  5. 在 GroupId 中填写0。
  6. InstanceGroupId 和 Dimensions 选一项填写,说明如下:
    • InstanceGroupId:实例分组 ID。如需按照实例分组绑定告警对象,则需要传实例分组 ID(例如1234),可在云监控控制台 实例分组 页面中,单击对应的实例名称获取,如下图所示:
    • Dimensions.N: 如需按照实例 ID 绑定告警策略,则需要填写 Dimensions。说明如下:
      参数名称 说明
      RegionId、Region 请参见 实例地域说明,例如广州,RegionId 为1,Region 为 gz
      Dimensions 填写云服务器实例 ID,可通过 查看实例列表API 获取。入参格式为:{"unInstanceId":"ins-xxxxxxxx'"}。
      EventDimensions 填写实例全局唯一 ID,可通过 查看实例列表API 获取。入参格式为:{"uuid":"9d51a69e-0e4a-4120-ae58-9c073c851e24"}
  7. 在 PolicyId 中填写 创建告警策略 步骤返回的 PolicyId(Response.PolicyId)。例如 policy-zg2sk27j。
  8. 填写完以上参数后,单击在线调用 > 发送请求,如下图即成功绑定告警策略。
  9. 创建成功后, 即可在云监控控制台 告警策略 页面查看对应告警策略关联实例数量。
目录