List Instances
vertex_notebooks.list_instances
ActionGoogle Cloudconnection required
Calls Notebooks GET /v2/projects/{projectsId}/locations/{locationsId}/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 Notebooks
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- location, project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, none 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 | — | — | — |
filter Optional. List filter. | string | No | — | — | — |
order_by Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted). | string | No | — | — | — |
page_size Optional. Maximum return size of the list call. | number | No | 50 | ≥ 1 | — |
page_token Optional. A previous returned page token that can be used to continue listing from the last result. | 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 | — |
nextPageToken | string | — |
instances | array | — |
unreachable | array | — |
{
"instances": [],
"nextPageToken": "",
"ok": false,
"unreachable": []
}Related Google Notebooks nodes
See List Instances run in a workflow.
In a technical demo we add the Google Notebooks connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.