Method: projects.instances.clusters.partialUpdateCluster

Stay organized with collections Save and categorize content based on your preferences.

Partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set clusterConfig.cluster_autoscaling_config. When autoscaling is enabled, serveNodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serveNodes to non-zero and clusterConfig.cluster_autoscaling_config to non-empty, and also specify both in the updateMask.

To disable autoscaling, clear clusterConfig.cluster_autoscaling_config, and explicitly set a serve_node count via the updateMask.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
cluster.name

string

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The subset of Cluster fields which should be replaced.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of 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.