rds.instances.modify-backup-settings

Change backup retention or the daily backup window

PATCH /rds/api/instances/{id}/backup-settingsIAM rds:ModifyDBInstanceChanges stateDestructive

Request syntax

PATCH /rds/api/instances/{id}/backup-settings
{
  "backupRetentionDays": "number",
  "backupWindow": "string"
}

Path parameters

  • idRequired

    string

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

Request body

  • backupRetentionDaysOptional

    number

    Days backups are kept; 0 turns scheduled backups off; omitted: unchanged

    Constraints: integer, 0-35

  • backupWindowOptional

    string

    When the daily backup runs, HH:MM-HH:MM (only the start is used; 03:00-04:00 by default); omitted: unchanged

    Constraints: /^([01]\d|2[0-3]):[0-5]\d-([01]\d|2[0-3]):[0-5]\d$/

Response

200 with the settings now in force: { backupRetentionDays, backupWindow }.

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

Fields of data

  • backupRetentionDaysAlways

    number

    Days backups are kept; 0: scheduled backups are off
  • backupWindowAlways

    string, may be null

    When the daily backup runs, UTC HH:MM-HH:MM; null: the default 03:00-04:00

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-backup-settings 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-backup-settings.