Method: projects.instances.update

Updates an instance within a project.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

(OutputOnly) The unique name of the instance. Values are of the form projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9].

Request body

The request body contains data with the following structure:

JSON representation
{
  "displayName": string,
  "state": enum(State),
  "type": enum(Type),
}
Fields
displayName

string

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

state

enum(State)

(OutputOnly) The current state of the instance.

type

enum(Type)

The type of the instance. Defaults to PRODUCTION.

Response body

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

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.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Bigtable Documentation