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 silence policiesUpdateSilencePolicy
Copy page
Download PDFAlerting silence policies
UpdateSilencePolicy
Copy pageDownload PDFUpdateSilencePolicy
Update alert silence policy.
Request descriptions
VMP 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 optimal for the region of your services according to the Service addresses document.
- Request method: POST
- Request address: https://vmp.cn-beijing.volcengineapi.com?Action=UpdateSilencePolicy&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
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Action | String | Yes | UpdateSilencePolicy | The name of the API. The API name is UpdateSilencePolicy. |
Version | String | Yes | 2021-03-03 | The API version. The API version is 2021-03-03. |
Id | String | Yes | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Alert silence policy ID. |
Name | String | No | alert-silence-demo | Name of alert silence policy.
|
Description | String | No | This is a description | Description of alert policy.
|
TimeRangeMatchers | No | - | Alert silence time. | |
MetricLabelMatchers | No | | Alert event label matchers. At most 32 items are allowed. Items follow an "OR" relationship. Different LabelMatchers are evaluated using an "AND" relationship. |
TimeRangeMatcher
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Date | String | No | 2006-01-02 15:04~2006-01-03 14:04 | The time period of the alert silence. Used to activate alert silence within a specified time period. |
Location | String | Yes | Asia/Shanghai | Time zone. |
PeriodicDate | No | - | The alert silence period. Used to configure the alert silence that takes effect periodically. |
Matcher
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Matchers | Yes | | Label matchers. Each LabelMatcher array can contain up to 24 items. |
PeriodicDate
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Time | String | No | 20:00~21:12 | Time period. You can specify multiple different time periods separated by commas (,), for example, 20:00~21:12,22:00~23:12. 4 time periods can be configured at most. |
Weekday | String | No | 1,3,5 | Specific days within a week. You can specify multiple different time periods with commas (,). For example, 1,3,5 indicates Monday, Wednesday, and Friday of each week. 7 time periods can be configured at most. |
DayOfMonth | String | No | 2~3 | Specific days within a month. You can specify multiple different time periods separated by commas (,). For example, 2~3 indicates the 2nd and 3rd day of each month. 10 time periods can be configured at most. |
LabelMatcher
Parameters | Type | Required | Sample value | Description |
Parameters | Type | Required | Sample value | Description |
Label | String | Yes | app | Label. |
Value | String | Yes | test | Label Value. |
Operator | String | No | Equal | The operator. Possible values:
|
Sample request
POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateSilencePolicy&Version=2021-03-03
Content-Type: application/json
{
"Id": "e28xxxx0-bxxx-4ff4-axx4-1e0xxxx880xx",
"Name": "alert-silence-demo",
"Description": "Description",
"TimeRangeMatchers": [
{
"Date": "2006-01-02 15:04~2006-01-03 14:04",
"Location": "Asia/Shanghai",
"PeriodicDate": {
"Time": "20:00~21:12",
"Weekday": "1,3,5",
"DayOfMonth": "2~3"
}
}
],
"MetricLabelMatchers": [
{
"Matchers": [
{
"Label": "app",
"Value": "test",
"Operator": "Equal"
}
]
}
]
}
Response parameters
Parameters | Type | Sample value | Description |
Parameters | Type | Sample value | Description |
Id | String | e28ae750-bbb8-4ff4-abf4*** | Alert silence policy ID. |
Sample response
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "UpdateSilencePolicy",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"Id": "e28ae750-bbb8-4ff4-abf4***"
}
}
Error code
The error codes for this API are listed in the table below. For a list of error codes for other APIs, see Public error codes.
HTTP status codes | Error code | Error messages | Descriptions |
HTTP status codes | Error code | Error messages | Descriptions |
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. | A required parameter is missing. |
403 | ProductUnsubscribed | You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service | The account has not subscribed to the VMP service. |
404 | NotFound.Id | The specified Contact/ContactGroup {{Id}} is not found. | The specified contact person/group was 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:28
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
