rds.query-insights.update-settings

Slow query log threshold, auto_explain, keeping values

PATCH /rds/api/instances/{id}/insights/settingsIAM rds:ModifyDBQueryInsightsChanges state

Request syntax

PATCH /rds/api/instances/{id}/insights/settings
{
  "slowLogMs": "number",
  "autoExplain": "boolean",
  "plansWithValues": "boolean"
}

Path parameters

  • idRequired

    string

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

Request body

  • slowLogMsOptional

    number

    Log statements slower than this many ms (log_min_duration_statement); -1 is off

    Constraints: integer, -1-3600000

  • autoExplainOptional

    boolean

    Also log the plan of slow statements (auto_explain, single-node databases)

  • plansWithValuesOptional

    boolean

    Show logged statements and plans with their literal values (off by default)

Response

200 with { changed }: one sentence per setting that was changed.

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

Fields of data

  • changedAlways

    array of string

    One sentence per setting that was changed

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:ModifyDBQueryInsights 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 update-settings id

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_update-settings.