Method: projects.locations.backupPlans.list

Lists BackupPlans in a given project and location.

HTTP request

GET https://backupdr.googleapis.com/v1/{parent=projects/*/locations/*}/backupPlans

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location for which to retrieve BackupPlans information. Format: projects/{project}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1. To retrieve backup plans for all locations, use "-" for the {location} value.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include 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

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

string

Optional. Field match expression used to filter the results.
orderBy

string

Optional. Field by which to sort the results.

Request body

The request body must be empty.

Response body

The response message for getting a list of BackupPlan.

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

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

object (BackupPlan)

The list of BackupPlans in the project for the specified location.

If the {location} value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan
nextPageToken

string

A token which may be sent as pageToken in a subsequent backupPlans.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.