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 centerAlerting rulesUpdateAlertingRule
Copy page
Download PDFAlerting rules
UpdateAlertingRule
Copy pageDownload PDFUpdateAlertingRule
Update an alerting rule.
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 optimal access point for your service region by referring to the Service addresses topic.
- Request method: POST
- Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=UpdateAlertingRule&Version=2021-03-03
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
tip
The parameters type and query need to be used in pairs.
warning
Make sure there are no duplicate level values when multiple levels need to be configured under the parameter Levels in a single request.
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Action | String | Yes | UpdateAlertingRule | API name. The API name is UpdateAlertingRule. |
Version | String | Yes | 2021-03-03 | API version. The API version is 2021-03-03. |
Id | String | Yes | 90b5a3da-3464-4718-92e4-039bf41d3cff | Alerting rule ID. |
Name | String | No | alert-rule-demo | The name of the alerting rule. |
Description | String | No | This is an alert rule demo | Description of the alerting rule. |
Type | String | No | vmp/PromQL | Alerting rule type. Available value is vmp/PromQL. |
Query | No | - | Alerting configurations. | |
Levels | No | - | Alerting level. | |
NotifyPolicyId | String | No | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Alerting notification policy ID. |
NotifyGroupPolicyId | String | No | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Alert aggregation policy ID. |
Annotations | No | - | Annotations added to the alert. | |
Labels | No | - | The labels to be added to an alert. |
AlertingRuleQuery
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
WorkspaceId | String | Yes | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Workspace ID. |
PromQL | String | Yes | sum(up) | Query statement. |
AlertingRuleLevel
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Level | String | Yes | P0 | Alerting rule level. Level P0, P1, and P2 are available currently. |
For | String | Yes | 5m | How long the state of meeting alerting conditions needs to last before raising alerts:
|
Comparator | String | Yes | > | Operators used in alerting rules:
|
Threshold | Double | No | 1.0 | Threshold of the alerting rule. |
TemplateKV
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Name | String | Yes | key1 | Key of label or annotation. |
Value | String | No | value1 | Value of label or annotation. Leaving it empty means the key will be deleted correspondingly. |
Sample requests
POST https://vmp.cn-beijing.volcengineapi.com/?Action=UpdateAlertingRule&Version=2021-03-03
Content-Type: application/json
{
"Id": "90b5a3da-3464-4718-92e4-039bf41d3cff",
"Name": "alert-rule-demo",
"Description": "this is a alert rule demo",
"Type": "vmp/PromQL",
"Query": {
"PromQL": "sum(up)",
"WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
},
"Levels": [
{
"For": "5m",
"Level": "P0",
"Threshold": 1,
"Comparator": ">"
}
],
"Labels": [
{
"Name": "key1",
"Value": "value1"
}
],
"Annotations": [
{
"Name": "key1",
"Value": "value1"
}
],
"NotifyPolicyId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
"NotifyGroupPolicyId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
}
Response parameters
Parameter | Type | Sample value | Description |
Parameter | Type | Sample value | Description |
Id | String | 90b5a3da-3464-4718-92e4-039bf41d3cff | Alerting rule ID. |
Sample responses
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "UpdateAlertingRule",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"Id": "90b5a3da-3464-4718-92e4-039bf41d3cff"
}
}
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. | An invalid parameter was found. For example, an invalid workspace name was included in requests. |
400 | MissingParameter.{{parameter}} | The required parameter {{parameter}} is missing. | Missing necessary 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. |
404 | NotFound.Id | The specified Contact/ContactGroup {{Id}} is not found. | The specified contact person/group is not found. |
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:27
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
