rds.data.list-relations

List 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/relations

Path parameters

  • idRequired

    string

    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

  • relationsAlways

    array of object

    Every table and view outside the system schemas
  • relations[].​schemaAlways

    string

    Schema
  • relations[].​nameAlways

    string

    Table or view name
  • relations[].​kindAlways

    string

    table, partitioned table, view or materialized view
  • relations[].​estimatedRowsAlways

    number, may be null

    Estimated rows; null: never analysed
  • relations[].​totalBytesAlways

    number

    Size with indexes and TOAST, bytes
  • relations[].​commentAlways

    string, 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 id

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.