rds.backups.create

Take a backup now

POST /rds/api/instances/{id}/backupsIAM rds:CreateBackupChanges state

On a database whose nodes run backup poller 3 (`keepsByHand` in the list), the backup is kept until you delete it, at most 20 per database; otherwise it follows the retention window.

Request syntax

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

Path parameters

  • idRequired

    string

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

Response

202 with { backup, state: "requested" }: the backup (a full backup, status running, as `list` shows it) that the database node fills in when it reports.

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

Fields of data

  • backupAlways

    object

    The backup requested
  • backup.​idAlways

    string

    Backup id
  • backup.​dbInstanceIdAlways

    string

    Database the backup is of
  • backup.​orgIdAlways

    string

    Organization that owns the database
  • backup.​typeAlways

    one of full, differential, incremental

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

    one of running, completed, failed, expired

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

    string, may be null

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

    string

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

    string, may be null

    When it finished; null while running
  • backup.​sizeBytesAlways

    number, may be null

    Size of the database as backed up, bytes
  • backup.​repoSizeBytesAlways

    number, may be null

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

    string, may be null

    First WAL segment the backup needs
  • backup.​walStopAlways

    string, may be null

    Last WAL segment the backup needs
  • backup.​errorAlways

    string, may be null

    Why it failed; null otherwise
  • backup.​keptUntilDeletedAlways

    boolean

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

    string

    When the record was created
  • stateAlways

    "requested"

    Recorded; a database node picks the request up and reports back

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:CreateBackup 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 create 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_create.