1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询告警通知内容模板支持的变量或者函数列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeNotificationContentTemplateSupports。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MonitorType | 否 | String | 监控类型 示例值:MT_PROM |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Support | NotificationContentTemplateSupport | 配置详情 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试环境真实示例
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotificationContentTemplateSupports
<公共请求参数>
{
"MonitorType": "MT_QCE"
}
输出示例
{
"Response": {
"RequestId": "4f48fd53-422b-469e-b467-bb5631f14656",
"Support": {
"Functions": null,
"MonitorType": "MT_QCE",
"Variables": [
{
"Desc": "账号appid",
"Example": "123000456",
"Name": "{{.app_id}}"
},
{
"Desc": "控制台链接",
"Example": "腾讯云可观测平台告警详情页面链接",
"Name": "{{.console_link}}"
},
{
"Desc": "告警内容",
"Example": "CPU利用率 > 0%",
"Name": "{{.content}}"
},
{
"Desc": "当前等级(格式化)",
"Example": "提示 警告 严重",
"Name": "{{.current_level_fmt}}"
},
{
"Desc": "当前等级",
"Example": "None Note Warn Serious",
"Name": "{{.current_level}}"
},
{
"Desc": "当前数据",
"Example": "95.6% (CPU利用率)",
"Name": "{{.current_value_content}}"
},
{
"Desc": "持续时长(格式化)",
"Example": "5h4m3s",
"Name": "{{.duration_fmt}}"
},
{
"Desc": "持续时长 秒",
"Example": "1000",
"Name": "{{.duration}}"
},
{
"Desc": "首次触发时间(格式化)",
"Example": "2024-07-09 14:35:00 (UTC+08:00)",
"Name": "{{.first_trigger_time_fmt}}"
},
{
"Desc": "首次触发时间 秒",
"Example": "1732867259",
"Name": "{{.first_trigger_time}}"
},
{
"Desc": "上一次等级(格式化)",
"Example": "提示 警告 严重",
"Name": "{{.last_level_fmt}}"
},
{
"Desc": "上一次等级",
"Example": "None Note Warn Serious",
"Name": "{{.last_level}}"
},
{
"Desc": "小程序链接",
"Example": "腾讯云助手小程序云监控告警详情页面链接",
"Name": "{{.miniprogram_link}}"
},
{
"Desc": "告警对象",
"Example": "10.0.0.1 (内) | ins-123456 | as-tke-np-abc",
"Name": "{{.object}}"
},
{
"Desc": "告警策略ID",
"Example": "policy-abc123",
"Name": "{{.policy_id}}"
},
{
"Desc": "告警策略名称",
"Example": "腾讯云监控告警",
"Name": "{{.policy_name}}"
},
{
"Desc": "项目名称",
"Example": "默认",
"Name": "{{.project_name}}"
},
{
"Desc": "告警恢复时间(格式化)",
"Example": "2024-07-09 14:35:00 (UTC+08:00)",
"Name": "{{.recovery_time_fmt}}"
},
{
"Desc": "告警恢复时间 秒",
"Example": "1732867259",
"Name": "{{.recovery_time}}"
},
{
"Desc": "地域(格式化)",
"Example": "广州",
"Name": "{{.region_fmt}}"
},
{
"Desc": "地域",
"Example": "ap-guangzhou",
"Name": "{{.region}}"
},
{
"Desc": "云产品名称-策略类型",
"Example": "云服务器-基础监控",
"Name": "{{.server_name}}"
},
{
"Desc": "告警状态(格式化)",
"Example": "触发 恢复",
"Name": "{{.status_fmt}}"
},
{
"Desc": "告警状态和等级展示(格式化)",
"Example": "触发 持续 恢复 升级 降级",
"Name": "{{.status_level_fmt}}"
},
{
"Desc": "告警状态",
"Example": "Trigger Recovery",
"Name": "{{.status}}"
},
{
"Desc": "资源标签(格式化)",
"Example": "(业务部门:云监控)(功能:告警)",
"Name": "{{.tag_fmt}}"
},
{
"Desc": "告警策略提示",
"Example": "告警说明:基础CPU使用率是从母机采集到的数据。",
"Name": "{{.tooltip_text}}"
},
{
"Desc": "当前触发时间(格式化)",
"Example": "2024-07-09 14:35:00 (UTC+08:00)",
"Name": "{{.trigger_time_fmt}}"
},
{
"Desc": "当前触发时间 秒",
"Example": "1732867259",
"Name": "{{.trigger_time}}"
}
]
}
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。