rds.backups.list

List backups and the recoverable window

GET /rds/api/instances/{id}/backupsIAM rds:ListBackupsRead

Request syntax

GET /rds/api/instances/{id}/backups

Path parameters

  • idRequired

    string

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

Response

200 with backups (id, type, status, label, startedAt, finishedAt, sizeBytes, keptUntilDeleted, …), recoveryWindow ({ earliest, latest } or null), backupsEnabled, retentionDays, backupWindow, lastBackupAt, agentSeenAt and keepsByHand.

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

Fields of data

  • backupsAlways

    array of object

    The newest backups, newest first
  • backups[].​idAlways

    string

    Backup id
  • backups[].​dbInstanceIdAlways

    string

    Database the backup is of
  • backups[].​orgIdAlways

    string

    Organization that owns the database
  • backups[].​typeAlways

    one of full, differential, incremental

    full copies every file; the others what changed since an earlier backup
  • backups[].​statusAlways

    one of running, completed, failed, expired

    expired: aged out of the retention window and no longer in the repository
  • backups[].​labelAlways

    string, may be null

    Name of the backup, e.g. 20260826-030000F; null until it has finished
  • backups[].​startedAtAlways

    string

    When the backup started (or was requested)
  • backups[].​finishedAtAlways

    string, may be null

    When it finished; null while running
  • backups[].​sizeBytesAlways

    number, may be null

    Size of the database as backed up, bytes
  • backups[].​repoSizeBytesAlways

    number, may be null

    Space it takes in the backup repository, bytes: what is billed
  • backups[].​walStartAlways

    string, may be null

    First WAL segment the backup needs
  • backups[].​walStopAlways

    string, may be null

    Last WAL segment the backup needs
  • backups[].​errorAlways

    string, may be null

    Why it failed; null otherwise
  • backups[].​keptUntilDeletedAlways

    boolean

    Taken by hand and kept until deleted, not expired with the retention window
  • backups[].​createdAtAlways

    string

    When the record was created
  • recoveryWindowAlways

    object, may be null

    The moments a point-in-time restore can name; null: none yet
  • recoveryWindow.​earliestAlways

    string

    Earliest moment a restore can name
  • recoveryWindow.​latestAlways

    string

    Latest moment a restore can name
  • backupsEnabledAlways

    boolean

    Whether scheduled backups are taken
  • agentSeenAtAlways

    string, may be null

    When the database's machines last asked for backup work; null: never
  • retentionDaysAlways

    number

    Days backups are kept
  • backupWindowAlways

    string, may be null

    When the daily backup runs, UTC HH:MM-HH:MM
  • lastBackupAtAlways

    string, may be null

    When the newest backup finished
  • keepsByHandAlways

    boolean

    A backup taken by hand is kept until it is deleted (at most 20)

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:ListBackups 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 backups list id

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