- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists the existing alerting policies for the workspace.
HTTP request
GET https://monitoring.googleapis.com/v3/{name}/alertPolicies
Path parameters
Parameters | |
---|---|
name |
Required. The project whose alert policies are to be listed. The format is:
Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
filter |
Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see sorting and filtering. |
order |
Optional. A comma-separated list of fields by which to sort the result. Supports the same set of field references as the For more details, see sorting and filtering. |
page |
Optional. The maximum number of results to return in a single response. |
page |
Optional. If this field is not empty then it must contain the |
Request body
The request body must be empty.
Response body
The protocol for the alertPolicies.list
response.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"alertPolicies": [
{
object ( |
Fields | |
---|---|
alert |
The returned alert policies. |
next |
If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as |
total |
The total number of alert policies in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 |
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.