Method: projects.instances.clusters.partialUpdateCluster

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

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. Must be explicitly set.

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.