rds.encryption.get

What is encrypted at rest, and this database’s encryption runs

GET /rds/api/instances/{id}/encryptionIAM rds:DescribeDBInstancesRead

Request syntax

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

Path parameters

  • idRequired

    string

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

Response

200 with storage (luks2 or none), backups (aes-256-cbc or none), holdDays, legacyBackups (the plaintext backups kept from before, or null) and runs (newest first).

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

Fields of data

  • storageAlways

    one of luks2, none

    Data volumes: LUKS2, or plain
  • backupsAlways

    one of aes-256-cbc, none

    Backup repository cipher
  • holdDaysAlways

    number

    How long the old disk is kept after a switchover: at least 7, never less than the backup retention
  • legacyBackupsAlways

    object, may be null

    Plaintext backups kept from before encryption; null when there are none
  • legacyBackups.​switchedAtAlways

    string

    When backups moved to the encrypted repository
  • legacyBackups.​deleteAfterAlways

    string, may be null

    When the plaintext backups are deleted; null: kept until someone decides
  • runsAlways

    array of object

    Encryption runs, newest first
  • runs[].​idAlways

    string

    Run id
  • runs[].​stateAlways

    one of queued, backups, standby, switching, holding, done, failed, cancelled

    queued, backups (moving to an encrypted repository), standby (encrypted copy streaming), switching, holding (encrypted; old disk kept), done, failed or cancelled
  • runs[].​scheduleAlways

    one of now, window

    When the switchover may happen
  • runs[].​requestedByAlways

    one of owner, operator

    Who asked
  • runs[].​deleteOldAfterHoldAlways

    boolean

    The old disk is deleted when the hold ends
  • runs[].​batchIdAlways

    string, may be null

    Shared by the runs of one encrypt-all; null otherwise
  • runs[].​stepAlways

    string, may be null

    What it is doing now
  • runs[].​errorAlways

    string, may be null

    Why it stopped; null otherwise
  • runs[].​switchStartedAtAlways

    string, may be null

    When writes paused
  • runs[].​switchFinishedAtAlways

    string, may be null

    When writes were accepted on the encrypted disk
  • runs[].​switchoverSecondsAlways

    number, may be null

    Writes paused for this long
  • runs[].​holdUntilAlways

    string, may be null

    When the old disk may be wiped
  • runs[].​oldVolumeWipedAtAlways

    string, may be null

    When the old disk was zero-filled and deleted
  • runs[].​createdAtAlways

    string

    When it was asked for
  • runs[].​finishedAtAlways

    string, may be null

    When it ended

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:DescribeDBInstances 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 encryption get id

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