rds.instances.rotate-storage-key

Replace the LUKS passphrase of every node’s data volume with a new key

POST /rds/api/instances/{id}/rotate-storage-keyIAM rds:RotateDBStorageKeyChanges state

Answers 202 with each volume’s key version. Each node adds the new key, removes the old one and reports within five minutes; nothing restarts. Nodes built before key rotation existed do not poll for it: replace them or restore into a new database. The dm-crypt volume key itself is not changed.

Request syntax

POST /rds/api/instances/{id}/rotate-storage-key

Path parameters

  • idRequired

    string

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

Response

202 with { volumes }: each data volume, its key version and whether its rotation is still pending.

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

Fields of data

  • volumesAlways

    array of object

    Every data volume of the database
  • volumes[].​providerVolumeIdAlways

    number, may be null

    The provider's id of the volume; null for a disk on the platform's own hosts
  • volumes[].​diskIdAlways

    string, may be null

    Id of a disk on the platform's own hosts; null otherwise
  • volumes[].​keyVersionAlways

    number

    Version of the volume key
  • volumes[].​rotationPendingAlways

    boolean

    The node has not finished the rotation yet
  • volumes[].​rotatedAtAlways

    string, may be null

    When the key was last rotated; null: never

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:RotateDBStorageKey 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 rotate-storage-key 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_rotate-storage-key.