Stay organized with collections
Save and categorize content based on your preferences.
Updates a cluster within an instance.
Note that clusters.update does not support updating clusterConfig.cluster_autoscaling_config. In order to update it, you must use clusters.partialUpdateCluster.
HTTP request
PUT https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/clusters/*}
The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.
Request body
The request body contains data with the following structure:
JSON representation
{"location": string,"state": enum (State),"serveNodes": integer,"nodeScalingFactor": enum (NodeScalingFactor),"defaultStorageType": enum (StorageType),"encryptionConfig": {object (EncryptionConfig)},// Union field config can be only one of the following:"clusterConfig": {object (ClusterConfig)}// End of list of possible types for union field config.}
Fields
location
string
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}.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis operation updates an existing cluster within a Bigtable instance, excluding the \u003ccode\u003eclusterConfig.cluster_autoscaling_config\u003c/code\u003e, which requires a separate \u003ccode\u003epartialUpdateCluster\u003c/code\u003e call.\u003c/p\u003e\n"],["\u003cp\u003eThe cluster is identified by its unique name, specified in the URL path as \u003ccode\u003eprojects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can include updates to the cluster's \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, \u003ccode\u003eserveNodes\u003c/code\u003e, \u003ccode\u003enodeScalingFactor\u003c/code\u003e, \u003ccode\u003edefaultStorageType\u003c/code\u003e, \u003ccode\u003eencryptionConfig\u003c/code\u003e, or \u003ccode\u003eclusterConfig\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe cluster's immutable properties are the \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003enodeScalingFactor\u003c/code\u003e, \u003ccode\u003edefaultStorageType\u003c/code\u003e, and \u003ccode\u003eencryptionConfig\u003c/code\u003e, as outlined in the request body documentation.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful update requests will return an instance of \u003ccode\u003eOperation\u003c/code\u003e, and the operation requires specific OAuth scopes for authorization, such as \u003ccode\u003ehttps://www.googleapis.com/auth/bigtable.admin\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
