rds.instances.modify-maintenance

Set the maintenance window (UTC) and automatic minor upgrades

PATCH /rds/api/instances/{id}/maintenanceIAM rds:ModifyDBInstanceChanges stateDestructive

Request syntax

PATCH /rds/api/instances/{id}/maintenance
{
  "maintenanceWindow": "string",
  "autoMinorVersionUpgrade": "boolean"
}

Path parameters

  • idRequired

    string

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

Request body

  • maintenanceWindowOptional

    string

    UTC, ddd:hh24:mi-ddd:hh24:mi, one hour to one day, e.g. sun:05:00-sun:06:00 (the default); omitted: unchanged

    Constraints: max 32 chars, /^(sun|mon|tue|wed|thu|fri|sat):([01]\d|2[0-3]):[0-5]\d-(sun|mon|tue|wed|thu|fri|sat):([01]\d|2[0-3]):[0-5]\d$/i

  • autoMinorVersionUpgradeOptional

    boolean

    Apply new minor versions in the window automatically (on by default); omitted: unchanged

Response

200 with the settings now in force: { maintenanceWindow, autoMinorVersionUpgrade }.

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

Fields of data

  • maintenanceWindowAlways

    string, may be null

    Maintenance window, UTC ddd:hh24:mi-ddd:hh24:mi
  • autoMinorVersionUpgradeAlways

    boolean

    Whether new minors are applied in the window

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-maintenance 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_modify-maintenance.