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 referencesRecording ruleGetRuleFile
Copy page
Download PDFRecording rule
GetRuleFile
Copy pageDownload PDFGetRuleFile
Obtain the details of a RecordingRule file.
Request description
Volcengine Managed Service for Prometheus has been deployed in multiple regions worldwide to provide you with a more stable, lower-latency experience. 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=GetRuleFile&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
Use either Id or WorkspaceId + Name as parameters, which means you can:
- find a rule file by Id,
- or find a rule file by WorkspaceId + Name, i.e., a workspace ID and a file name in it.
Parameter | Type | Required | Sample value | Description |
Parameter | Type | Required | Sample value | Description |
Action | String | Yes | GetRuleFile | API name. The API name is GetRuleFile. |
Version | String | Yes | 2021-03-03 | API version. The API version is 2021-03-03. |
Id | String | No | 1c3f6e48-b5e1-4832-8564-10eaac12a22c | Rule file ID. |
WorkspaceId | String | No | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Workspace ID. It is always used together with Name. |
Name | String | No | test | Rule file name. It is always used together with WorkspaceId. |
Sample requests
POST https://vmp.cn-beijing.volcengineapi.com/?Action=GetRuleFile&Version=2021-03-03
Content-Type: application/json
{
"Id": "1c3f6e48-b5e1-4832-8564-10eaac12a22c",
"WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
"Name": "test"
}
Request parameters
Parameter | Type | Sample value | Description |
Parameter | Type | Sample value | Description |
Id | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | Rule file ID. |
CreateTime | String | 2022-01-01T00:00:00Z | The creation date of the rule file. It is presented in RFC3339 format. |
LastUpdateTime | String | 2022-01-01T00:00:00Z | The latest date the rule file was updated. It is presented in RFC3339 format. |
Name | String | test | Rule file name. |
Description | String | This is a description | Description of the rule file. |
Content | String | groups: - name: example rules: - record: test expr: up | Rule file content. |
Status | String | Running | Status of rule file:
|
RuleCount | Long | 2 | Number of rules in the rule file. |
Sample responses
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "202211302208xxxx",
"Action": "GetRuleFile",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"Id": " 1c3f6e48-b5e1-4832-8564-10eaac12a22c",
"CreateTime": "2022-01-01T00:00:00Z",
"LastUpdateTime": "2022-01-01T00:00:00Z",
"Name": "test",
"description": "this is a description",
"content": "groups:\n- name: example\n rules:\n - expr: up\n record: test\n",
"Status": "Running",
"RuleCount": 2
}
}
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 |
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.Workspace | The specified Workspace {{id}} is not found. | The workspace with the ID was not found. |
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. |
Last updated: 2026.07.10 11:12:05
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
