- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists the existing alerts for the metrics scope of the project.
HTTP request
GET https://monitoring.googleapis.com/v3/{parent}/alerts
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The name of the project to list alerts for. |
Query parameters
filter
string
Optional. An alert is returned if there is a match on any fields belonging to the alert or its subfields.
orderBy
string
Optional. A comma-separated list of fields in Alert
to use for sorting. The default sort direction is ascending. To specify descending order for a field, add a desc
modifier. The following fields are supported:
-
openTime -
closeTime
For example, closeTime desc, openTime
will return the alerts closed most recently, with ties broken in the order of older alerts listed first.
If the field is not set, the results are sorted by openTime desc
.
pageSize
integer
Optional. The maximum number of results to return in a single response. If not set to a positive number, at most 50 alerts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
Optional. If non-empty, pageToken
must contain a value returned as the nextPageToken
in a previous response to request the next set of results.
Request body
The request body must be empty.
Response body
The alerts.list
response.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"alerts"
:
[
{
object (
|
| Fields | |
|---|---|
alerts[]
|
The list of alerts. |
nextPageToken
|
If not empty, indicates that there may be more results that match the request. Use the value in the |
totalSize
|
The estimated total number of matching results for this query. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring -
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview .
