Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1328122178.2 KB
projects

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

post/v1/{+parent}/clusters:createsecondary

Path parameters

parentstring required

Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.

Query parameters

clusterIdstring

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

requestIdstring

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

validateOnlyboolean

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

Request body

databaseVersion'DATABASE_VERSION_UNSPECIFIED' | 'POSTGRES_13' | 'POSTGRES_14' | 'POSTGRES_15' | 'POSTGRES_16' | 'POSTGRES_17' | 'POSTGRES_18'

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

networkstring

Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.

subscriptionType'SUBSCRIPTION_TYPE_UNSPECIFIED' | 'STANDARD' | 'TRIAL'

Optional. Subscription type of the cluster.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

reconcilingboolean

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

deleteTimestring google-datetime

Output only. Delete time stamp

namestring

Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

createTimestring google-datetime

Output only. Create time stamp

labelsobject

Labels as key value pairs

displayNamestring

User-settable and human-readable display name for the Cluster.

maintenanceVersionSelectionPolicy'MAINTENANCE_VERSION_SELECTION_POLICY_UNSPECIFIED' | 'MAINTENANCE_VERSION_SELECTION_POLICY_LATEST' | 'MAINTENANCE_VERSION_SELECTION_POLICY_DEFAULT'

Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.

state'STATE_UNSPECIFIED' | 'READY' | 'STOPPED' | 'EMPTY' | 'CREATING' | 'DELETING' | 'FAILED' | 'BOOTSTRAPPING' | 'MAINTENANCE' | 'PROMOTING' | 'SWITCHOVER'

Output only. The current serving state of the cluster.

uidstring

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

satisfiesPzsboolean

Output only. Reserved for future use.

etagstring

For Resource freshness validation (https://google.aip.dev/154)

clusterType'CLUSTER_TYPE_UNSPECIFIED' | 'PRIMARY' | 'SECONDARY'

Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster

annotationsobject

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

updateTimestring google-datetime

Output only. Update time stamp

Response

Successful response