Queries the details of one or more Elastic Compute Service (ECS) instances.

Description

  • You can specify multiple request parameters to be queried. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions. However, if InstanceIds is set to an empty JSON array, it is regarded as a valid filter condition and an empty result is returned.
  • If you are using a Resource Access Management (RAM) user or RAM role that does not have the permissions to call this operation, an empty list is returned. You can include the DryRun parameter in your request to check whether the empty list is caused by lack of permissions.
  • When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see Parameter format overview.
  • You can use one of the following methods to check the responses:
    • Method 1: During a paged query, when you call the DescribeInstances operation to retrieve the first page of results, set MaxResults to specify the maximum number of entries to return in the call. The return value of NextToken is a pagination token, which can be used in the next call to retrieve a new page of results. When you call the DescribeInstances operation to retrieve a new page of results, set NextToken to the NextToken value returned in the previous call and set MaxResults to specify the maximum number of entries to return in this call.
    • Method 2: Use PageSize to specify the number of entries to return on each page and then use PageNumber to specify the number of the page to return.

      You can use only one of the preceding methods. If a large number of entries are to be returned, we recommend that you use method 1. When MaxResults or NextToken is specified, the PageSize and PageNumber request parameters do not take effect and the TotalCount response parameter is invalid.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstances

The operation that you want to perform. Set the value to DescribeInstances.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

VpcId String No v-bp67acfmxazb4p****

The ID of the virtual private cloud (VPC) to which the instance belongs.

VSwitchId String No vsw-bp67acfmxazb4p****

The ID of the vSwitch to which the instance is connected.

ZoneId String No cn-hangzhou-g

The zone ID of the instance.

InstanceNetworkType String No vpc

The network type of the instance. Valid values:

  • classic: classic network
  • vpc: VPC
SecurityGroupId String No sg-bp67acfmxazb4p****

The ID of the security group to which the instance belongs.

InstanceIds String No ["i-bp67acfmxazb4p****", "i-bp67acfmxazb4p****", ... "i-bp67acfmxazb4p****"]

The IDs of instances. The value can be a JSON array that consists of up to 100 instance IDs. Separate the instance IDs with commas (,).

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1.

PageSize Integer No 10

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set the value to the NextToken value returned in the last call to the DescribeInstances operation.

MaxResults Integer No 10

The maximum number of entries to return on each page. Maximum value: 100.

Default value:

  • If this parameter is not specified or is set to a value smaller than 10, the default value is 10.
  • If this parameter is set to a value greater than 100, the default value is 100.
InnerIpAddresses String No ["10.1.1.1", "10.1.2.1", ... "10.1.10.1"]

The internal IP addresses of instances located in the classic network. This parameter is valid when InstanceNetworkType is set to classic. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

PrivateIpAddresses String No ["172.16.1.1", "172.16.2.1", ... "172.16.10.1"]

The private IP addresses of instances located in VPCs. This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

PublicIpAddresses String No ["42.1.1.**", "42.1.2.**", ... "42.1.10.**"]

The public IP addresses of instances. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

EipAddresses String No ["42.1.1.**", "42.1.2.**", ... "42.1.10.**"]

The elastic IP addresses (EIPs) of instances. This parameter is valid when InstanceNetworkType is set to vpc. The value can be a JSON array that consists of up to 100 IP addresses. Separate the IP addresses with commas (,).

InstanceChargeType String No PostPaid

The billing method of the instance. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
InternetChargeType String No PayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic: pay-by-traffic
Note When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidths may be limited. If you want guaranteed bandwidths for your instance, use the pay-by-bandwidth billing method for network usage.
InstanceName String No Test

The name of the instance. Fuzzy search with the asterisk (*) wildcard is supported.

ImageId String No m-bp67acfmxazb4p****

The ID of the image.

Status String No Running

The state of the instance. Valid values:

  • Pending: The instance is being created.
  • Running: The instance is running.
  • Starting: The instance is being started.
  • Stopping: The instance is being stopped.
  • Stopped: The instance is stopped.
LockReason String No security

The reason why the instance is locked.

Filter.1.Key String No CreationStartTime

The key of filter 1 used to query resources. Set the value to CreationStartTime. You can set a time by specifying both Filter.1.Key and Filter.1.Value to query resources that were created after the time.

Filter.2.Key String No CreationEndTime

The key of filter 2 used to query resources. Set the value to CreationEndTime. You can set a time by specifying both Filter.2.Key and Filter.2.Value to query resources that were created before the time.

Filter.3.Key String No ExpiredStartTime

The key of filter 3 used to query resources. Set the value to ExpiredStartTime. You can set a time by specifying both Filter.3.Key and Filter.3.Value to query resources that expire after the time.

Filter.4.Key String No ExpiredEndTime

The key of filter 4 used to query resources. Set the value to ExpiredEndTime. You can set a time by specifying both Filter.4.Key and Filter.4.Value to query resources that expire before the time.

Filter.1.Value String No 2017-12-05T22:40Z

The value of filter 1 used to query resources. Set the value to a time. If you specify this parameter, you must also specify the Filter.1.Key parameter. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Filter.2.Value String No 2017-12-06T22:40Z

The value of filter 2 used to query resources. Set the value to a time. If you specify this parameter, you must also specify the Filter.2.Key parameter. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Filter.3.Value String No 2017-12-07T22:40Z

The value of filter 3 used to query resources. Set the value to a time. If you specify this parameter, you must also specify the Filter.3.Key parameter. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Filter.4.Value String No 2017-12-08T22:40Z

The value of filter 4 used to query resources. Set the value to a time. If you specify this parameter, you must also specify the Filter.4.Key parameter. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

IoOptimized Boolean No true

Specifies whether the instance is I/O optimized.

InstanceType String No ecs.g5.large

The instance type of the instance.

InstanceTypeFamily String No ecs.g5

The instance family of the instance.

KeyPairName String No KeyPairNameTest

The name of the SSH key pair bound to the instance.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which the instance belongs. When this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

HpcClusterId String No hpc-bp67acfmxazb4p****

The ID of the High Performance Computing (HPC) cluster to which the instance belongs.

RdmaIpAddresses String No 10.10.10.102

The Remote Direct Memory Access (RDMA) IP addresses of HPC instances.

DryRun Boolean No false

Specifies whether to check the validity of the request without actually making the request. Default value: false. Valid values:

  • true: The validity of the request is checked but the request is not made. Check items include whether your AccessKey pair is valid, whether RAM users are granted required permissions, and whether the required parameters are specified. If the check fails, the corresponding error is returned. If the check succeeds, the DryRunOperation error code is returned.
  • false: The validity of the request is checked. If the check succeeds, a 2XX HTTP status code is returned and the request is made.
HttpEndpoint String No enabled

Specifies whether the access channel for the instance metadata is enabled. Valid values:

  • enabled
  • disabled

Default value: enabled.

Note For more information about instance metadata, see Overview of ECS instance metadata.
HttpTokens String No optional

Indicates whether to forcibly use the security hardening mode (IMDSv2) to access instance metadata. Valid values:

  • optional: The security hardening mode (IMDSv2) is not forcibly used.
  • required: The security hardening mode (IMDSv2) is forcibly used. After you set this parameter to required, you cannot access instance metadata in normal mode.

Default value: optional.

Note For more information about modes of accessing instance metadata, see Access mode of instance metadata.
Ipv6Address.N String No 2408:4321:180:1701:94c7:bc38:3bfa:****

IPv6 address N of the elastic network interface (ENI). You can specify multiple IPv6 addresses. Valid values of N: 1 to 100.

Tag.N.key String No keyTest

The key of tag N.

Note This parameter will be removed in the future. We recommend that you use the Tag.N.Key parameter to ensure future compatibility.
Tag.N.Key String No TestKey

The key of tag N. Valid values of N: 1 to 20.

If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation.

Tag.N.Value String No TestValue

The value of tag N. Valid values of N: 1 to 20.

Tag.N.value String No valueTest

The value of tag N.

Note This parameter will be removed in the future. We recommend that you use the Tag.N.Value parameter to ensure future compatibility.
AdditionalAttributes.N String No META_OPTIONS

The value of attribute N. Valid values of N: 1 to 20. Valid values:

  • META_OPTIONS: instance metadata
  • DDH_CLUSTER: dedicated host cluster
  • NETWORK_PRIMARY_ENI_IP: secondary IP address associated with the primary ENI of the instance

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The query token that is returned in this call.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 1

The total number of instances returned.

Note If you specify the MaxResults and NextToken parameters to perform a paged query, the value of the TotalCount response parameter is invalid.
Instances Array of Instance

Details about the instances.

Instance
CreationTime String 2017-12-10T04:04Z

The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For more information, see ISO 8601.

SerialNumber String 51d1353b-22bf-4567-a176-8b3e12e4****

The serial number of the instance.

Status String Running

The state of the instance.

DeploymentSetId String ds-bp67acfmxazb4p****

The ID of the deployment set in which the instance is deployed.

KeyPairName String testKeyPairName

The name of the key pair bound to the instance.

SaleCycle String month

The billing cycle of the instance.

SpotStrategy String NoSpot

The bidding policy for the instance. Valid values:

  • NoSpot: The instance is a regular pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is a preemptible instance for which the market price is automatically used as the bid price. The market price can be up to the pay-as-you-go price.
DeviceAvailable Boolean true

Indicates whether data disks can be attached to the instance.

LocalStorageCapacity Long 1000

The capacity of local disks attached to the instance.

Description String testDescription

The description of the instance.

SpotDuration Integer 1

The protection period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.

  • Protection periods of 2, 3, 4, 5, and 6 hours are in invitational preview. If you want to set this parameter to one of these values, submit a ticket.
  • A value of 0 indicates that the preemptible instance has no protection period.
InstanceNetworkType String vpc

The network type of the instance. Valid values:

  • classic
  • vpc
InstanceName String InstanceNameTest

The name of the instance.

OSNameEn String CentOS 7.4 64 bit

The English name of the operating system of the instance.

HpcClusterId String hpc-bp67acfmxazb4p****

The ID of the HPC cluster to which the instance belongs.

SpotPriceLimit Float 0.98

The maximum hourly price of the instance. It can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.

Memory Integer 16384

The memory size of the instance. Unit: MiB.

OSName String CentOS 7.4 64-bit

The name of the operating system of the instance.

DeploymentSetGroupNo Integer 1

The number of the deployment set group to which the instance belongs in a deployment set.

ImageId String m-bp67acfmxazb4p****

The ID of the image that the instance is running.

VlanId String 10

The virtual LAN (VLAN) ID of the instance.

Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
ClusterId String c-bp67acfmxazb4p****

The ID of the cluster to which the instance belongs.

Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
GPUSpec String NVIDIA V100

The GPU model used by the instance type.

AutoReleaseTime String 2017-12-10T04:04Z

The time when to automatically release the pay-as-you-go instance.

DeletionProtection Boolean false

The release protection attribute of the instance. This parameter indicates whether you can use the ECS console or call the DeleteInstance operation to release the instance.

  • true: Release protection is enabled for the instance.
  • false: Release protection is disabled for the instance.
Note This parameter is applicable only to pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.
StoppedMode String KeepCharging

Indicates whether the instance continues to be billed after it is stopped. Valid values:

  • KeepCharging: standard mode. Billing of the instance continues after the instance is stopped, and resources are retained for the instance.
  • StopCharging: economical mode. Billing of some resources of the instance stops after the instance is stopped. When the instance is stopped, its resources such as vCPUs, memory, and public IP address are released. You may be unable to restart the instance if some types of resources are out of stock in the current region.
  • Not-applicable: Economical mode is not applicable to the instance.
GPUAmount Integer 4

The number of GPUs per instance of the instance type.

HostName String testHostName

The hostname of the instance.

InstanceId String i-bp67acfmxazb4p****

The ID of the instance.

InternetMaxBandwidthOut Integer 5

The maximum outbound public bandwidth. Unit: Mbit/s.

InternetMaxBandwidthIn Integer 50

The maximum inbound public bandwidth. Unit: Mbit/s.

InstanceType String ecs.g5.large

The instance type of the instance.

InstanceChargeType String PostPaid

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
RegionId String cn-hangzhou

The region ID of the instance.

IoOptimized Boolean true

Indicates whether the instance is I/O optimized.

StartTime String 2017-12-10T04:04Z

The time when the instance was last started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For more information, see ISO 8601.

Cpu Integer 8

The number of vCPUs.

LocalStorageAmount Integer 2

The number of local disks attached to the instance.

ExpiredTime String 2017-12-10T04:04Z

The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For more information, see ISO 8601.

ResourceGroupId String rg-bp67acfmxazb4p****

The ID of the resource group to which the instance belongs.

InternetChargeType String PayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic: pay-by-traffic
ZoneId String cn-hangzhou-g

The zone ID of the instance.

Recyclable Boolean false

Indicates whether the instance can be recycled.

ISP String null
Note This parameter is in invitational preview and is unavailable for general users.
CreditSpecification String Standard

The performance mode of the burstable instance. Valid values:

  • Standard: standard mode. For more information, see the "Standard mode" section in Overview.
  • Unlimited: unlimited mode. For more information, see the "Unlimited mode" section in Overview.
InstanceTypeFamily String ecs.g5

The instance family of the instance.

OSType String linux

The type of the operating system of the instance. Valid values:

  • windows
  • linux
NetworkInterfaces Array of NetworkInterface

Details about the ENIs bound to the instance.

NetworkInterface
Type String Primary

The type of the ENI. Valid values:

  • Primary
  • Secondary
MacAddress String 00:16:3e:32:b4:**

The media access control (MAC) address of the ENI.

PrimaryIpAddress String 172.17.**.***

The primary private IP address of the ENI.

NetworkInterfaceId String eni-2zeh9atclduxvf1z****

The ID of the ENI.

PrivateIpSets Array of PrivateIpSet

Details about the private IP addresses.

PrivateIpSet
PrivateIpAddress String 172.17.**.**

The private IP address of the instance.

Primary Boolean true

Indicates whether the IP address is the primary private IP address.

Ipv6Sets Array of Ipv6Set

The IPv6 addresses assigned to the ENI. This parameter has a value only when the AdditionalAttributes.N request parameter is set to NETWORK_PRIMARY_ENI_IP.

Ipv6Set
Ipv6Address String 2408:4321:180:1701:94c7:bc38:3bfa:***

The IPv6 address assigned to the ENI.

OperationLocks Array of LockReason

The reasons why the instance was locked.

LockReason
LockMsg String The specified instance is locked due to financial reason.

The message returned when the instance was locked.

LockReason String Recycling

The reason why the instance was locked. Valid values:

  • financial: The instance was locked due to overdue payments.
  • security: The instance was locked due to security reasons.
  • recycling: The preemptible instance was locked and pending release.
  • dedicatedhostfinancial: The instance was locked due to overdue payments for the dedicated host.
  • refunded: The instance was locked because a refund was made for the instance.
Tags Array of Tag

The tags of the instance.

Tag
TagValue String TestValue

The tag value of the instance.

TagKey String TestKey

The tag key of the instance.

RdmaIpAddress Array of String 10.10.10.102

The RDMA IP address of the HPC instance.

SecurityGroupIds Array of String sg-bp67acfmxazb4p****

The IDs of the security groups to which the instance belongs.

PublicIpAddress Array of String 121.40.**.**

The public IP address of the instance.

InnerIpAddress Array of String 10.170.**.**

The internal IP address of the instance located in the classic network.

VpcAttributes Object

The VPC attributes of the instance.

VpcId String vpc-2zeuphj08tt7q3brd****

The ID of the VPC.

NatIpAddress String 172.17.**.**

The NAT IP address of the instance. It is used by ECS instances in different VPCs for communication.

VSwitchId String vsw-2zeh0r1pabwtg6wcs****

The ID of the vSwitch.

PrivateIpAddress Array of String 172.17.**.**

The private IP address of the instance.

EipAddress Object

Details about the EIP associated with the instance.

IsSupportUnassociate Boolean true

Indicates whether the EIP can be disassociated.

InternetChargeType String PayByTraffic

The billing method of the EIP. Valid values:

  • PayByBandwidth
  • PayByTraffic
IpAddress String 42.112.**.**

The EIP.

Bandwidth Integer 5

The maximum public bandwidth of the EIP. Unit: Mbit/s.

AllocationId String eip-2ze88m67qx5z****

The ID of the EIP.

HibernationOptions Object
Note This parameter is in invitational preview and is unavailable for general users.
Configured Boolean false
Note This parameter is in invitational preview and is unavailable for general users.
DedicatedHostAttribute Object

Details about the dedicated host. It is an array that consists of the DedicatedHostClusterId, DedicatedHostId, and DedicatedHostName parameters.

DedicatedHostId String dh-bp67acfmxazb4p****

The ID of the dedicated host.

DedicatedHostName String testDedicatedHostName

The name of the dedicated host.

DedicatedHostClusterId String dc-bp67acfmxazb4h****

The ID of the dedicated host cluster.

EcsCapacityReservationAttr Object

Details about the capacity reservation related to the instance.

CapacityReservationPreference String cr-bp67acfmxazb4p****

The preference of the capacity reservation.

CapacityReservationId String cr-bp67acfmxazb4p****

The ID of the capacity reservation.

DedicatedInstanceAttribute Object

The attributes of the instance on the dedicated host.

Affinity String default

Indicates whether the instance on the dedicated host is associated with the dedicated host. Valid values:

  • default: The instance is not associated with the dedicated host. When the instance is started from economical mode, the instance may be automatically deployed to another dedicated host in the automatic deployment resource pool.
  • host: The instance is associated with the dedicated host. When the instance is started from economical mode, the instance still resides on the original dedicated host.
Tenancy String default

Indicates whether the instance is hosted on a dedicated host. Valid values:

  • default: The instance is not hosted on a dedicated host.
  • host: The instance is hosted on a dedicated host.
CpuOptions Object

Details about the CPU options.

Numa String 2

The number of threads allocated. Valid value: 2.

CoreCount Integer 2

The number of CPU cores.

ThreadsPerCore Integer 4

The number of threads per core.

MetadataOptions Object

Details about the metadata options.

HttpEndpoint String enabled

Indicates whether the access channel is enabled for instance metadata. Valid values:

  • enabled
  • disabled
HttpPutResponseHopLimit Integer 0
Note This parameter is unavailable.
HttpTokens String optional

Indicates whether to forcibly use the security hardening mode (IMDSv2) to access instance metadata. Valid values:

  • optional: The security hardening mode (IMDSv2) is not forcibly used.
  • required: The security hardening mode (IMDSv2) is forcibly used.
ImageOptions Object
Note This parameter is unavailable.
LoginAsNonRoot Boolean false
Note This parameter is unavailable.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&PageSize=1
&PageNumber=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesResponse>
    <Instances>
        <Instance>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Memory>16384</Memory>
            <InstanceChargeType>PostPaid</InstanceChargeType>
            <Cpu>8</Cpu>
            <OSName>CentOS  7.4 64-bit</OSName>
            <InstanceNetworkType>vpc</InstanceNetworkType>
            <InnerIpAddress>
            </InnerIpAddress>
            <ExpiredTime>2017-12-10T04:04Z</ExpiredTime>
            <ImageId>m-bp67acfmxazb4p****</ImageId>
            <EipAddress>
                <AllocationId>eip-2ze88m67qx5z****</AllocationId>
                <IpAddress>42.112.**.**</IpAddress>
                <InternetChargeType>PayByTraffic</InternetChargeType>
            </EipAddress>
            <HostName>testHostName</HostName>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue>TestValue</TagValue>
                </Tag>
            </Tags>
            <VlanId/>
            <Status>Running</Status>
            <MetadataOptions>
                <HttpTokens>optional</HttpTokens>
                <HttpEndpoint>enabled</HttpEndpoint>
            </MetadataOptions>
            <InstanceId>i-bp67acfmxazb4p****</InstanceId>
            <StoppedMode>KeepCharging</StoppedMode>
            <CpuOptions>
                <ThreadsPerCore>2</ThreadsPerCore>
                <Numa>2</Numa>
                <CoreCount>4</CoreCount>
            </CpuOptions>
            <StartTime>2017-12-10T04:04Z</StartTime>
            <DeletionProtection>false</DeletionProtection>
            <SecurityGroupIds>
                <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
            </SecurityGroupIds>
            <VpcAttributes>
                <PrivateIpAddress>
                    <IpAddress>172.17.**.**</IpAddress>
                </PrivateIpAddress>
                <VpcId>vpc-2zeuphj08tt7q3brd****</VpcId>
                <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
                <NatIpAddress>172.17.**.**</NatIpAddress>
            </VpcAttributes>
            <InternetChargeType>PayByTraffic</InternetChargeType>
            <InstanceName>InstanceNameTest</InstanceName>
            <DeploymentSetId/>
            <InternetMaxBandwidthOut>5</InternetMaxBandwidthOut>
            <SerialNumber>51d1353b-22bf-4567-a176-8b3e12e4****</SerialNumber>
            <OSType>linux</OSType>
            <CreationTime>2017-12-10T04:04Z</CreationTime>
            <AutoReleaseTime>2017-12-10T04:04Z</AutoReleaseTime>
            <Description>testDescription</Description>
            <InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
            <DedicatedInstanceAttribute>
                <Tenancy>default</Tenancy>
                <Affinity>default</Affinity>
            </DedicatedInstanceAttribute>
            <PublicIpAddress>
                <IpAddress>121.40.**.**</IpAddress>
            </PublicIpAddress>
            <GPUSpec/>
            <NetworkInterfaces>
                <NetworkInterface>
                    <Type>Primary</Type>
                    <PrimaryIpAddress>172.17.**.***</PrimaryIpAddress>
                    <NetworkInterfaceId>eni-2zeh9atclduxvf1z****</NetworkInterfaceId>
                    <MacAddress>00:16:3e:32:b4:**</MacAddress>
                    <PrivateIpSets>
                        <PrivateIpSet>
                            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
                            <Primary>true</Primary>
                        </PrivateIpSet>
                    </PrivateIpSets>
                </NetworkInterface>
            </NetworkInterfaces>
            <SpotPriceLimit>0.98</SpotPriceLimit>
            <DeviceAvailable>true</DeviceAvailable>
            <SaleCycle>month</SaleCycle>
            <InstanceType>ecs.g5.large</InstanceType>
            <OSNameEn>CentOS  7.4 64 bit</OSNameEn>
            <SpotStrategy>NoSpot</SpotStrategy>
            <IoOptimized>true</IoOptimized>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <ClusterId>c-bp67acfmxazb4p****</ClusterId>
            <EcsCapacityReservationAttr>
                <CapacityReservationPreference/>
                <CapacityReservationId/>
            </EcsCapacityReservationAttr>
            <DedicatedHostAttribute>
                <DedicatedHostId>dh-bp67acfmxazb4p****</DedicatedHostId>
                <DedicatedHostName>testDedicatedHostName</DedicatedHostName>
                <DedicatedHostClusterId>dc-bp67acfmxazb4h****</DedicatedHostClusterId>
            </DedicatedHostAttribute>
            <GPUAmount>4</GPUAmount>
            <OperationLocks>
            </OperationLocks>
            <InternetMaxBandwidthIn>50</InternetMaxBandwidthIn>
            <Recyclable>false</Recyclable>
            <RegionId>cn-hangzhou</RegionId>
            <CreditSpecification/>
        </Instance>
    </Instances>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
</DescribeInstancesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Instances" : {
    "Instance" : [ {
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "Memory" : 16384,
      "InstanceChargeType" : "PostPaid",
      "Cpu" : 8,
      "OSName": "CentOS 7.4 64-bit",
      "InstanceNetworkType" : "vpc",
      "InnerIpAddress" : {
        "IpAddress" : [ ]
      },
      "ExpiredTime" : "2017-12-10T04:04Z",
      "ImageId" : "m-bp67acfmxazb4p****",
      "EipAddress" : {
        "AllocationId" : "eip-2ze88m67qx5z****",
        "IpAddress" : "42.112.**.**",
        "InternetChargeType" : "PayByTraffic"
      },
      "HostName" : "testHostName",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "TestKey",
          "TagValue" : "TestValue"
        } ]
      },
      "VlanId" : "",
      "Status" : "Running",
      "MetadataOptions" : {
        "HttpTokens" : "optional",
        "HttpEndpoint" : "enabled"
      },
      "InstanceId" : "i-bp67acfmxazb4p****",
      "StoppedMode" : "KeepCharging",
      "CpuOptions" : {
        "ThreadsPerCore" : 2,
        "Numa" : "2",
        "CoreCount" : 4
      },
      "StartTime" : "2017-12-10T04:04Z",
      "DeletionProtection" : false,
      "SecurityGroupIds" : {
        "SecurityGroupId" : [ "sg-bp67acfmxazb4p****" ]
      },
      "VpcAttributes" : {
        "PrivateIpAddress" : {
          "IpAddress" : [ "172.17.**.**" ]
        },
        "VpcId" : "vpc-2zeuphj08tt7q3brd****",
        "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****",
        "NatIpAddress" : "172.17.**.**"
      },
      "InternetChargeType" : "PayByTraffic",
      "InstanceName" : "InstanceNameTest",
      "DeploymentSetId" : "",
      "InternetMaxBandwidthOut" : 5,
      "SerialNumber" : "51d1353b-22bf-4567-a176-8b3e12e4****",
      "OSType" : "linux",
      "CreationTime" : "2017-12-10T04:04Z",
      "AutoReleaseTime" : "2017-12-10T04:04Z",
      "Description" : "testDescription",
      "InstanceTypeFamily" : "ecs.g5",
      "DedicatedInstanceAttribute" : {
        "Tenancy" : "default",
        "Affinity" : "default"
      },
      "PublicIpAddress" : {
        "IpAddress" : [ "121.40.**.**" ]
      },
      "GPUSpec" : "",
      "NetworkInterfaces" : {
        "NetworkInterface" : [ {
          "Type" : "Primary",
          "PrimaryIpAddress" : "172.17.**.***",
          "NetworkInterfaceId" : "eni-2zeh9atclduxvf1z****",
          "MacAddress" : "00:16:3e:32:b4:**",
          "PrivateIpSets" : {
            "PrivateIpSet" : [ {
              "PrivateIpAddress" : "172.17.**.**",
              "Primary" : true
            } ]
          }
        } ]
      },
      "SpotPriceLimit" : 0.98,
      "DeviceAvailable" : true,
      "SaleCycle" : "month",
      "InstanceType" : "ecs.g5.large",
      "OSNameEn" : "CentOS  7.4 64 bit",
      "SpotStrategy" : "NoSpot",
      "IoOptimized" : true,
      "ZoneId" : "cn-hangzhou-g",
      "ClusterId" : "c-bp67acfmxazb4p****",
      "EcsCapacityReservationAttr" : {
        "CapacityReservationPreference" : "",
        "CapacityReservationId" : ""
      },
      "DedicatedHostAttribute" : {
        "DedicatedHostId" : "dh-bp67acfmxazb4p****",
        "DedicatedHostName" : "testDedicatedHostName",
        "DedicatedHostClusterId" : "dc-bp67acfmxazb4h****"
      },
      "GPUAmount" : 4,
      "OperationLocks" : {
        "LockReason" : [ ]
      },
      "InternetMaxBandwidthIn" : 50,
      "Recyclable" : false,
      "RegionId" : "cn-hangzhou",
      "CreditSpecification" : ""
    } ]
  },
  "TotalCount" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize" : 10,
  "PageNumber" : 1,
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. The error message returned because the specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400 InvalidTagCount The specified tags are beyond the permitted range. The error message returned because the number of specified tags exceeds the upper limit.
400 InvalidHpcClusterId.NotFound The specified HpcClusterId is not found. The error message returned because the specified HpcClusterId parameter does not exist.
400 InvalidHpcClusterId.Creating The specified HpcClusterId is creating. The error message returned because the specified HPC cluster is being created.
404 InvalidInstanceChargeType.NotFound The InstanceChargeType does not exist in our records The error message returned because the specified InstanceChargeType parameter does not exist.
404 InvalidInternetChargeType.ValueNotSupported The specified InternetChargeType is not valid The error message returned because the specified InternetChargeType parameter is invalid.
404 InvalidLockReason.NotFound The specified LockReason is not found The error message returned because the specified LockReason parameter does not exist.
404 InvalidNetworkType.NotFound The specified InstanceNetworkType is not found The error message returned because the specified InstanceNetworkType parameter does not exist.
404 InvalidStatus.NotFound The specified Status is not found The error message returned because the specified Status parameter does not exist.

For a list of error codes, visit the API Error Center.