2024-08-07
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.restore
Path: v1/{+name}:restore
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Restore from a Backup
▼ ▲ backupdr.projects.locations.backupPlans.create
Path: v1/{+parent}/backupPlans
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans
HTTP Method: POST
Parameters:
parent
Description: Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
backupPlanId
Description: Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
Location: query
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a BackupPlan
▼ ▲ backupdr.projects.locations.backupPlans.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single BackupPlan.
▼ ▲ backupdr.projects.locations.backupPlans.list
Path: v1/{+parent}/backupPlans
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans
HTTP Method: GET
Parameters:
parent
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: 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 next_page_token to determine if there are more instances left to be queried.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.
Location: query
Type: string
filter
Description: Optional. Field match expression used to filter the results.
Location: query
Type: string
orderBy
Description: Optional. Field by which to sort the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists BackupPlans in a given project and location.
▼ ▲ backupdr.projects.locations.backupPlans.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single BackupPlan.
▼ ▲ backupdr.projects.locations.backupPlanAssociations.create
Path: v1/{+parent}/backupPlanAssociations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations
HTTP Method: POST
Parameters:
parent
Description: Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
backupPlanAssociationId
Description: Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
Location: query
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a BackupPlanAssociation
▼ ▲ backupdr.projects.locations.backupPlanAssociations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single BackupPlanAssociation.
▼ ▲ backupdr.projects.locations.backupPlanAssociations.list
Path: v1/{+parent}/backupPlanAssociations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/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.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists BackupPlanAssociations in a given project and location.
▼ ▲ backupdr.projects.locations.backupPlanAssociations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single BackupPlanAssociation.
▼ ▲ backupdr.projects.locations.backupPlanAssociations.triggerBackup
Path: v1/{+name}:triggerBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup
HTTP Method: POST
Parameters:
name
Description: Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Triggers a new Backup.