rds.data.run-query

Run one read-only statement in a READ ONLY transaction with a statement timeout

POST /rds/api/instances/{id}/data/queryIAM rds:QueryDatabaseReadSensitive read, audited

Request syntax

POST /rds/api/instances/{id}/data/query
{
  "sql": "string",
  "limit": "number"
}

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Request body

  • sqlRequired

    string

    One read-only statement; it runs in a READ ONLY transaction with a 15 s timeout

    Constraints: 1-20000 chars

  • limitOptional

    number

    At most this many rows are returned; 200 when omitted

    Constraints: integer, 1-500

    Default: 200

Response

200 with columns (name, type), rows (every value as text or null), truncated (true when the row limit cut it), durationMs and limit.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • columnsAlways

    array of object

    Columns of the result
  • columns[].​nameAlways

    string

    Column name
  • columns[].​typeAlways

    string

    PostgreSQL type
  • rowsAlways

    array of array of string

    Rows, each value as text or null
  • truncatedAlways

    boolean

    The row limit cut the result
  • durationMsAlways

    number

    Time the statement took, ms
  • limitAlways

    number

    The row limit applied

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 run-query id --sql example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_data_run-query.