Obtain the alert list.

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

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListAlerts	API name. The API name is ListAlerts.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
Limit	Long	No	10	Alerts per page: The default value is 10. It can be any integer from 0 to 100.
SearchAfter	String	No	*********	Page token.
Filter	Object of AlertFilter	No	-	Alert filter condition.
OrderBy	String	No	InitialAlertTimestamp	Specify a value for sorting order. The only supported value is InitialAlertTimestamp.
Desc	Boolean	No	true	Whether to sort results in descending order: true: apply descending order. false: Do not apply descending order.

AlertFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["e28ae750-bbb8-4ff4-abf4***"]	Exact query by alert IDs.
CurrentPhase	String	No	Active	Exact query by current statuses of alerts: Pending: The threshold is reached but the alert duration has not yet elapsed. Active: alert has been raised Resolved: cleared automatically Disabled: cleared by humans
Level	String	No	P0	Exact query by alert levels. Available levels: P0, P1, and P2.
AlertingRuleIds	Array of String	No	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	Exact query by alert rule IDs.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of alerts.
ContinueToken	String	*******	The page token used to mark one of the segments in a list.
Items	Array of Alert	-	Alert list.

Alert

Parameter	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	The alert ID.
AlertingRuleId	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Alert rule ID.
Levels	Array of AlertingRuleLevel		Alert level configurations.
InitialAlertTimestamp	String	2020-01-01T00:00:00Z	The start of a time range for alert statistics. It is presented in RFC3339 format.
LastAlertTimestamp	String	2020-01-01T00:00:00Z	The time of the latest alert that has been raised. It is presented in RFC3339 format.
ResolveTimestamp	String	2020-01-01T00:00:00Z	The end of a time range for alert statistics. It is presented in RFC3339 format.
CurrentPhase	String	Active	Alert status: Pending: The threshold is reached but the alert duration has not yet elapsed. Active: alert has been raised Resolved: cleared automatically Disabled: cleared by humans
CurrentLevel	String	P0	Levels of alerts. Level P0, P1, and P2 are available currently.
AlertingRuleType	String	vmp/PromQL	Alert rule type. Available value is vmp/PromQL.
AlertingRuleQuery	Object of AlertingRuleQuery	-	Alert configuration.
Resource	Object of AlertResource	-	Alert resource.

AlertingRuleLevel

Parameter	Type	Sample value	Description
Level	String	P0	Levels of alerts. Level P0, P1, and P2 are available currently.
For	String	5 minutes	How long the state of meeting alert conditions needs to last before raising alerts: 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	The threshold of the alert.

AlertingRuleQuery

Parameter	Type	Sample value	Description
WorkspaceId	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Workspace ID
PromQL	String	sum(up)	Query statement.

AlertResource

Parameter	Type	Sample value	Description
Labels	Array of LabelKeyValuePair	-	A list of resource labels. Each element in the list is a key-value pair. The key represents the resource label (e.g. Pod). The value represents the resource name (e.g. Pod Name).

LabelKeyValuePair

Parameter	Type	Sample value	Description
Key	String	key	Key
Value	String	value	Value

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