ec2.instances.install-volume-helper

Get the script that lets an older instance open encrypted volumes

POST /ec2/api/instances/{id}/volume-helperIAM ec2:InstallVolumeHelperChanges state

For an instance launched before the volume helper existed. Run `data.script` as root on the instance; it installs the helper with a fresh credential for this instance and reports in, after which encrypted volumes can be attached. Idempotent. `data.installed` says whether it already reported.

Request syntax

POST /ec2/api/instances/{id}/volume-helper

Path parameters

  • idRequired

    string

    Constraints: /^i-[0-9a-f]{6,32}$/

Response

200: `data` is `{ instanceId, installed, script }`: the shell script to run as root, and whether the helper already reported in.

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

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 ec2:InstallVolumeHelper 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 ec2 instances install-volume-helper id

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