Method: projects.locations.restorePlans.restores.list

Lists the Restores for a given RestorePlan.

HTTP request

GET https://gkebackup.googleapis.com/v1/{parent=projects/*/locations/*/restorePlans/*}/restores

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

Authorization requires the following IAM permission on the specified resource parent:

  • gkebackup.restores.list

Query parameters

Parameters
pageSize

integer

The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's nextPageToken to determine if there are more instances left to be queried.

pageToken

string

The value of nextPageToken received from a previous restores.list call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to restores.list must match the call that provided the page token.

filter

string

Field match expression used to filter the results.

orderBy

string

Field by which to sort the results.

Request body

The request body must be empty.

Response body

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

Response message for restores.list.

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

object (Restore)

The list of Restores matching the given criteria.

nextPageToken

string

A token which may be sent as pageToken in a subsequent restores.list call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.

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.