Method: projects.locations.backupPlanAssociations.list

Lists BackupPlanAssociations in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location for which to retrieve backup Plan Associations information, in the format projects/{projectId}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve backup plan associations for all locations, use "-" for the {location} value.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results

Request body

The request body must be empty.

Response body

Response message for List BackupPlanAssociation

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

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

object (BackupPlanAssociation)

The list of Backup Plan Associations in the project for the specified location.

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

string

A token identifying a page of results the server should 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.