文档中心>腾讯云可观测平台

绑定策略对象

最近更新时间:2024-03-12 01:40:46

我的收藏

1. 接口描述

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

将告警策略绑定到特定对象

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BindingPolicyObject。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 必填。固定值"monitor"
示例值:monitor
GroupId Integer 策略组id,例如 4739573。逐渐弃用,建议使用 PolicyId 参数
示例值:111111
PolicyId String 告警策略ID,例如“policy-gh892hg0”。PolicyId 参数与 GroupId 参数至少要填一个,否则会报参数错误,建议使用该参数。若两者同时存在则以该参数为准
示例值:policy-abc123
InstanceGroupId Integer 实例分组ID
示例值:0
Dimensions.N Array of BindingPolicyObjectDimension 需要绑定的对象维度信息
EbSubject String 事件配置的告警
示例值:{ "source": "apigw.cloud.tencent", // 对应云监控所选 云产品 "type": [
EbEventFlag Integer 是否配置了事件告警
示例值:1

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定策略对象

输入示例

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

{
    "GroupId": "111111",
    "Module": "monitor",
    "Dimensions": [
        {
            "EventDimensions": "{\"uuid\":\"9d51a69e-0e4a-4120-ae58-9c073c851e24\"}",
            "Region": "gz",
            "RegionId": "1",
            "Dimensions": "{\"unInstanceId\":\"ins-ot3cq4bi\"}"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "78345016-ff97-4360-839a-82f3d96430e8"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。