Obtain alert notification templates.

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 access point that is the most optimal for the region of your services according to the Service addresses document.

Request method: POST

Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=ListNotifyTemplates&Version=2021-03-03

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListNotifyTemplates	API name. The API name is ListNotifyTemplates.
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. It is an integer from 0 to 100. The default number is 10.
Filter	Object of NotifyTemplateFilter	No	-	Filter condition.
SortBy	String	No	CreatedAt	Whether to perform query result sorting.The value CreatedAt indicates that the results will be sorted. Absence of this parameter indicates no sorting.
SortOrder	String	No	Asc	Sorting order of query results: Asc: indicates sorting in ascending order. Desc: indicates sorting in descending order.

NotifyTemplateFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Exact query by IDs.
Name	String	No	template-demo	Fuzzy query by names.
Channel	String	No	LarkBot	Exact query by channels. Valid values: LarkBotWebhook: Alert notification template for Lark. DingTalkBotWebhook: Alert notification template for DingTalk. WeComBotWebhook: Alerttification template for WeCom

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of query results.
Items	Array of NotifyTemplate	-	A list of query results.

NotifyTemplate

Parameter	Type	Sample value	Description
Id	String	test	Alert notification template ID.
Name	String	test	Name of alert notification template.
Active	Object of NotifyIntervalTemplate	-	Alert notification template.
Channel	String	LarkBotWebhook	Alert notification channel.
Resolved	Object of NotifyIntervalTemplate	-	Notification template used when alerts are cleared.
CreateTime	String	2020-01-01T00:00:00Z	The creation date of the alert notification template.
UpdateTime	String	2020-01-01T00:00:00Z	The update date of the alert notification template.
Description	String	This is a description	Description of alert notification template.

NotifyIntervalTemplate

Parameter	Type	Sample value	Description
Title	String	An alert has been raised in the {{ .Region }} of Volcano Engine	Template title.
Content	String	Alerting rule: [{{ .AlertingRuleName }}]({{ .AlertingRuleDetailURL }}) Alerting level: {{ .Level }} Alerting condition: {{ .PromQL }} {{ .Comparator }} {{ .Threshold }} [ last for {{ .For }} ]	Template content. For more details about configurations, please refer to Lark notification template and Structure and parameters of Variables.

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.	The specified parameter is invalid.
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.