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

增加策略组

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

我的收藏

1. 接口描述

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

增加策略组

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePolicyGroup。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
GroupName String 组策略名称
示例值:test_group
Module String 固定值,为"monitor"
示例值:monitor
ViewName String 策略组所属视图的名称,若通过模板创建,可不传入
示例值:cvm_device
ProjectId Integer 策略组所属项目Id,会进行鉴权操作
示例值:0
ConditionTempGroupId Integer 模板策略组Id, 通过模板创建时才需要传
示例值:123
IsShielded Integer 是否屏蔽策略组,0表示不屏蔽,1表示屏蔽。不填默认为0
示例值:1
Remark String 策略组的备注信息
示例值:backup_group
InsertTime Integer 插入时间,戳格式为Unix时间戳,不填则按后台处理时间填充
示例值:106648246
Conditions.N Array of CreatePolicyGroupCondition 策略组中的阈值告警规则
EventConditions.N Array of CreatePolicyGroupEventCondition 策略组中的事件告警规则
BackEndCall Integer 是否为后端调用。当且仅当值为1时,后台拉取策略模板中的规则填充入Conditions以及EventConditions字段
示例值:0
IsUnionRule Integer 指标告警规则的且或关系,0表示或规则(满足任意规则就告警),1表示且规则(满足所有规则才告警)
示例值:1

3. 输出参数

参数名称 类型 描述
GroupId Integer 创建成功的策略组Id
示例值:1288099
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 增加策略组

输入示例

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

{
    "EventConditions": [
        {
            "EventId": "42",
            "AlarmNotifyType": "0",
            "AlarmNotifyPeriod": "0"
        }
    ],
    "Remark": "backup_group",
    "BackEndCall": "0",
    "ViewName": "cvm_device",
    "ProjectId": "0",
    "Module": "monitor",
    "IsUnionRule": "1",
    "GroupName": "test_group",
    "Conditions": [
        {
            "MetricId": "19",
            "CalcType": "1",
            "AlarmNotifyPeriod": "0",
            "ContinuePeriod": "1",
            "AlarmNotifyType": "0",
            "CalcPeriod": "1",
            "CalcValue": "100"
        }
    ]
}

输出示例

{
    "Response": {
        "GroupId": 1288099,
        "RequestId": "a91f70ed-e385-4817-9928-994ff06e56ec"
    }
}

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 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。