| Euca2ools Guide / EC2-Compatible Commands | |
Shows information about instances.
euca-describe-instances instance_id [[--filter "name=value"] ...]
| Option | Description | Required |
|---|---|---|
| instance_id | Instance ID to describe | No |
| -F, --filter name=value | Filter for limiting the results. See the table in the Available Filters section for a list of filters. Use quotation marks if the value has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value ("name=value"). | No |
You can add filters to your request so that the response includes information for only certain instances. For example, you can use a filter to specify that you want to find instances launched with a specific keypair. Some tips for using filters with this command:
The following are the available filters for euca-describe-instances:
| Filter | Description |
|---|---|
| architecture | Instance architecture. Valid values: i386 | x86_64 |
| association.allocation-id | (VPC only) Allocation ID bound to a network interface's elastic IP address. |
| association.ip-owner-id | (VPC only) ID of the owner of the elastic IP address associated with a network interface. |
| association.public-ip | (VPC only) Address of the elastic IP address bound to a network interface. |
| availability-zone | The instance's availability zone. |
| block-device-mapping.attach-time | Attach time for an EBS volume mapped to the instance. |
| block-device-mapping.delete-on-termination | Whether the EBS volume is deleted on instance termination. |
| block-device-mapping.device-name | Device name (for example, /dev/sdh) for an EBS volume mapped to the image |
| block-device-mapping.status | Status of an EBS volume mapped to the instance. Valid values: attaching | attached | detaching | detached |
| block-device-mapping.volume-id | ID of an EBS volume mapped to the instance. |
| dns-name | Public DNS name of the instance. |
| group-id | The security group the instance is in. |
| hypervisor | Hypervisor type of the instance. Valid values are ovm | xen |
| image-id | ID of the image used to launch the instance. |
| instance-id | ID of the instance. |
| instance-lifecycle | Whether this is a spot instance. Valid values: true | false |
| instance-state-code | Code identifying the state of the instance. Valid values: Valid values: 0 (pending) | 16 (running) | 32 (shutting-down) | 48 (terminated) | 64 (stopping) | 80 (stopped) |
| instance-state-name | State of the instance. Valid Values: pending | running | shutting-down | terminated | stopping | stopped |
| instance-type | Type of the instance (for example, m1.small) |
| ip-address | Public IP address of the instance. |
| kernel-id | Kernel ID. |
| key-name | Name of the key pair used when the instance was launched. |
| launch-index | When launching multiple instances at once, this is the index for the instance in the launch group . |
| launch-time | Time the instance was launched. |
| monitoring-state | Whether monitoring is enabled for the instance . |
| network-interface.addresses.association.ip-owner-id | (VPC only) ID of the owner of the private IP address associated with a network interface. |
| network-interface.addresses.association.public-ip | (VPC only) ID of the association of an elastic IP address with a network interface. |
| network-interface.addresses.primary | (VPC only) Indicates whether the IP address of the VPC network interface is the primary private IP address. |
| network-interface.addresses.private-ip-address | (VPC only) Network interface's private IP address. |
| network-interface.attachment.device-index | (VPC only) Device index to which a network interface is attached. |
| network-interface.attachment.attach-time | (VPC only) Time a network interface was attached to an instance. |
| network-interface.attachment.attachment-id | (VPC only) ID of a network interface's attachment. |
| network-interface.attachment.delete-on-termination | (VPC only) Indicates whether a network interface attachment is deleted when an instance is terminated. |
| network-interface.attachment.instance-owner-id | (VPC only) ID of the instance to which a network interface is attached. |
| network-interface.attachment.status | (VPC only) Network interface's attachment status. |
| network-interface.availability-zone | (VPC only) Network interface's availability zone. |
| network-interface.description | (VPC only) Description of a network interface. |
| network-interface.group-id | (VPC only) Network interface's security group ID. |
| network-interface.group-name | (VPC only) Network interface's security group name. |
| network-interface.mac-address | (VPC only) Network interface's hardware address. |
| network-interface.network-interface.id | (VPC only) ID of a network interface. |
| network-interface.owner-id | (VPC only) ID of a network interface's owner. |
| network-interface.private-dns-name | (VPC only) Network interface's private DNS name. |
| network-interface.requester-id | (VPC only) Network interface's requester ID. |
| network-interface.requester-managed | (VPC only) Indicates whether the network interface is managed by the service. |
| network-interface.source-destination-check | (VPC only) Indicates whether source/destination checking is enabled for a network interface. |
| network-interface.status | (VPC only) Network interface's status. |
| network-interface.subnet-id | (VPC only) ID of a network interface's subnet. |
| network-interface.vpc-id | (VPC only) ID of a network interface's VPC. |
| owner-id | Account ID of the image owner. |
| placement-group-name | Name of the placement group that contains the instance. |
| platform | Use windows if you have Windows based AMIs, otherwise leave blank. |
| private-dns-name | Private DNS name of the instance. |
| private-ip-address | Private IP address of the instance. |
| ramdisk-id | The ramdisk ID. |
| reason | Reason for the instance's current state. |
| reservation-id | ID of the instance's reservation. |
| root-device-name | Root device name of the EMI (for example, /dev/sda1). |
| root-device-type | Root device type the EMI uses. Valid Values: ebs | instance-store |
| spot-instance-request-id | ID of the spot instance request. |
| state-reason-code | Reason code for the state change. |
| state-reason-message | Message for the state change. |
| subnet-id | ID of the subnet the instance is in (VPC). |
| tag-key | Key of a tag assigned to the resource you want to filter. This filter is independent of the tag-value filter and returns all resources assigned the tag key you use, regardless of the value. To filter on a specific key and value set, use the tag:key filter. |
| tag-value | Value of a tag assigned to the resource. This filter is independent of the tag-key filter and returns all resources assigned the tag value you use, regardless of the key. To filter on a specific key and value set, use the tag:key filter. |
| tag:key | Filters the results based on a specific tag/value combination |
| virtualization-type | Virtualization type of the instance. Valid values: paravirtual | hvm |
| vpc-id | (VPC only) ID of the VPC containing the instance. |
| Option | Description |
|---|---|
| --show-empty-fields | Show empty fields as "(nil)". |
| --region user@region | Region and/or user name to search when looking up config file data. Only valid for EC2 endpoints. |
| -U,--url url | URL of the cloud service to connect to. For administrative commands, this should be <ip_address>:8773/services/Empyrean. |
| -I,--access-key-id key_id | User's access key ID. |
| -S,--secret-key secret_key | User's secret key. |
| --security-token token | User's security token. |
| --debug | Prints what the command sends to the server and what it receives from the server. Use when you're trying to debug Euca2ools. |
| --debugger | Enable interactive debugger on error. |
| -h,--help | Display the manual page for the command. |
| --version | Display the version of this tool. |
The following example shows the request and output for a simple command.
euca-describe-instances RESERVATION r-1AE63E97 133764149866 admingroup INSTANCE i-1BD543F0 emi-EBD5387D 192.168.10.187 10.1.0.107 running adminkey 0 m1.small 2012-02-15T17:24:52Z PARTI00 eki-6DF93987 eri-4CEF36C4