操作指南

API 文档

云产品监控指标

创建云监控告警策略

最近更新时间:2022-04-13 06:59:08

我的收藏

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

创建云监控告警策略

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAlarmPolicy。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
PolicyName String 策略名称,不超过20字符
MonitorType String 监控类型 MT_QCE=云产品监控
Namespace String 告警策略类型,由 DescribeAllNamespaces 获得。对于云产品监控,取接口出参的 QceNamespacesNew.N.Id,例如 cvm_device
Remark String 备注,不超过100字符,仅支持中英文、数字、下划线、-
Enable Integer 是否启用 0=停用 1=启用,可不传 默认为1
ProjectId Integer 项目 Id,对于区分项目的产品必须传入非 -1 的值。 -1=无项目 0=默认项目,如不传 默认为 -1。支持的项目 Id 可以在控制台 账号中心-项目管理 中查看。
ConditionTemplateId Integer 触发条件模板 Id,该参数与 Condition 参数二选一。如果策略绑定触发条件模板,则传该参数;否则不传该参数,而是传 Condition 参数。触发条件模板 Id 可以从 DescribeConditionsTemplateList 接口获取。
Condition AlarmPolicyCondition 指标触发条件,支持的指标可以从 DescribeAlarmMetrics 查询。
EventCondition AlarmPolicyEventCondition 事件触发条件,支持的事件可以从 DescribeAlarmEvents 查询。
NoticeIds.N Array of String 通知规则 Id 列表,由 DescribeAlarmNotices 获得
TriggerTasks.N Array of AlarmPolicyTriggerTask 触发任务列表
Filter AlarmPolicyFilter 全局过滤条件
GroupBy.N Array of String 聚合维度列表,指定按哪些维度 key 来做 group by

3. 输出参数

参数名称 类型 描述
PolicyId String 告警策略 ID
OriginId String 可用于实例、实例组的绑定和解绑接口(BindingPolicyObjectUnBindingAllPolicyObjectUnBindingPolicyObject)的策略 ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建告警策略

策略类型为“云服务器-基础监控”,触发指标为CPU使用率大于等于99.9%,触发事件为“ping不可达”,绑定两个通知规则,绑定一个弹性伸缩策略

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmPolicy
<公共请求参数>

{
    "Module": "monitor",
    "PolicyName": "云服务器告警策略",
    "Remark": "这是一句备注",
    "MonitorType": "MT_QCE",
    "Enable": 1,
    "ProjectId": 0,
    "Namespace": "cvm_device",
    "Condition": {
        "IsUnionRule": 1,
        "Rules": [
            {
                "MetricName": "cpu_usage",
                "Period": 60,
                "Operator": "ge",
                "Value": "99.9",
                "ContinuePeriod": 1,
                "NoticeFrequency": 3600,
                "IsPowerNotice": 0
            }
        ]
    },
    "EventCondition": {
        "Rules": [
            {
                "MetricName": "ping_unreach"
            }
        ]
    },
    "NoticeIds": [
        "notice-bv9b4ghqbg",
        "notice-gj2n9wnt29"
    ],
    "TriggerTasks": [
        {
            "Type": "AS",
            "TaskConfig": "{\"Region\":\"ap-guangzhou\",\"Group\":\"asg-0zhspjx\",\"Policy\":\"asp-ganig28\"}"
        }
    ]
}

输出示例

{
  "Response": {
    "RequestId": "29ghj2hh-45-h53h234h-23",
    "PolicyId": "policy-hi498gw3h2",
    "OriginId": "1234556"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
目录