1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取单个告警策略详情
默认接口请求频率限制:60次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAlarmPolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Module | 是 | String | 固定值,为"monitor" 示例值:monitor |
| PolicyId | 是 | String | 告警策略ID 示例值:policy-t1pvz47f |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Policy | AlarmPolicy | 策略详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询告警策略详情
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmPolicy
<公共请求参数>
{
"Module": "monitor",
"PolicyId": "policy-1b842bhh"
}
输出示例
{
"Response": {
"Policy": {
"AdvancedMetricNumber": 0,
"CanSetDefault": 1,
"Condition": {
"ComplexExpression": "",
"IsUnionRule": 0,
"Rules": [
{
"ContinuePeriod": 5,
"Description": "CPU利用率",
"Filter": {
"Dimensions": "",
"Type": ""
},
"HierarchicalValue": {
"Remind": "",
"Serious": "",
"Warn": ""
},
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 1,
"IsPowerNotice": 0,
"MetricName": "CpuUsage",
"NoticeFrequency": 7200,
"Operator": "gt",
"Period": 60,
"ProductId": "",
"RuleType": "STATIC",
"Unit": "%",
"Value": "95",
"ValueMax": 100,
"ValueMin": 0
},
{
"ContinuePeriod": 5,
"Description": "外网出带宽使用率(适用于非上移账户)",
"Filter": {
"Dimensions": "",
"Type": ""
},
"HierarchicalValue": {
"Remind": "",
"Serious": "",
"Warn": ""
},
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 1,
"IsPowerNotice": 0,
"MetricName": "Outratio",
"NoticeFrequency": 7200,
"Operator": "gt",
"Period": 60,
"ProductId": "",
"RuleType": "STATIC",
"Unit": "%",
"Value": "95",
"ValueMax": 100,
"ValueMin": 0
},
{
"ContinuePeriod": 5,
"Description": "内存利用率",
"Filter": {
"Dimensions": "",
"Type": ""
},
"HierarchicalValue": {
"Remind": "",
"Serious": "",
"Warn": ""
},
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 1,
"IsPowerNotice": 0,
"MetricName": "MemUsage",
"NoticeFrequency": 7200,
"Operator": "gt",
"Period": 60,
"ProductId": "",
"RuleType": "STATIC",
"Unit": "%",
"Value": "95",
"ValueMax": 100,
"ValueMin": 0
},
{
"ContinuePeriod": 5,
"Description": "磁盘利用率",
"Filter": {
"Dimensions": "",
"Type": ""
},
"HierarchicalValue": {
"Remind": "",
"Serious": "",
"Warn": ""
},
"IsAdvanced": 0,
"IsLatenessMetric": 0,
"IsOpen": 1,
"IsPowerNotice": 0,
"MetricName": "CvmDiskUsage",
"NoticeFrequency": 7200,
"Operator": "gt",
"Period": 60,
"ProductId": "",
"RuleType": "STATIC",
"Unit": "%",
"Value": "95",
"ValueMax": 100,
"ValueMin": 0
}
]
},
"ConditionTemplateId": "",
"ConditionsTemp": {
"Condition": null,
"EventCondition": null,
"TemplateName": ""
},
"Enable": 1,
"EventCondition": {
"Rules": []
},
"Filter": null,
"FilterDimensionsParam": "",
"GroupBy": null,
"HierarchicalNotices": [
{
"Classification": [
""
],
"NoticeId": "notice-qvq836vc",
"PolicyId": "policy-1b842bhh"
}
],
"InsertTime": 1781493760,
"InstanceGroupId": 0,
"InstanceGroupName": "",
"InstanceSum": 0,
"IsBindAll": 0,
"IsDefault": 0,
"IsOneClick": 0,
"IsSupportAlarmTag": 0,
"LastEditUin": "100026263254",
"MonitorType": "MT_QCE",
"Namespace": "cvm_device",
"NamespaceShowName": "云服务器-基础监控",
"NoticeContentTmplBindInfos": [],
"NoticeIds": [
"notice-qvq836vc"
],
"Notices": [
{
"AMPConsumerId": "",
"CLSNotices": [],
"Id": "notice-qvq836vc",
"IsPreset": 1,
"Name": "系统预设通知模板",
"NoticeLanguage": "zh-CN",
"NoticeType": "OK",
"PolicyIds": null,
"Tags": null,
"URLNotices": [
{
"EndTime": 1,
"GroupMembers": "",
"IsValid": 0,
"StartTime": 0,
"URL": "https://qq.com?no-user-no-alarm-please-use-custom-notice",
"ValidationCode": "",
"Weekday": [
7
]
}
],
"UpdatedAt": "2025-09-25 15:21:35",
"UpdatedBy": "1500000688",
"UserNotices": []
}
],
"OneClickStatus": 0,
"OriginId": "15225159",
"PolicyId": "policy-1b842bhh",
"PolicyName": "cvm告警",
"PredefinedConfigID": "",
"ProjectId": 0,
"ProjectName": "默认项目",
"Region": [
"bj",
"bjhldycft",
"bjjr",
"cd",
"cgoec",
"cq",
"csec",
"de",
"fzec",
"gz",
"gzopen",
"gzwxzf",
"hfeec",
"hk",
"hzec",
"jkt",
"jnec",
"jp",
"kr",
"nj",
"osa",
"qy",
"qyxa",
"sa",
"sao",
"sg",
"sh",
"shadc",
"sheec",
"shhqcft",
"shjr",
"shwxzf",
"sjwec",
"szjr",
"szjxcft",
"szsycft",
"szx",
"th",
"tpe",
"tsn",
"use",
"usw",
"whec",
"xbec",
"xiyec",
"zw",
"zwadc"
],
"Remark": "",
"RuleType": "STATIC",
"TagInstances": [],
"TagOperation": "",
"Tags": [],
"TriggerTasks": [],
"UpdateTime": 1781493761,
"UseSum": 1
},
"RequestId": "11d9550a-f3c3-441f-a0f5-21d8e7d00b0e"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.DoHTTPTransferFailed | 后端服务超时 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |