REST Resource: projects.locations.clusters.instances

{
  "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)
    }
  ],
  "queryInsightsConfig": {
    object (QueryInsightsInstanceConfig)
  },
  "observabilityConfig": {
    object (ObservabilityInstanceConfig)
  },
  "readPoolConfig": {
    object (ReadPoolConfig)
  },
  "ipAddress": string,
  "publicIpAddress": string,
  "reconciling": boolean,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "updatePolicy": {
    object (UpdatePolicy)
  },
  "clientConnectionConfig": {
    object (ClientConnectionConfig)
  },
  "satisfiesPzs": boolean,
  "pscInstanceConfig": {
    object (PscInstanceConfig)
  },
  "networkConfig": {
    object (InstanceNetworkConfig)
  },
  "geminiConfig": {
    object (GeminiInstanceConfig)
  },
  "outboundPublicIpAddresses": [
    string
  ]
}

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]([a-z0-9-]{0,61}[a-z0-9])?, 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}

string

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

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.

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

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

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

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

enum (State)

Output only. The current serving state of the instance.

enum (InstanceType)

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

object (MachineConfig)

Configurations for the machines that host the underlying database engine.

enum (AvailabilityType)

Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availabilityType is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

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.

map (key: string, value: string)

Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance.

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

object (Node)

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

object (Node)

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

object (QueryInsightsInstanceConfig)

Configuration for query insights.

object (ObservabilityInstanceConfig)

Configuration for observability.

object (ReadPoolConfig)

Read pool instance configuration. This is required if the value of instanceType is READ_POOL.

string

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

string

Output only. The public IP addresses for the Instance. This is available ONLY when enablePublicIp is set. This is the connection endpoint for an end-user application.

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.

string

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

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

object (UpdatePolicy)

Update policy that will be applied during instance update. This field is not persisted when you update the instance. To use a non-default update policy, you must specify explicitly specify the value in each update request.

object (ClientConnectionConfig)

Optional. Client connection specific configurations

boolean

Output only. Reserved for future use.

object (PscInstanceConfig)

Optional. The configuration for Private Service Connect (PSC) for the instance.

object (InstanceNetworkConfig)

Optional. Instance-level network configuration.

object (GeminiInstanceConfig)

Optional. Configuration parameters related to the Gemini in Databases add-on.

string

Output only. All outbound public IP addresses configured for the instance.

{
  "cpuCount": integer
}

integer

The number of CPU's in the VM instance.

{
  "zoneId": string,
  "id": string,
  "ip": string,
  "state": string
}

string

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

string

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

string

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

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.

{
  "queryStringLength": integer,
  "recordApplicationTags": boolean,
  "recordClientAddress": boolean,
  "queryPlansPerMinute": integer
}

integer (uint32 format)

Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.

boolean

Record application tags for an instance. This flag is turned "on" by default.

boolean

Record client address for an instance. Client address is PII information. This flag is turned "on" by default.

integer (uint32 format)

Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.

{
  "enabled": boolean,
  "preserveComments": boolean,
  "trackWaitEvents": boolean,
  "trackWaitEventTypes": boolean,
  "maxQueryStringLength": integer,
  "recordApplicationTags": boolean,
  "queryPlansPerMinute": integer,
  "trackActiveQueries": boolean,
  "trackClientAddress": boolean
}

boolean

Observability feature status for an instance. This flag is turned "off" by default.

boolean

Preserve comments in query string for an instance. This flag is turned "off" by default.

boolean

Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.

boolean

Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.

integer

Query string length. The default value is 10k.

boolean

Record application tags for an instance. This flag is turned "off" by default.

integer

Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.

boolean

Track actively running queries on the instance. If not set, this flag is "off" by default.

boolean

Track client address for an instance. If not set, default value is "off".

{
  "nodeCount": integer
}

integer

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

{
  "mode": enum (Mode)
}

enum (Mode)

Mode for updating the instance.

{
  "requireConnectors": boolean,
  "sslConfig": {
    object (SslConfig)
  }
}

boolean

Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.

object (SslConfig)

Optional. SSL configuration option for this instance.

{
  "serviceAttachmentLink": string,
  "allowedConsumerProjects": [
    string
  ],
  "pscDnsName": string
}

string

Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects/<alloydb-tenant-project-number>/regions/<region-name>/serviceAttachments/<service-attachment-name>

string

Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.

string

Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog

{
  "authorizedExternalNetworks": [
    {
      object (AuthorizedNetwork)
    }
  ],
  "enablePublicIp": boolean,
  "enableOutboundPublicIp": boolean
}

object (AuthorizedNetwork)

Optional. A list of external network authorized to access this instance.

boolean

Optional. Enabling public ip for the instance.

boolean

Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.

{
  "cidrRange": string
}

string

CIDR range for one authorzied network of the instance.

{
  "entitled": boolean
}

boolean

Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.