Method: projects.instances.tables.restore

Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The response type is Table, if successful.

HTTP request

POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/tables:restore

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the instance in which to create the restored table. This instance must be the parent of the source backup. Values are of the form projects/<project>/instances/<instance>.

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • bigtable.tables.create
  • bigtable.backups.restore

Request body

The request body contains data with the following structure:

JSON representation
{
  "tableId": string,
  "backup": string
}
Fields
tableId

string

Required. The id of the table to create and restore to. This table must not already exist. The tableId appended to parent forms the full table name of the form projects/<project>/instances/<instance>/tables/<tableId>.

backup

string

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>.

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.