rds.data.read-rowsOne page of a table's rows, plus its column types
Request syntax
GET /rds/api/instances/{id}/data/rowsPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Query parameters
schemaRequiredstring
Schema of the table, e.g. public
Constraints: 1-63 chars
tableRequiredstring
Name of the table
Constraints: 1-63 chars
limitOptionalnumber
Rows per page; 50 when omitted
Constraints: integer, 1-200
Default:
50offsetOptionalnumber
Rows to skip, in primary-key order; 0 when omitted
Constraints: integer, 0-1000000
Default:
0
Response
200 with columns (name, type, notNull, defaultExpr, isPrimaryKey), rows (every value as text or null), rowColumns, offset, hasMore, estimatedRows and orderedBy.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
columnsAlwaysarray of object
Columns of the tablecolumns[].nameAlwaysstring
Column namecolumns[].typeAlwaysstring
PostgreSQL typecolumns[].notNullAlwaysboolean
NOT NULLcolumns[].defaultExprAlwaysstring, may be null
Default expression; null: nonecolumns[].isPrimaryKeyAlwaysboolean
Part of the primary keyrowsAlwaysarray of array of string
Rows, each value as text or nullrowColumnsAlwaysarray of object
Columns in the order the rows use themrowColumns[].nameAlwaysstring
Column namerowColumns[].typeAlwaysstring
PostgreSQL typeoffsetAlwaysnumber
Rows skippedhasMoreAlwaysboolean
Another page followsestimatedRowsAlwaysnumber, may be null
Estimated rows; null: never analysedorderedByAlwaysarray of string, may be null
Columns the rows are ordered by; null: the table has no primary key
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 read-rows id --schema example --table examplecurl -X GET "https://console.platform-development.deutschecloud.app/rds/api/instances/id/data/rows" \
-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_read-rows.