Volcengine Managed Service for Prometheus
Volcengine Managed Service for Prometheus
Volcengine Managed Service for Prometheus
Document
What's new
Product overview
Prometheus basic knowledge
Data format and metric type
Billing overview
User guide
Workspace
Workplace overview
Creating a workspace
Workspace configuration change
Recording rule
Monitoring dashboard
Alert center
Alerting rule
Alerting rule template
Alerting notification policy
Notification template
Alerting aggregation policy
Alerting silence policy
Metric exporting
Permission management
Projects and tags
Integration Guide
Cloud service integration
Container and self-managed cluster integration
Self-built Kubernetes cluster integration
Deployment script
High-availability collection solution
Middleware integration
AI add-on integration
Prometheus ecosystem integration
Exporter integration
Custom integration
Best practices
Accessing workspaces across clouds and across regions
Prometheus data collection and integration
Resource and application monitoring
Writing and querying workspace data
Self-managed Grafana
Alert center
Intelligent O&M
API references
Calling method
Workspace
Alert center
Contact person
Alerting notification policies
Alerting rules
Alerting aggregation policies
Notification templates
Alerting silence policies
View alerts
Resource labels
SDK reference
Metric references
VKE metrics
FAQs
- Documentation
Volcengine Managed Service for PrometheusAPI referencesAlert centerNotification templatesCreateNotifyTemplate
Copy page
Download PDFNotification templates
CreateNotifyTemplate
Copy pageDownload PDFCreateNotifyTemplate
Create alert notification template.
Request descriptions
Volcengine Managed Service for Prometheus has been deployed in multiple regions worldwide, aiming to provide you with an experience of higher stability and lower latency. You can choose an access point that is the most optimal for the region of your services according to the Service addresses document.
- Request method: POST
- Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=CreateNotifyTemplate&Version=2021-03-03
Request parameters
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Action | String | Yes | CreateNotifyTemplate | API name. The API name is CreateNotifyTemplate. |
Version | String | Yes | 2021-03-03 | API version. The API version is 2021-03-03. |
Name | String | Yes | template-demo | Name of alert notification template. Duplicate names are not allowed in the same region. |
Description | String | No | This is a description | Description of alert notification template. |
Channel | String | Yes | LarkBotWebhook | Channel of alert notification template. Available channels:
|
Active | Yes | - | Alert notification template. | |
Resolved | Yes | - | Notification template used when alerts are cleared. |
NotifyIntervalTemplate
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Title | String | No | An alert has been raised in the {{ .Region }} of Volcano | Template title. |
Content | String | Yes | Alerting rule: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }}) Alerting level: {{ .Level }} Alerting condition: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ last for {{ .For }} ] | Template content. For more details about configurations, please refer to Lark notification template and Structure and parameters of Variables. |
Sample requests
POST https://vmp.cn-beijing.volcengineapi.com?Action=CreateNotifyTemplate&Version=2021-03-03
Content-Type: application/json
{
"Name": "template-demo",
"Description": "This is a description",
"Channel": "LarkBotWebhook",
"Active": {
"Title": "An alert has been raised in the {{ .Region }}",
"Content": "**Alerting rule**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**Alerting level**: {{ .Level }}\n**Alerting condition**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ last for {{ .For }} ]"
},
"Resolved": {
"Title": "An alert has been raised in the {{ .Region }}",
"Content": "**Alerting rule**: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }})\n**Alerting level**: {{ .Level }}\n**Alert condition**: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ last for {{ .For }} ]"
}
}
Response parameters
Parameter | Type | Sample value | Description |
Parameter | Type | Sample value | Description |
Id | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Alert notification template ID. |
Sample responses
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-1e0e0f88808c"
}
}
Error codes
The error codes for current API only are listed in the table below. See Public error codes to view error codes for any APIs.
HTTP status codes | Error codes | Error message | Description |
HTTP status codes | Error codes | Error message | Description |
400 | InvalidParameter.{{parameter}} | The specified parameter {{parameter}} is invalid. | The specified parameter is invalid. |
400 | MissingParameter.{{parameter}} | The required parameter {{parameter}} is missing. | Missing required parameters. |
403 | ProductUnsubscribed | You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service | The account is not subscribed to the VMP Service. |
409 | Conflict.Name | The specified name conflicts with existing {{resource}}. | The specified name has already been used by an existing resource. |
Last updated: 2026.07.10 11:37:28
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
