List Instances
alloydb.list_instances
ActionGoogle Cloudconnection required
Calls AlloyDB GET /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances.
Lists Instances in a given project and location.
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
7 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 | — | — | — |
filter Optional. Filtering results | string | No | — | — | — |
order_by Optional. Hint for how to order the results | string | No | — | — | — |
page_size Optional. Requested page size. Server may return fewer items than requested. | number | No | 50 | ≥ 1 | — |
page_token A token identifying a page of results the server should return. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"page_size": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
unreachable | array | — |
instances | array | — |
nextPageToken | string | — |
{
"instances": [],
"nextPageToken": "",
"ok": false,
"unreachable": []
}See List Instances 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.