Sign in

v1

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

Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

post/v2/{+parent}/clusters

Path parameters

parentstring required

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

Query parameters

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

Request body

namestring

The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/a-z*.

locationstring

Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/{project}/locations/{zone}.

defaultStorageType'STORAGE_TYPE_UNSPECIFIED' | 'SSD' | 'HDD'

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

nodeScalingFactor'NODE_SCALING_FACTOR_UNSPECIFIED' | 'NODE_SCALING_FACTOR_1X' | 'NODE_SCALING_FACTOR_2X'

Immutable. The node scaling factor of this cluster.

serveNodesinteger

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state'STATE_NOT_KNOWN' | 'READY' | 'CREATING' | 'RESIZING' | 'DISABLED'

Output only. The current state of the cluster.

Response

Successful response