ec2.instances.set-tags

Relabel an instance in one call: set some tags, remove others

PATCH /ec2/api/instances/{id}/tagsIAM tags:TagResourceChanges stateDestructive

Setting needs tags:TagResource and removing tags:UntagResource on the instance. Answers the tags it has afterwards. Find instances by tag with `dcloud ec2 instances list --tag key=value`.

Request syntax

PATCH /ec2/api/instances/{id}/tags
{
  "set": "map of string",
  "remove": "array of string"
}

Path parameters

  • idRequired

    string

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

Request body

  • setOptional

    map of string

    Tags to add or overwrite

    Constraints: key=value

  • removeOptional

    array of string

    Keys to remove

    Constraints: 1-128 chars

Response

200: `data` is `{ instanceId, tags }`: the tags the instance carries afterwards.

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 tags:TagResource 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 set-tags 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_set-tags.