REST Resource: projects.instances.clusters

Resource: Cluster

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

JSON representation
{
  "name": string,
  "location": string,
  "state": enum (State),
  "serveNodes": integer,
  "defaultStorageType": enum (StorageType),
  "encryptionConfig": {
    object (EncryptionConfig)
  }
}
Fields
name

string

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

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

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

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.

State

Possible states of a cluster.

Enums
STATE_NOT_KNOWN The state of the cluster could not be determined.
READY The cluster has been successfully created and is ready to serve requests.
CREATING The cluster is currently being created, and may be destroyed if the creation process encounters an error. A cluster may not be able to serve requests while being created.
RESIZING The cluster is currently being resized, and may revert to its previous node count if the process encounters an error. A cluster is still capable of serving requests while being resized, but may exhibit performance as if its number of allocated nodes is between the starting and requested states.
DISABLED The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.

StorageType

Storage media types for persisting Bigtable data.

Enums
STORAGE_TYPE_UNSPECIFIED The user did not specify a storage type.
SSD Flash (SSD) storage should be used.
HDD Magnetic drive (HDD) storage should be used.

EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

JSON representation
{
  "kmsKeyName": string
}
Fields
kmsKeyName

string

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

Methods

create

Creates a cluster within an instance.

delete

Deletes a cluster from an instance.

get

Gets information about a cluster.

list

Lists information about clusters in an instance.

partialUpdateCluster

Partially updates a cluster within a project.

update

Updates a cluster within an instance.