Method: projects.locations.backupVaults.dataSources.initiateBackup

Internal only. Initiates a backup.

HTTP request

POST https://backupdr.googleapis.com/v1/{dataSource=projects/*/locations/*/backupVaults/*/dataSources/*}:initiateBackup

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataSource

string

Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestId": string,
  "backupId": string
}
Fields
requestId

string

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 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).
backupId

string

Required. Resource ID of the Backup resource.

Response body

Response message for dataSources.initiateBackup.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "backup": string,
  "newBackupGenerationId": integer,
  "baseBackupGenerationId": integer
}
Fields
backup

string

The name of the backup that was created.
newBackupGenerationId

integer

The generation id of the new backup.
baseBackupGenerationId

integer

The generation id of the base backup. It is needed for the incremental backups.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataSource resource:

  • backupdr.bvdataSources.initiateBackup

For more information, see the IAM documentation.