Obtain a list of alerting aggregation 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 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=ListNotifyGroupPolicies&Version=2021-03-03

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListNotifyGroupPolicies	API name. The API name is ListNotifyGroupPolicies.
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 value is 10.
Filter	Object of NotifyGroupPolicyFilter	No	-	Filter conditions of alerting aggregation policies.
SortBy	String	No	CreatedAt	Whether to perform query result sorting.The value CreatedAt indicates 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.

NotifyGroupPolicyFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Exact query by IDs of alerting aggregation policies.
Name	String	No	test	Fuzzy query by the names of alerting aggregation policies.

Sample requests

Response parameters

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

NotifyGroupPolicy

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

NotifyGroupPolicyLevel

Parameter	Type	Sample value	Description
Level	String	P0	Levels of alerting aggregation policies. Level P0, P1, and P2 are available currently.
GroupBy	Array of String	["__rule__"]	Aggregation dimension. Available value is rule.
GroupWait	String	30	Waiting time. It is a positive integer in seconds.
GroupInterval	String	30	Aggregation interval. It is a positive integer in seconds.
RepeatInterval	String	30	Repeat interval. It is a positive integer in seconds.

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