GET Alerts History.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/alerts/history';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/alerts/history \ --header 'Authorization: <Authorization>'GET the history of alert notifications sent to the end-user between the start_time and end_time that matches the filter specified in the request.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace namespace to scope the listing of alerts. For “system” namespace, all alerts for the tenant will be returned.
Query Parameters
Section titled “Query Parameters”HighDiskUsage”, severity=“critical”}”
List of matchers to filter alert by.
Syntax for filter := {[”|”!”]
= : Select labels that are exactly equal to the provided string
!= : Select labels that are not equal to the provided string.
When more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.
Optional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.
Fetch alerts whose timestamp >= start_time format: unix_timestamp|RFC 3339
Optional: If not specified, then the start_time will be evaluated to end_time-10m
If end_time is not specified, then the start_time will be evaluated to
Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339
Optional: If not specified, then the end_time will be evaluated to start_time+10m
If start_time is not specified, then the end_time will be evaluated to
Responses
Section titled “Responses”A successful response.
Response message for AlertsHistoryRequest/AlertsHistoryScrollRequest.
object
List of alerts that matched the filter. Contains no more than 500 alerts per response.
Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF). Note: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the scroll request should be sent within 2 minutes upon receiving the response.
Total number of alerts that matched the query.
Examplegenerated
{ "alerts": [ "example" ], "scroll_id": "example", "total_hits": "example"}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example