Obtains an alert rule template. You can obtain a historical version.

Request description

Request method: POST

Request URL: https://vmp.cn-beijing.volcengineapi.com?Action=GetAlertingRuleTemplate&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.

Go to debug

Request parameters

Parameters	Type	Required	Sample value	Description
Action	String	Yes	GetAlertingRuleTemplate	The API name. The API name is GetAlertingRuleTemplate.
Version	String	Yes	2021-03-03	The API version. The API version is 2021-03-03.
Id	String	Yes	421d-**-6037**	The ID of the alert rule template.
Version	String	No	1.0.1	The version of the alert rule template. If this parameter is not specified, the latest version is returned.

Sample request

Response parameters

Parameters	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	The ID of an alerting rule template.
Version	String	1.0.1	The version of the alert rule template.
Name	String	test	The name of an alerting rule template.
Description	String	-	Descriptions of alerting rule templates.
CreateTime	String	2020-01-01T00:00:00Z	The time when the alert rule template was created.
UpdateTime	String	2020-01-01T00:00:00Z	The time when the alert rule template was updated.
Category	String	VKE	The name of the category to which the template belongs.
Items	Array of AlertingRuleTemplateItem	-	A list of alert rule templates.
Variables	Array of Variable	-	The variable list.
Labels	Array of TemplateKV	-	Global labels of alerting rule templates. They can be attached to alerts and have a higher priority than that configured for an individual rule in templates.

AlertingRuleTemplateItem

Parameters	Type	Sample value	Description
Id	Long	1	The serial number of the alert rule template item.
Name	String	test5	The items' names in alerting rule templates.
Labels	Array of TemplateKV	-	labels attached to alerting rules.
Levels	Array of AlertingRuleLevel	-	Alerting level.
PromQL	String	my_metrics{cluster=~"$Cluster"}	PromQL statements based on alerting rules.
Annotations	Array of TemplateKV	-	Annotations attached to alering rules.
Description	String	-	The description of an alerting rule.

Variable

Parameters	Type	Sample value	Description
Id	Long	1	ID of variable.
Name	String	Cluster	The variable name that will be used in PromQL. tip Variables are used for more specific filtering of cloud service resources in monitoring data. For example, you can find a specific VKE cluster or namespace in VKE products by using variables. A variable name needs to start with an uppercase letter and use CamelCase convention. For example, ClusterNode.
Type	String	Query	Variable type. Available values: Query: the dynamic PromQL variable. You can only define the name, not the value, for this type of variable. For example, cluster metrics such as cluster IDs and namespaces always have values generated dynamically. The values of dynamic variables can be obtained by specifying PromQL statements and regular expressions. Custom: a type of variables that have predefined values. For example, in cluster metrics, the workload type is fixed (such as Deployment, StatefulSet, DaemonSet) and can be directly specified.
Alias	String	test6	Aliases of variables that will be displayed in the variable selector.
Multi	Boolean	true	Whether the variable can have multiple options enabled at the same time. Available values: true: enable multiple options at the same time. false: it can only enable a single option.
Query	String	kube_pod_info	A query by variables' values. The variables that are only applicable to the type Query.
Regex	String	/.pod="(.?)".*	A regular expression used to extract variables' values. The variables that are only applicable to the type Query.
Values	Array of String	Deployment	Predefined values of variables. The variables that are only applicable to the type Custom.
Default	Array of String	demo	Default value of variable. If the value is left empty: The parameter IncludeAll with value False means none of the templates will be selected. The parameter IncludeAll with value True means all of the templates will be selected.
QueryType	String	queryResult	The query types for Query variables. The variables that are only applicable to the type Query.
IncludeAll	Boolean	true	Whether the variable has the option Select all. Values: true: it has the option Select all. false: it does not have the option Select all.

TemplateKV

Parameters	Type	Sample value	Description
Name	String	key1	Tag key.
Value	String	value1	Value of the label. If the configuration is empty, it means the key will be deleted.

AlertingRuleLevel

Parameters	Type	Sample value	Description
Level	String	P0	Alerting rule level. Level P0, P1, and P2 are available currently.
For	String	5 minutes	Alert duration, value: 0s: raise immediately 1m: 1 minute 2m: 2 minutes 5m: 5 minutes 10m: 10 minutes
Comparator	String	>	Operators used in alert rules: >: greater than >=: greater than or equal to <: less than <=: less than or equal to ==: equal to !=: not equal to
Threshold	Double	1.0	Threshold of the alert rule.

Sample response

Error codes

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 codes	Error messages	Description
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	The current account is not subscribed to the VMP service.
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	The input is invalid. For example, the workspace name does not meet the requirements.
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	A required parameter is missing.

Volcengine Managed Service for Prometheus