rds.instances.modify-instance-class

Change the machine type; a cluster is resized node by node and stays available

PATCH /rds/api/instances/{id}/instance-classIAM rds:ModifyDBInstanceChanges stateDestructive

Request syntax

PATCH /rds/api/instances/{id}/instance-class
{
  "instanceClass": "string"
}

Path parameters

  • idRequired

    string

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

Request body

  • instanceClassRequired

    string

    The new instance type, e.g. performance-8. The provider’s own type names are still accepted, deprecated.

    Constraints: 1-32 chars

Response

202 with { id, instanceClass }; the resize runs in the background and 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
  • instanceClassAlways

    string

    The instance type it is being resized to

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 modify-instance-class id --instance-class example

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-instance-class.