Collection: projects.instances

Resource: Instance

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from a single Cluster.

JSON representation
{
  "name": string,
  "displayName": string,
  "state": enum(State),
  "type": enum(Type),
}
Fields
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].

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.

State

Possible states of an instance.

Enums
STATE_NOT_KNOWN The state of the instance could not be determined.
READY The instance has been successfully created and can serve requests to its tables.
CREATING The instance is currently being created, and may be destroyed if the creation process encounters an error.

Type

The type of the instance.

Enums
TYPE_UNSPECIFIED The type of the instance is unspecified. If set when creating an instance, a PRODUCTION instance will be created. If set when updating an instance, the type will be left unchanged.
PRODUCTION An instance meant for production use. serveNodes must be set on the cluster.
DEVELOPMENT The instance is meant for development and testing purposes only; it has no performance or uptime guarantees and is not covered by SLA. After a development instance is created, it can be upgraded by updating the instance to type PRODUCTION. An instance created as a production instance cannot be changed to a development instance. When creating a development instance, serveNodes on the cluster must not be set.

Methods

create

Create an instance within a project.

delete

Delete an instance from a project.

get

Gets information about an instance.

list

Lists information about instances in a project.

update

Updates an instance within a project.

Monitor your resources on the go

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

Send feedback about...

Cloud Bigtable Documentation