rds.query-insights.cancel-session

Cancel a session’s running statement, or end the session

POST /rds/api/instances/{id}/insights/sessions/{pid}IAM rds:CancelDBSessionChanges stateDestructive

Request syntax

POST /rds/api/instances/{id}/insights/sessions/{pid}
{
  "how": "enum"
}

Path parameters

  • idRequired

    string

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

  • pidRequired

    number

    Constraints: integer, min 1

Request body

  • howRequired

    enum

    cancel: the running statement; terminate: the session

    One of: cancel, terminate

Response

200 with { pid, how } once Postgres has done it.

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

Fields of data

  • pidAlways

    number

    The session
  • howAlways

    one of cancel, terminate

    cancel: its statement was cancelled; terminate: the session was ended

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:CancelDBSession 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 cancel-session id pid --how cancel

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_cancel-session.