Retrieve the list of RecordingRules.

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=ListRules&Version=2021-03-03

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListRules	API name. The API name is ListRules.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
PageNumber	Long	No	1	Current page number. The minimum and default values are both 1.
PageSize	Long	No	10	Results per page: A number from 0 to 100. The default number is 10.
Filter	Object of RuleFilter	No	-	Filter conditions for rules.

RuleFilter

Parameter	Type	Required	Sample value	Description
Kind	String	Yes	Recording	Filter by rule type. Available value is Recording.
Name	String	No	test	Fuzzy query by the name of a rule.
Status	Array of String	No	["Running"]	Exact query by rule statuses.
WorkspaceId	String	Yes	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Exact query by workspace IDs.
RuleFileNames	Array of String	No	["test"]	Fuzzy query by names of rule files.
RuleGroupNames	Array of String	No	["test"]	Fuzzy query by names of rule groups.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of rules.
Items	Array of Rule	-	A list of rules.

Rule

Parameter	Type	Sample value	Description
Expr	String	sum(rate(container_cpu_usage_seconds_total[5m])) by (pod)	The PromQL expression of a rule.
Kind	String	Recording	Rule type. Available value is Recording.
Name	String	my_first_recording_rule	Rule name. Fuzzy query can be applied to it.
Labels	Array of LabelKeyValuePair	source:recordingRule	Labels that are added or overwritten before metrics are stored.
Reason	String	internal error	The reason that the status changes to error.
Status	String	Running	Rule status\n- Running\n- Updating\n- OverdueShutted (shutdown due to overdue payment)\n- Resuming\n- Error\n- Pending
RuleFileName	String	test	The name of the rule file to which the rule belongs
RuleGroupName	String	test	The name of the rule group to which the rule belongs
LastEvaluation	String	2022-01-01T00:00:00Z	The latest execution time, in RFC3339 format.

LabelKeyValuePair

Parameter	Type	Sample value	Description
Key	String	key	The key of a label
Value	String	value	The value of a label

Sample responses

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
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 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.
404	NotFound.Workspace	The specified Workspace {{id}} is not found.	The workspace with the ID was not found.