Obtain the historical records of alerts.

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

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListAlertSamples	API name. The API name is ListAlertSamples.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
Limit	Long	No	100	Maximum records allowed to be returned. The default number is 100. You can set it to 500 at most.
Filter	Object of AlertSampleFilter	Yes	-	Filter conditions foralertecords.

AlertSampleFilter

Parameter	Type	Required	Sample value	Description
AlertId	String	Yes	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Filtered by IDs of alert records.
SampleSince	Long	No	1600885800	The start of the time range to filter alert records.
SampleUntil	Long	No	1600885800	The end of a time range for alert statistics.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of alert records.
Items	Array of AlertSample	-	A list of alert records.

AlertSample

Parameter	Type	Sample value	Description
AlertId	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	Alert record ID.
Timestamp	Long	1686232540	The UNIX timestamp of the alert record.
Phase	String	Active	Statuses of alert records: Pending: it has reached or exceeded the threshold but has not lasted long enough yet Active: alert has been raised Resolved: cleared automatically Disabled: cleared by humans
Level	String	P0	Levels of alert records. Level P0, P1, and P2 are available currently.
Value	Double	123.123	The value obtained by using PromQL statement on alert rules.

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.