Sign in

v1

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

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

put/v2/{+name}

Path parameters

namestring required

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

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