rds.data.list-relationsList schemas and tables with size and an estimated row count
GET /rds/api/instances/{id}/data/relationsIAM rds:QueryDatabaseReadSensitive read, audited
Request syntax
GET /rds/api/instances/{id}/data/relationsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with { relations }: schema, name, kind (table, partitioned table, view, materialized view), estimatedRows (null if never analysed), totalBytes and comment.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
relationsAlwaysarray of object
Every table and view outside the system schemasrelations[].schemaAlwaysstring
Schemarelations[].nameAlwaysstring
Table or view namerelations[].kindAlwaysstring
table, partitioned table, view or materialized viewrelations[].estimatedRowsAlwaysnumber, may be null
Estimated rows; null: never analysedrelations[].totalBytesAlwaysnumber
Size with indexes and TOAST, bytesrelations[].commentAlwaysstring, may be null
Its comment, cut at 1,000 characters
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:QueryDatabase 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 data list-relations idcurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/data/relations" \
-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_data_list-relations.