rds.instances.upgrade

Upgrade to a newer minor now: a cluster rolls node by node with one switchover, a single node restarts once

POST /rds/api/instances/{id}/upgradeIAM rds:ModifyDBInstanceChanges stateDestructive

Request syntax

POST /rds/api/instances/{id}/upgrade
{
  "engineVersion": "string"
}

Path parameters

  • idRequired

    string

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

Request body

  • engineVersionOptional

    string

    A pinned minor (e.g. 17.11) or a major (e.g. 18, meaning its pinned minor): the database's own major, or a newer one for a major upgrade; omitted: the newest pinned minor of its major

    Constraints: 1-16 chars

Response

202 with { id, engineVersion }: the version being installed; progress shows in `events`.

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

Fields of data

  • idAlways

    string

    Database id
  • engineVersionAlways

    string

    The version being installed, e.g. 17.11

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:ModifyDBInstance 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 upgrade id

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