REST Resource: projects.instances

Resource: Instance

An isolated set of Cloud Spanner resources on which databases can be hosted.

JSON representation
{
  "name": string,
  "config": string,
  "displayName": string,
  "nodeCount": number,
  "state": enum(State),
  "labels": {
    string: string,
    ...
  },
}
Fields
name

string

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length.

config

string

Required. The name of the instance's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and instanceConfigs.list.

displayName

string

Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

nodeCount

number

Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state READY.

See the documentation for more information about nodes.

state

enum(State)

Output only. The current instance state. For instances.create, the state must be either omitted or set to CREATING. For instances.patch, the state must be either omitted or set to READY.

labels

map (key: string, value: string)

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

  • Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.
  • No more than 64 labels can be associated with a given resource.

See https://goo.gl/xmQnxf for more information on and examples of labels.

If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

State

Indicates the current state of the instance.

Enums
STATE_UNSPECIFIED Not specified.
CREATING The instance is still being created. Resources may not be available yet, and operations such as database creation may not work.
READY The instance is fully created and ready to do work such as creating databases.

Methods

create

Creates an instance and begins preparing it to begin serving.

delete

Deletes an instance.

get

Gets information about a particular instance.

getIamPolicy

Gets the access control policy for an instance resource.

list

Lists all instances in the given project.

patch

Updates an instance, and begins allocating or releasing resources as requested.

setIamPolicy

Sets the access control policy on an instance resource.

testIamPermissions

Returns permissions that the caller has on the specified instance resource.

Send feedback about...

Cloud Spanner Documentation