rds.instances.list-nodesList the machines backing a database instance
Request syntax
GET /rds/api/instances/{id}/nodesPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with the nodes in ordinal order: id, ordinal, name, role, status, availabilityZoneId, privateIpv4, publicIpv4, diskUsedPercent, engineVersion, lastSeenAt, … .
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
[].idAlwaysstring
Node id[].dbInstanceIdAlwaysstring
Database the node belongs to[].orgIdAlwaysstring
Organization that owns the database[].ordinalAlwaysnumber
1-based position; 1 to 3 are the core members, higher ones readers[].nameAlwaysstring
Machine name[].roleAlwaysone of primary, replica
Role as last observed: primary leads[].statusAlwaysone of provisioning, bootstrapping, running, stopped, failed, deleting
State of the machine[].hetznerServerIdAlwaysnumber, may be null
The provider's id of the machine; null before it is bought[].hetznerVolumeIdAlwaysnumber, may be null
The provider's id of the data volume; null before it is created[].availabilityZoneIdAlwaysstring, may be null
Zone of the machine and its volume; null: the region's default zone[].diskUsedPercentAlwaysnumber, may be null
Data volume usage as last reported, percent; null: not reported[].privateIpv4Alwaysstring, may be null
Address on the cluster's private network[].publicIpv4Alwaysstring, may be null
Public address of the machine[].vpcIpv4Alwaysstring, may be null
Address in the database's VPC; null: none[].lastSeenAtAlwaysstring, may be null
When the node last reported[].engineVersionAlwaysstring, may be null
PostgreSQL version the server reports, e.g. 17.11; null until it answers[].engineVersionReportedAtAlwaysstring, may be null
When engineVersion was read[].maintenanceAgentSeenAtAlwaysstring, may be null
When the node last asked for maintenance work; null: it cannot be upgraded in place[].installedPackageVersionAlwaysstring, may be null
PostgreSQL package installed on the node[].maintenanceOperationAlwaysunknown
The current or last in-place maintenance operation of the node; null: none[].poolerRebootSafeAtAlwaysstring, may be null
When the connection pooler was last confirmed to come back after a reboot[].createdAtAlwaysstring
When the node was created[].updatedAtAlwaysstring
When the node record last changed
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow rds:DescribeDBInstances on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud rds instances list-nodes idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/nodes" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_instances_list-nodes.