ec2.instances.rename

Set or clear an instance display name

PUT /ec2/api/instances/{id}/nameIAM ec2:ModifyInstanceAttributeChanges stateDestructive

Request syntax

PUT /ec2/api/instances/{id}/name
{
  "name": "string"
}

Path parameters

  • idRequired

    string

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

Request body

  • nameRequired

    string

    The new display name; null clears it

    Constraints: max 64 chars

    May be null.

Response

200: `data` is `{ id, name }` with the new name (null when cleared).

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:ModifyInstanceAttribute 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 rename id --name example

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