ec2.instances.list

List instances

GET /ec2/api/instancesIAM ec2:DescribeInstancesRead

Request syntax

GET /ec2/api/instances

Query parameters

  • stateOptional

    enum

    Only instances in this state

    One of: pending, running, rebooting, stopping, stopped, shutting-down, terminated

  • limitOptional

    number

    At most this many, oldest first (default 100)

    Constraints: integer, 1-500

  • offsetOptional

    number

    Skip this many first: the next page is offset + limit (default 0)

    Constraints: integer, 0-1000000

  • tagOptional

    string

    Only instances carrying these tags: "env=preview,slot=3" (all must match; a bare key: present)

    Constraints: 1-512 chars

  • nameOptional

    string

    Only instances whose name or id contains this

    Constraints: 1-64 chars

Response

200: `data` is a list of instances (id, name, state, regionId, availabilityZoneId, vpcId, subnetId, publicIp, privateIp, instance type, timestamps), each with its `tags` map. Never the user data.

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:DescribeInstances 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 list

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