rds.instances.modify-parameters

Set or reset PostgreSQL parameters; most apply at once, the answer lists those that wait for a restart

PATCH /rds/api/instances/{id}/parametersIAM rds:ModifyDBParametersChanges state

Request syntax

PATCH /rds/api/instances/{id}/parameters
{
  "parameters": "map of string"
}

Path parameters

  • idRequired

    string

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

Request body

  • parametersRequired

    map of string

    Parameter name → value ("32MB", "30s", "on"), or null to return it to its machine-sized default; parameters not named keep their value

    Constraints: key=value

Response

200 with { pendingRestart, notApplied }: the parameters that take effect at the next restart, and those not in effect because the machines set them locally.

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

Fields of data

  • pendingRestartAlways

    array of string

    Parameters that take effect at the next restart
  • notAppliedAlways

    array of string

    Parameters not in effect because the machines set them locally

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:ModifyDBParameters 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 instances modify-parameters id --parameters '{"key":"value"}'

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