Method: projects.instances.clusters.backups.copy

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

HTTP request

POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*/clusters/*}/backups:copy

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster}.

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

  • bigtable.backups.create

Request body

The request body contains data with the following structure:

JSON representation 
{
  "backupId": string,
  "sourceBackup": string,
  "expireTime": string
}
Fields
backupId

string

Required. The id of the new backup. The backupId along with parent are combined as {parent}/backups/{backupId} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backupId}. This string must be between 1 and 50 characters in length and match the regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
sourceBackup

string

Required. The source backup to be copied from. The source backup needs to be in READY state for it to be copied. Copying a copied backup is not allowed. Once backups.copy is in progress, the source backup cannot be deleted or cleaned up on expiration until backups.copy is finished. Values are of the form: projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>.

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

  • bigtable.backups.read
expireTime

string (Timestamp format)

Required. Required. The expiration time of the copied backup with microsecond granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expireTime has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.