创建告警策略
最近更新时间: 2026-09-17 00:06:29
1. 接口描述
接口请求域名: monitor.api3.fincloud.tencent.cn。
创建告警策略
默认接口请求频率限制:20次/秒。
接口更新时间:2025-07-22 18:11:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateAlarmPolicy |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-07-24 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Module | 是 | 否 | String | 固定值,为"monitor" 示例值: monitor |
| PolicyName | 是 | 否 | String | 策略名称,不超过20字符 示例值: 云服务器告警策略 |
| Remark | 否 | 否 | String | 备注,不超过100字符,仅支持中英文、数字、下划线、- 示例值: 策略demo |
| MonitorType | 是 | 否 | String | 监控类型 MT_QCE=云产品监控 示例值: MT_QCE |
| Enable | 否 | 否 | Int64 | 是否启用 0=停用 1=启用,可不传 默认为1 示例值: 1 |
| ProjectId | 否 | 否 | Int64 | 项目 Id -1=无项目 0=默认项目,可不传 默认为-1 示例值: 0 |
| Namespace | 是 | 否 | String | 告警策略类型,由 DescribeAllNamespaces 获得,例如 cvm_device 示例值: cvm_device |
| PolicyExpression | 否 | 否 | String | 裸写包含触发规则、过滤条件等内容的告警规则 示例值: 29936048 AND 2993604 |
| ConditionTemplateId | 否 | 否 | Int64 | 触发条件模板 Id ,可不传 示例值: 123456 |
| Condition | 否 | 否 | AlarmPolicyCondition | 指标触发条件 示例值:查看 |
| EventCondition | 否 | 否 | Array of AlarmPolicyEventCondition | 事件触发条件 示例值:查看 |
| NoticeIds | 否 | 否 | Array of String | 通知规则 Id 列表,由 DescribeAlarmNotices 获得 示例值: ["notice-bv9b4ghqbg","notice-gj2n9wnt29"] |
| TriggerTasks | 否 | 否 | Array of AlarmPolicyTriggerTask | 触发任务列表 示例值:查看 |
| AlarmLevel | 否 | 否 | String | 告警等级 示例值: Remind |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PolicyId | String | 告警策略 ID 示例值: policy-abc123 |
| OriginId | String | 用于实例、实例组绑定和解绑接口(BindingPolicyObject、UnBindingAllPolicyObject、UnBindingPolicyObject)的策略 ID 示例值: 1234556 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
| FailedOperation | 操作失败。 |
| UnsupportedOperation | 操作不支持。 |
| LimitExceeded | 超过配额限制。 |
| InvalidParameterValue | 无效的参数值。 |
5. 示例
示例1 创建告警策略
策略类型为“云服务器-基础监控”,触发指标为CPU使用率大于等于99.9%,触发事件为“ping不可达”,绑定两个通知规则,绑定一个弹性伸缩策略
输入示例
POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
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\":\"region1\",\"Group\":\"asg-0zhspjx\",\"Policy\":\"asp-ganig28\"}"
}
]
}
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&PolicyName="1598976507"&Remark="1598976507"&ProjectId="1000000"&&Namespace="1598976507"&Condition="1598976507"&NoticeIds="1000000"&TriggerTasks&EventCondition=“”&NoticeIds="1000000"&MonitorType&EventCondition
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "29ghj2hh-45-h53h234h-23",
"PolicyId": "policy-hi498gw3h2",
"OriginId": "1234556"
}
}