REST Resource: projects.locations.clusters.instances

Stay organized with collections Save and categorize content based on your preferences.

Resource: Instance

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. NEXT ID: 22

JSON representation
{
  "name": string,
  "displayName": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "instanceType": enum (InstanceType),
  "machineConfig": {
    object (MachineConfig)
  },
  "availabilityType": enum (AvailabilityType),
  "gceZone": string,
  "databaseFlags": {
    string: string,
    ...
  },
  "writableNode": {
    object (Node)
  },
  "nodes": [
    {
      object (Node)
    }
  ],
  "readPoolConfig": {
    object (ReadPoolConfig)
  },
  "ipAddress": string,
  "reconciling": boolean,
  "etag": string,
  "annotations": {
    string: string,
    ...
  }
}
Fields
name

string

Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{clusterId}/instances/{instanceId} where the cluster and instance ID segments should satisfy the regex expression "a-z?", e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{clusterId}

displayName

string

User-settable and human-readable display name for the Instance.

uid

string

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

createTime

string (Timestamp format)

Output only. Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

deleteTime

string (Timestamp format)

Output only. Delete time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels as key value pairs

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

state

enum (State)

Output only. The current serving state of the instance.

instanceType

enum (InstanceType)

Required. The type of the instance. Specified at creation time.

machineConfig

object (MachineConfig)

Configurations for the machines that host the underlying database engine.

availabilityType

enum (AvailabilityType)

Availability type of an Instance. Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types.

gceZone

string

The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

databaseFlags

map (key: string, value: string)

Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary.

This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

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

writableNode

object (Node)

Output only. This is set for the read-write VM of the PRIMARY instance only.

nodes[]

object (Node)

Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

readPoolConfig

object (ReadPoolConfig)

Read pool specific config.

ipAddress

string

Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

reconciling

boolean

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

etag

string

For Resource freshness validation (https://google.aip.dev/154)

annotations

map (key: string, value: string)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

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

State

Instance State

Enums
STATE_UNSPECIFIED The state of the instance is unknown.
READY The instance is active and running.
STOPPED The instance is stopped. Instance name and IP resources are preserved.
CREATING The instance is being created.
DELETING The instance is being deleted.
MAINTENANCE The instance is down for maintenance.
FAILED The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.
BOOTSTRAPPING Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that index unused in case that state also needs to exposed via consumer apis in future. The instance has been configured to sync data from some other source.

InstanceType

Type of an Instance

Enums
INSTANCE_TYPE_UNSPECIFIED The type of the instance is unknown.
PRIMARY PRIMARY instances support read and write operations.
READ_POOL READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).

MachineConfig

MachineConfig describes the configuration of a machine.

JSON representation
{
  "cpuCount": integer
}
Fields
cpuCount

integer

The number of CPU's in the VM instance.

AvailabilityType

The Availability type of an instance. Potential values:
ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

Enums
AVAILABILITY_TYPE_UNSPECIFIED This is an unknown Availability type.
ZONAL Zonal available instance.
REGIONAL Regional (or Highly) available instance.

Node

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

JSON representation
{
  "zoneId": string,
  "id": string,
  "ip": string,
  "state": string
}
Fields
zoneId

string

The Compute Engine zone of the VM e.g. "us-central1-b".

id

string

The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".

ip

string

The private IP address of the VM e.g. "10.57.0.34".

state

string

Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.

ReadPoolConfig

Configuration for a read pool instance.

JSON representation
{
  "nodeCount": integer
}
Fields
nodeCount

integer

Read capacity, i.e. number of nodes in a read pool instance.

Methods

create

Creates a new Instance in a given project and location.

delete

Deletes a single Instance.

failover

Forces a Failover for a highly available instance.

get

Gets details of a single Instance.

getConnectionInfo

Get instance metadata used for a connection.

list

Lists Instances in a given project and location.

patch

Updates the parameters of a single Instance.

restart

Restart an Instance in a cluster.