View instance details

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

This page describes how to view detailed information about an instance in an AlloyDB cluster.

Prerequisites

  • The Cloud project you are using must have been enabled to access AlloyDB.
  • You must have one of these IAM roles in the Cloud project you are using:
    • roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
    • roles/owner (the Owner basic IAM role)
    • roles/editor (the Editor basic IAM role)

    If you don't have any of these roles, contact your Organization Administrator to request access.

Procedure

Console

  1. In the Google Cloud console, go to the Clusters page.

    Go to Clusters

  2. Click a cluster in the Resource Name column.

  3. In the Overview page that opens, go to the Instances in your cluster section and view the details about your instance.

gcloud

To use the gcloud CLI, you can install and initialize the Google Cloud CLI, or you can use Cloud Shell.

Use the gcloud beta alloydb instances describe command to view details about an instance.

gcloud beta alloydb instances describe INSTANCE_ID \
 --region=REGION_ID \
 --cluster=CLUSTER_ID \
 --project=PROJECT_ID

Replace the following:

  • INSTANCE_ID: The ID of the instance.
  • REGION_ID: The instance's region ID.
  • CLUSTER_ID: The ID of the instance's cluster.
  • PROJECT_ID: The ID of the instance's project.

Determine a primary instance's zones

For the sake of high availability, an AlloyDB primary instance comprises two virtual machine (VM) instances: an active VM which responds to requests, and a standby VM. These VMs run within two different zones of the instance's region.

You can determine which zones your primary instance's VMs run in by following the steps in the previous section, and then examining a particular part of the command output or Google Cloud console display:

Console

In the Google Cloud console, go to the Clusters page:

Go to Clusters

The Location column displays the zone of each primary instance's active VM.

Note that the same column displays only the region ID for clusters and read-pool instances. For example, a cluster with a Location of us-central1 might have a primary instance displaying its active VM's full zone ID of us-central1-f.

The Instances in your cluster section of a cluster's detail page displays this same information, in the primary instance's Location field. This field also lists the standby VM's location, labeled as "secondary zone".

gcloud

After running the command described in the previous section, locate the following fields in the command's output:

  • writeableNode: The active VM's zone ID

  • nodes: The standby VM's zone ID

For example, the following partial output indicates that the primary instance's active VM runs in zone us-central1-f, while its standby is in us-central1-c:

nodes:
- zoneId: us-central1-c
reconciling: false
state: READY
uid: 3477b790-21bc-4338-a09e-339912e3b28e
updateTime: '2022-08-09T21:22:16.671268941Z'
writableNode:
  zoneId: us-central1-f