Obtain a list of alerting notification policies.

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

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListNotifyPolicies	API name. The API name is ListNotifyPolicies.
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: The value ranges from 0 to 100. The default number is 10.
Filter	Object of NotifyPolicyFilter	No	-	Filter conditions of alerting notification policies.
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.

NotifyPolicyFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Exact query by IDs of alerting notification policies.
Name	String	No	test	Fuzzy query by the names of alerting notification policies.
ContactGroupIds	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Exact query by contact group IDs.
ChannelNotifyTemplateIds	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c","e28ae750-bbb8-4ff4-abf4-1e0e0f813ad1"]	A list of IDs for custom notification templates. It helps filter alerting notification policies by template IDs.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of alerting notification policies.
Items	Array of NotifyPolicy	-	A list of alerting notification policies.

NotifyPolicy

Parameter	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Alerting notification policy ID.
CreateTime	String	2020-01-01T00:00:00Z	The creation date of the alerting notification policy. It is presented in RFC3339 format.
Name	String	test	Name of the alerting notification policy.
Description	String	This is a description	Description of the alerting notification policy.
Levels	Array of NotifyPolicyLevel	-	Level of alerting notification policy.
ChannelNotifyTemplateIds	Array of String	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Custom notification policy ID.

NotifyPolicyLevel

Parameter	Type	Sample value	Description
Level	String	P0	Levels of alerting notification policies. Level P0, P1, and P2 are available currently.
ContactGroupIds	Array of String	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Contact group of the alerting notify policy.
Channels	Array of String	["Email"]	Notification methods of alerting notification policies: Email: Email Webhook: Generic Webhook LarkBotWebhook: Feishu bot DingTalkBotWebhook: DingTalkBot WeComBotWebhook: WeCom Bot
ResolvedChannels	Array of String	["Email"]	Methods to send notifications when alerts are cleared. Available methods include: Email: Email Webhook: Generic Webhook LarkBotWebhook: Feishu bot DingTalkBotWebhook: DingTalkBot WeComBotWebhook: WeCom Bot

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.
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.