Method: projects.instances.clusters.update

Updates a cluster within an instance.

HTTP request

PUT https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/clusters/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

(OutputOnly) 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": number,
  "defaultStorageType": enum(StorageType),
}
Fields
location

string

(CreationOnly) 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)

(OutputOnly) The current state of the cluster.

serveNodes

number

The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

defaultStorageType

enum(StorageType)

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

Response body

If successful, the response body contains an instance of Operation.

Authorization

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 Auth Guide.

Send feedback about...

Cloud Bigtable Documentation