Get Instance
alloydb.get_instance
ActionGoogle Cloudconnection required
Calls alloydb v1 GET /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}.
Gets details of a single Instance.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google AlloyDB
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id, location
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
location Location or region; taken from the connection when unset. | string | No | — | — | — |
cluster Cluster name or id. | string | Yes | — | — | — |
instance Instance name or id. | string | Yes | — | — | — |
Output
One shape.
result
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
activationPolicy | string | — |
annotations | object | — |
availabilityType | string | — |
clientConnectionConfig | object | — |
connectionPoolConfig | object | — |
createTime | string | — |
dataApiAccess | string | — |
databaseFlags | object | — |
deleteTime | string | — |
displayName | string | — |
etag | string | — |
gceZone | string | — |
instanceType | string | — |
ipAddress | string | — |
labels | object | — |
machineConfig | object | — |
maintenanceVersionName | string | — |
name | string | — |
networkConfig | object | — |
nodes | array | — |
observabilityConfig | object | — |
outboundPublicIpAddresses | array | — |
pscInstanceConfig | object | — |
pscInstanceInfo | object | — |
publicIpAddress | string | — |
queryInsightsConfig | object | — |
readPoolConfig | object | — |
reconciling | boolean | — |
satisfiesPzs | boolean | — |
state | string | — |
uid | string | — |
updateTime | string | — |
writableNode | object | — |
{
"activationPolicy": "",
"annotations": {},
"availabilityType": "",
"clientConnectionConfig": {},
"connectionPoolConfig": {},
"createTime": "",
"dataApiAccess": "",
"databaseFlags": {},
"deleteTime": "",
"displayName": "",
"etag": "",
"gceZone": "",
"instanceType": "",
"ipAddress": "",
"labels": {},
"machineConfig": {},
"maintenanceVersionName": "",
"name": "",
"networkConfig": {},
"nodes": [],
"observabilityConfig": {},
"outboundPublicIpAddresses": [],
"pscInstanceConfig": {},
"pscInstanceInfo": {},
"publicIpAddress": "",
"queryInsightsConfig": {},
"readPoolConfig": {},
"reconciling": false,
"satisfiesPzs": false,
"state": "",
"uid": "",
"updateTime": "",
"writableNode": {}
}See Get Instance run in a workflow.
In a technical demo we add the Google AlloyDB connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.