rds.replication-slots.listEvery logical slot on the leader (declared or made in SQL): active, lag, WAL retained, whether it survives a failover
Request syntax
GET /rds/api/instances/{id}/replication-slotsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with logicalReplication, slots (name, database, plugin, managed, active, activePid, temporary, walStatus, confirmedFlushLsn, restartLsn, retainedBytes, survivesFailover), pending (declared slots not created yet) and error.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
logicalReplicationAlwaysboolean
Whether wal_level is logicalslotsAlwaysarray of object
Every logical slot on the leaderslots[].nameAlwaysstring
Slot nameslots[].databaseAlwaysstring, may be null
Database the slot decodesslots[].pluginAlwaysstring, may be null
Output plugin, e.g. pgoutputslots[].managedAlwaysboolean
Declared through the API (kept on every member), or made in SQLslots[].activeAlwaysboolean
A consumer is reading it nowslots[].activePidAlwaysnumber, may be null
Server process of that consumerslots[].temporaryAlwaysboolean
Dropped when its session endsslots[].walStatusAlwaysstring, may be null
reserved, extended, unreserved or lost (the WAL it needs is gone)slots[].confirmedFlushLsnAlwaysstring, may be null
Position the consumer has confirmedslots[].restartLsnAlwaysstring, may be null
Oldest WAL position the slot still needsslots[].retainedBytesAlwaysnumber, may be null
WAL the slot holds on the leader, bytesslots[].survivesFailoverAlwaysboolean, may be null
Whether it is kept when another member takes over; null on a single nodependingAlwaysarray of string
Declared slots the leader has not created yeterrorAlwaysstring, may be null
Why the slots could not be read; null when they were
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 replication-slots list idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/replication-slots" \
-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_replication-slots_list.