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:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-08 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of BackupPlanAssociations for a specified project and location, using the format \u003ccode\u003eprojects/{projectId}/locations/{location}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses a GET request with gRPC Transcoding, allowing for optional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e to refine the results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, as all parameters are either part of the path or provided as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response includes a list of \u003ccode\u003ebackupPlanAssociations\u003c/code\u003e, along with a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination and an \u003ccode\u003eunreachable\u003c/code\u003e field listing any inaccessible locations.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backupPlanAssociations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListBackupPlanAssociationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists BackupPlanAssociations in a given project and location.\n\n### HTTP request\n\n`GET https://backupdr.googleapis.com/v1/{parent=projects/*/locations/*}/backupPlanAssociations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for List BackupPlanAssociation\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
