Method: projects.locations.clusters.createsecondary

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The location of the new cluster. 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

Query parameters

Parameters
clusterId

string

Required. ID of the requesting object (the secondary cluster).

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

validateOnly

boolean

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

Request body

The request body contains an instance of Cluster.

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.