rds.query-insights.get-statement

One statement with its generic plan and the index it suggests

GET /rds/api/instances/{id}/insights/statements/{statementId}IAM rds:DescribeDBQueryInsightsRead

EXPLAIN (GENERIC_PLAN) of the normalised text, never ANALYZE; a suggested index is a CREATE INDEX CONCURRENTLY to run yourself.

Request syntax

GET /rds/api/instances/{id}/insights/statements/{statementId}

Path parameters

  • idRequired

    string

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

  • statementIdRequired

    string

Response

200 with the statement: id, fingerprint, query, database, role, plan and findings, including any suggested index.

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

Fields of data

  • idAlways

    string

    Statement id
  • fingerprintAlways

    string

    sqlfp1 fingerprint
  • queryAlways

    string

    Normalised statement text
  • databaseAlways

    string

    Database it ran in
  • roleAlways

    string

    Role it ran as
  • planAlways

    unknown

    Generic plan as EXPLAIN (FORMAT JSON) gives it; null when the statement cannot be planned
  • findingsAlways

    array of object

    Findings with suggested actions
  • findings[].​kindAlways

    one of slow-average, slow-sometimes, missing-index, spills-to-disk, n-plus-one, seq-scan-large-table, unused-index, duplicate-index, vacuum-overdue, long-running, idle-in-transaction, lock-wait

    What was found
  • findings[].​severityAlways

    one of high, medium, info

    How much it matters
  • findings[].​titleAlways

    string

    One line: what was seen
  • findings[].​evidenceAlways

    string

    The numbers behind it
  • findings[].​actionAlways

    string

    What to do about it
  • findings[].​sqlWhen present

    string

    A statement to copy and run yourself (CREATE INDEX CONCURRENTLY, …); absent when none

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:DescribeDBQueryInsights 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 query-insights get-statement id statementId

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