Method: projects.locations.resourceMaintenances.list

Retrieve a collection of resource maintenances.

HTTP request

GET https://maintenance.googleapis.com/v1beta/{parent=projects/*/locations/*}/resourceMaintenances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent (project and location) where the resource maintenances will be listed. Specified in the format projects/*/locations/*.

For target resources that are regional and global, the location of ResourceMaintenance is always the same as the target resource location.

For target resources that are zonal, the ResourceMaintenance location is a region corresponding to the zone of target resource. For example, for a Cloud SQL instance in the us-west1-a zone, the ResourceMaintenance is in the us-west1 region.

Location "-" matches all locations.

Query parameters

Parameters
pageSize

integer

The maximum number of resource maintenances to send per page. The default page size is 20 and the maximum is 1000.
pageToken

string

The page token: If the nextPageToken from a previous response is provided, this request will send the subsequent page.
filter

string

Filter the list as specified in https://google.aip.dev/160. Supported fields include:

  • state
  • resource.location
  • resource.resourceName
  • resource.type
  • maintenance.maintenanceName
  • maintenanceStartTime
  • maintenanceCompleteTime
Examples:
  • state="SCHEDULED"
  • resource.location="us-central1-c"
  • resource.resourceName=~"*/instance-20241212-211259"
  • maintenanceStartTime>"2000-10-11T20:44:51Z"
  • state="SCHEDULED" OR resource.type="compute.googleapis.com/Instance"
  • maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"

Request body

The request body must be empty.

Response body

The response structure for the resourceMaintenances.list method.

If successful, the response body contains data with the following structure:

}
JSON representation 
{
  "resourceMaintenances": [
    {
      object (ResourceMaintenance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
Fields
resourceMaintenances[]

object (ResourceMaintenance)

The resulting resource maintenances.
nextPageToken

string

If present, the next page token can be provided to a subsequent resourceMaintenances.list call to list the next page. If empty, there are no more pages.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • maintenance.resourceMaintenances.list

For more information, see the IAM documentation.