托管 Prometheus
托管 Prometheus
托管 Prometheus
文档指南
请输入
产品动态
Prometheus 基础知识
用户指南
工作区
告警中心
接入指南
容器与自建集群接入
自建 Kubernetes 集群接入
最佳实践
Prometheus 数据采集与接入
资源与业务监控
工作区数据写入和查询
多渠道告警通知
API 参考
工作区
告警中心
联系人
告警规则
告警静默策略
SDK 参考
指标参考
容器服务指标
常见问题
视频帮助
- 文档首页
托管 PrometheusAPI 参考告警中心通知消息模版CreateNotifyTemplate
复制全文
下载 pdfCreateNotifyTemplate
文档反馈
问问助手创建告警通知模版。
请求说明
- 请求方式：POST
- 请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=CreateNotifyTemplate&Version=2021-03-03
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | CreateNotifyTemplate | 接口名称。当前 API 的名称为 CreateNotifyTemplate。 |
Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
Name | String | 是 | template-demo | 告警通知模版名称。相同地域内名称唯一。 |
Description | String | 否 | 这是一段描述 | 告警通知模板的描述信息。 |
Channel | String | 是 | LarkBotWebhook | 告警通知模版的渠道，取值：
|
Active | 是 | - | 告警通知模版。 | |
Resolved | 是 | - | 告警恢复通知模版。 |
NotifyIntervalTemplate
请求示例
POST https://vmp.cn-beijing.volcengineapi.com?Action=CreateNotifyTemplate&Version=2021-03-03
Content-Type: application/json
{
"Name": "template-demo",
"Description": "这是一段描述",
"Channel": "LarkBotWebhook",
"Active": {
"Title": "火山 {{ .Region }} 正在发生告警",
"Content": "**告警规则**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**告警级别**: {{ .Level }}\n**告警条件**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ 持续 {{ .For }} ]"
},
"Resolved": {
"Title": "火山 {{ .Region }} 正在发生告警",
"Content": "**告警规则**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**告警级别**: {{ .Level }}\n**告警条件**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ 持续 {{ .For }} ]"
}
}
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Id | String | e28ae750-bbb8-4ff4-abf4*** | 告警通知模板 ID。 |
返回示例
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "CreateNotifyTemplate",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"Id": "e28ae750-bbb8-4ff4-abf4***"
}
}
错误码
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter.{{parameter}} | The specified parameter {{parameter}} is invalid. | 输入不合法，如工作区名称不合法等。 |
400 | MissingParameter.{{parameter}} | The required parameter {{parameter}} is missing. | 缺少必要的参数。 |
403 | ProductUnsubscribed | You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service | 当前账号未订阅 VMP 服务。 |
409 | Conflict.Name | The specified name conflicts with existing {{resource}}. | 指定的名称与已有资源重复。 |
最近更新时间：2025.11.05 17:12:26
这个页面对您有帮助吗？
有用
有用
无用
无用