1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建告警条件模板
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateConditionsTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Module | 是 | String | 固定值,monitor 示例值:monitor, |
ViewName | 是 | String | 视图名 示例值:cvm_device, |
GroupName | 是 | String | 组名 示例值:测试API新增, |
IsUnionRule | 否 | Integer | 是否为与关系 示例值:0, |
Remark | 否 | String | 备注 示例值:测试API创建一下模板, |
ParentGroupID | 否 | Integer | 父ID |
IsShielded | 否 | Integer | 是否屏蔽 |
ComplexExpression | 否 | String | 复合告警表达式 |
Conditions.N | 否 | Array of ModifyConditionsTemplateRequestCondition | 指标告警条件 |
EventConditions.N | 否 | Array of ModifyConditionsTemplateRequestEventCondition | 事件告警条件 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
GroupID | Integer | 模板策略组ID 示例值:1998842 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建告警条件模板
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConditionsTemplate
<公共请求参数>
{
"EventConditions": [
{
"EventID": "123",
"AlarmNotifyType": "0",
"AlarmNotifyPeriod": "123",
"RuleID": 0
}
],
"Remark": "abcd",
"ViewName": "cvm",
"Module": "monitor",
"IsUnionRule": 0,
"GroupName": "abcd",
"IsShielded": 0,
"ComplexExpression": "(1 AND 2) OR 3",
"ParentGroupID": 0,
"Conditions": [
{
"RuleID": 0,
"MetricID": 0,
"CalcType": "1",
"AlarmNotifyPeriod": "0",
"ContinuePeriod": "1",
"AlarmNotifyType": 0,
"CalcPeriod": "60",
"CalcValue": "0"
}
]
}
输出示例
{
"Response": {
"GroupID": 1998842,
"RequestId": "'4cf37d0d-99f9-4050-a08e-88e2b97017a8"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DoHTTPTransferFailed | 后端服务超时 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |