Method: projects.locations.clusters.backup

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

HTTP request

POST https://redis.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:backup

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Redis cluster resource name using the form: projects/{projectId}/locations/{locationId}/clusters/{clusterId} where locationId refers to a GCP region.

Request body

The request body contains data with the following structure:

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

string (Duration format)

Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
backupId

string

Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.