- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operationId>
and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata
. The response field type is Backup
, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
HTTP request
POST https://spanner.googleapis.com/v1/{parent=projects/*/instances/*}/backups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
backup |
Required. The id of the backup to be created. The |
encryption |
Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database by default, namely |
Request body
The request body contains an instance of Backup
.
Response body
If successful, the response body contains a newly created instance of Operation
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/spanner.admin
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the database
resource:
spanner.databases.createBackup
Requires the following IAM permission on the parent
resource:
spanner.backups.create
For more information, see the IAM documentation.