projects

Changed on

Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

put/v2/{+name}

Request

  • Base URL: https://bigtableadmin.googleapis.com
  • URL: https://bigtableadmin.googleapis.com/v2/{+name}
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/bigtable.admin) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/bigtable.admin)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/bigtable.admin.cluster) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/bigtable.admin.cluster)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/bigtable.admin.instance) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/bigtable.admin.instance)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-bigtable.admin) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-bigtable.admin)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-bigtable.admin.cluster) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-bigtable.admin.cluster)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

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

Request body

defaultStorageType'STORAGE_TYPE_UNSPECIFIED' | 'SSD' | 'HDD'

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

locationstring

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}.

namestring

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

nodeScalingFactor'NODE_SCALING_FACTOR_UNSPECIFIED' | 'NODE_SCALING_FACTOR_1X' | 'NODE_SCALING_FACTOR_2X'

Immutable. The node scaling factor of this cluster.

serveNodesinteger

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.

state'STATE_NOT_KNOWN' | 'READY' | 'CREATING' | 'RESIZING' | 'DISABLED'

Output only. The current state of the cluster.

Response

Successful response

Changes

  • 2b3a1ca72455Revision changes
    • info

      the security scope https://www.googleapis.com/auth/bigtable.admin was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/bigtable.admin was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c

  • 5556245a313bRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/bigtable.admin was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/bigtable.admin was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c