Updates a cluster within an instance.
clusters.update is deprecated. Please use clusters.partialUpdateCluster instead.
HTTP request
PUT https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/clusters/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The unique name of the cluster. Values are of the form |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "location": string, "state": enum ( |
Fields | |
---|---|
location |
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 |
state |
Output only. The current state of the cluster. |
serveNodes |
Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. |
defaultStorageType |
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. |
encryptionConfig |
Immutable. The encryption configuration for CMEK-protected clusters. |
Response body
If successful, the response body contains an instance of Operation
.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigtable.admin
https://www.googleapis.com/auth/bigtable.admin.cluster
https://www.googleapis.com/auth/bigtable.admin.instance
https://www.googleapis.com/auth/cloud-bigtable.admin
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.