Get Cluster
alloydb.get_cluster
ActionGoogle Cloudconnection required
Calls AlloyDB GET /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}.
Gets details of a single Cluster.
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
- location, project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 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 |
|---|---|---|---|---|---|
project_id GCP project id (overrides connection). | string | No | — | — | — |
location Location / region (overrides connection). | string | No | — | — | — |
cluster Id of the cluster to act on, from alloydb.list_clusters — not its name. | string | Yes | — | — | — |
view Optional. The view of the cluster to return. Returns all default fields if not set. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
secondaryConfig | object | — |
networkConfig | object | — |
annotations | object | — |
databaseVersion | string | — |
updateTime | string | — |
dataplexConfig | object | — |
{
"annotations": {},
"databaseVersion": "",
"dataplexConfig": {},
"networkConfig": {},
"ok": false,
"secondaryConfig": {},
"updateTime": ""
}See Get Cluster 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.