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 of the resource maintenance.

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

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,}
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.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.