Method: projects.locations.clusters.restore

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

HTTP request

POST https://alloydb.googleapis.com/v1/{parent=projects/*/locations/*}/clusters:restore

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

parent

string

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.

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

alloydb.clusters.create

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "clusterId" : string , "cluster" : { object ( `Cluster` ) } , "requestId" : string , "validateOnly" : boolean , // Union field `source` can be only one of the following: "backupSource" : { object ( `BackupSource` ) } , "continuousBackupSource" : { object ( `ContinuousBackupSource` ) } // End of list of possible types for union field `source` . }

 { 
 "clusterId" 
 : 
 string 
 , 
 "cluster" 
 : 
 { 
 object (  Cluster 
 
) 
 } 
 , 
 "requestId" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 // Union field source 
can be only one of the following: 
 "backupSource" 
 : 
 { 
 object (  BackupSource 
 
) 
 } 
 , 
 "continuousBackupSource" 
 : 
 { 
 object (  ContinuousBackupSource 
 
) 
 } 
 // End of list of possible types for union field source 
. 
 }

Fields

clusterId

string

Required. ID of the requesting object.

cluster

object ( Cluster )

Required. The resource being created

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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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).

validateOnly

boolean

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

Union field source . Required. The source to import from. source can be only one of the following:

backupSource

object ( BackupSource )

Backup source.

continuousBackupSource

object ( ContinuousBackupSource )

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

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 .

ContinuousBackupSource

Message describing a ContinuousBackupSource.

JSON representation
{ "cluster" : string , "pointInTime" : string }

Fields

Fields
`cluster`	`string` Required. The source cluster from which to restore. This cluster must have continuous backup enabled for this operation to succeed. For the required format, see the comment on the Cluster.name field.
`pointInTime`	`string ( Timestamp format)` Required. The point in time to restore to. 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"` .

cluster

string

Required. The source cluster from which to restore. This cluster must have continuous backup enabled for this operation to succeed. For the required format, see the comment on the Cluster.name field.

pointInTime

string ( Timestamp format)

Required. The point in time to restore to.

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" .