rds.encryption.start-all

Queue encryption for every database of the organization whose disks are plain; they run one at a time

POST /rds/api/encrypt-allIAM rds:EncryptDBInstanceChanges stateDestructive

Request syntax

POST /rds/api/encrypt-all
{
  "schedule": "enum",
  "deleteOldAfterHold": "boolean"
}

Request body

  • scheduleOptional

    enum

    window: switch over in the maintenance window; now: as soon as the copy is ready

    One of: now, window

    Default: "window"

  • deleteOldAfterHoldOptional

    boolean

    Zero-fill and delete the old disk (and plaintext backups) when the hold ends; false keeps them until deleted by hand

    Default: true

Response

202 with batchId, queued ({ id, identifier, runId }) and skipped ({ id, identifier, reason }).

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

Fields of data

  • batchIdAlways

    string

    Shared by the runs of this request
  • queuedAlways

    array of object

    Databases queued
  • queued[].​idAlways

    string

    Database id
  • queued[].​identifierAlways

    string

    Database name
  • queued[].​runIdAlways

    string

    Its encryption run
  • skippedAlways

    array of object

    Databases with plain disks that could not be queued
  • skipped[].​idAlways

    string

    Database id
  • skipped[].​identifierAlways

    string

    Database name
  • skipped[].​reasonAlways

    string

    Why it was not queued

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:EncryptDBInstance 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 start-all

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