rds.instances.clusterShow Patroni cluster membership and replication state
GET /rds/api/instances/{id}/clusterIAM rds:DescribeDBInstancesRead
Request syntax
GET /rds/api/instances/{id}/clusterPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with the members as the cluster reports them now: name, role, state, lagBytes, host, timeline, pendingRestart; null when no node answers.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
[].nameAlwaysstring
Member (node) name[].roleAlwaysstring
leader, sync_standby, replica, …; unknown when not reported[].stateAlwaysstring
running, streaming, stopped, …; unknown when not reported[].lagBytesAlwaysnumber, may be null
Replication lag behind the leader, bytes; null for the leader[].hostAlwaysstring
The member's address inside the cluster[].timelineAlwaysnumber, may be null
PostgreSQL timeline the member is on[].pendingRestartAlwaysboolean
A setting changed that takes effect at its next restart
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 cluster idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/cluster" \
-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_cluster.