rds.instances.reboot

Reboot a database instance

PATCH /rds/api/instances/{id}IAM rds:RebootDBInstanceChanges stateDestructive

Request syntax

PATCH /rds/api/instances/{id}
{
  "action": "reboot"
}

Path parameters

  • idRequired

    string

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

Response

200 with { id, status }: "rebooting" for a single node, which is unavailable until it is back; a cluster reboots one machine at a time in the background and keeps its current status.

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

Fields of data

  • idAlways

    string

    Database id
  • statusAlways

    one of available, creating, modifying, backing-up, deleting, failed, stopped, starting, stopping, rebooting, maintenance, waiting-for-capacity, retained

    starting after start, stopping after stop; after reboot rebooting for a single node, its current status for a cluster

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:RebootDBInstance 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 reboot 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_reboot.