Method: projects.instances.clusters.update

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 URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.

name

string

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

JSON representation
{ "location": string, "state": enum (`State`), "serveNodes": integer, "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`. }

{
  "location": string,
  "state": enum (State),
  "serveNodes": integer,
  "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}`.
`state`	`enum (State)` Output only. The current state of the cluster.
`serveNodes`	`integer` 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.
`defaultStorageType`	`enum (StorageType)` Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
`encryptionConfig`	`object (EncryptionConfig)` Immutable. The encryption configuration for CMEK-protected clusters.
Union field `config`. `config` can be only one of the following:
`clusterConfig`	`object (ClusterConfig)` Configuration for this cluster.

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.