DescribeInstances - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the information about one or more Elastic Compute Service (ECS) instances.

You can specify multiple request parameters to filter query results. Specified request 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 request 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 IDs with commas (,).
PageNumber	Integer	No	1	The page number. Pages start from page 1. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of `NextToken`.
MaxResults	Integer	No	10	The maximum number of entries per page. Valid values: 1 to 100. Default values: 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 bandwidth values may be limited. If you want guaranteed bandwidths for your instances, 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 characters is supported.
ImageId	String	No	m-bp67acfmxazb4p****	The ID of the image.
Status	String	No	Running	The status 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. Valid values: financial: The instance is locked due to overdue payments. security: The instance is locked due to security reasons. recycling: The preemptible instance is locked and pending release. dedicatedhostfinancial: The instance is locked due to overdue payments for the dedicated host. refunded: The instance is locked because a refund is made for the instance.
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 `Filter.1.Key`. 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 `Filter.2.Key`. 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 `Filter.3.Key`. 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 `Filter.4.Key`. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
DeviceAvailable	Boolean	No	false	Note This parameter is in invitational preview and unavailable to general users.
IoOptimized	Boolean	No	true	Specifies whether the instance is I/O optimized.
NeedSaleCycle	Boolean	No	false	Note This parameter is in invitational preview and unavailable to general users.
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. If 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. Note Resources in the default resource group are displayed in the response regardless of how this parameter is set.
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 address of the HPC instance.
DryRun	Boolean	No	false	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the AccessKey pair, the permissions of the RAM user, and the required parameters. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
HttpEndpoint	String	No	enabled	Specifies whether the access channel is enabled for instance metadata. Valid values: enabled disabled Default value: enabled. Note For more information about instance metadata, see Overview of ECS instance metadata.
HttpTokens	String	No	optional	Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values: optional: The security hardening mode (IMDSv2) is not forcefully used. required: The security hardening mode (IMDSv2) is forcefully 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.
HttpPutResponseHopLimit	Integer	No	0	Note This parameter is in invitational preview and unavailable to general users.
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 of the instance. 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 of the instance. 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 of the instance. Valid values of N: 1 to 20.
Tag.N.value	String	No	valueTest	The value of tag N of the instance. 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	A pagination token. It can be used in the next request to retrieve a new page of results.
PageSize	Integer	10	The number of entries per page.
PageNumber	Integer	1	The page number.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The request ID.
TotalCount	Integer	1	The total number of instances queried. Note If you specify the `MaxResults` and `NextToken` parameters to perform a paged query, the value of `TotalCount` is invalid.
Instances	Array of Instance		The queried 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 status 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	Note The parameter is removed.
SpotStrategy	String	NoSpot	The bidding policy for the pay-as-you-go instance. Valid values: NoSpot: The instance is created as a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a preemptible instance with user-defined maximum hourly prices. 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. Unit: GiB.
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 use one of these values, submit a ticket. A value of 0 indicates that the preemptible instance has no protection period. Note This parameter is returned when the SpotStrategy parameter is set to SpotWithPriceLimit or SpotAsPriceGo.
InstanceNetworkType	String	vpc	The network type of the instance. Valid values: classic: classic network vpc: 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 local area network (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 was enabled for the instance. false: Release protection was 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: The instance is stopped in standard mode. The billing of the instance continues after the instance is stopped, and resources are retained for the instance. StopCharging: The instance is stopped in economical mode. The 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. The instance may be unable to restart if some required resources are out of stock in the current region. Not-applicable: The economical mode is not applicable to the instance.
GPUAmount	Integer	4	The number of GPUs used by 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.
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 unavailable to 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		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		The private IP addresses.
PrivateIpSet
PrivateIpAddress	String	172.17..	The private IP address of the instance.
Primary	Boolean	true	Indicates whether the private 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 `AdditionalAttributes.N` is set to `NETWORK_PRIMARY_ENI_IP`.
Ipv6Set
Ipv6Address	String	2408:4321:180:1701:94c7:bc38:3bfa:***	The IPv6 address assigned to the ENI.
Ipv4PrefixSets	Array of Ipv4PrefixSet		The IPv4 prefixes assigned to the ENI. This parameter has a value only when `AdditionalAttributes.N` is set to `NETWORK_PRIMARY_ENI_IP`.
Ipv4PrefixSet
Ipv4Prefix	String	192.168../28	The IPv4 prefix assigned to the ENI.
Ipv6PrefixSets	Array of Ipv6PrefixSet		The IPv6 prefixes assigned to the ENI. This parameter has a value only when `AdditionalAttributes.N` is set to `NETWORK_PRIMARY_ENI_IP`.
Ipv6PrefixSet
Ipv6Prefix	String	2001:1111::::/80	The IPv6 prefix 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 is 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		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 unavailable to general users.
Configured	Boolean	false	Note This parameter is in invitational preview and unavailable to general users.
DedicatedHostAttribute	Object		The information 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 to which the dedicated host belongs.
EcsCapacityReservationAttr	Object		The capacity reservation associated with 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 a 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 on 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 is still deployed 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		The CPU options.
Numa	String	2	The number of threads allocated. Valid value: 2.
CoreCount	Integer	2	The number of physical CPU cores.
ThreadsPerCore	Integer	4	The number of threads per CPU core.
MetadataOptions	Object		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 to general users.
HttpTokens	String	optional	Indicates whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata. Valid values: optional: The security hardening mode (IMDSv2) is not forcefully used. required: The security hardening mode (IMDSv2) is forcefully used.
ImageOptions	Object		The image options.
LoginAsNonRoot	Boolean	false	Indicates whether the instance that uses the image supports logons of the ecs-user user. Valid values: true false

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>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>1</TotalCount>
    <Instances>
        <Instance>
            <CreationTime>2017-12-10T04:04Z</CreationTime>
            <SerialNumber>51d1353b-22bf-4567-a176-8b3e12e4****</SerialNumber>
            <Status>Running</Status>
            <DeploymentSetId>ds-bp67acfmxazb4p****</DeploymentSetId>
            <KeyPairName>testKeyPairName</KeyPairName>
            <SaleCycle>month</SaleCycle>
            <SpotStrategy>NoSpot</SpotStrategy>
            <DeviceAvailable>true</DeviceAvailable>
            <LocalStorageCapacity>1000</LocalStorageCapacity>
            <Description>testDescription</Description>
            <SpotDuration>1</SpotDuration>
            <InstanceNetworkType>vpc</InstanceNetworkType>
            <InstanceName>InstanceNameTest</InstanceName>
            <OSNameEn>CentOS  7.4 64 bit</OSNameEn>
            <HpcClusterId>hpc-bp67acfmxazb4p****</HpcClusterId>
            <SpotPriceLimit>0.98</SpotPriceLimit>
            <Memory>16384</Memory>
            <OSName>CentOS  7.4 64-bit</OSName>
            <DeploymentSetGroupNo>1</DeploymentSetGroupNo>
            <ImageId>m-bp67acfmxazb4p****</ImageId>
            <VlanId>10</VlanId>
            <ClusterId>c-bp67acfmxazb4p****</ClusterId>
            <GPUSpec>NVIDIA V100</GPUSpec>
            <AutoReleaseTime>2017-12-10T04:04Z</AutoReleaseTime>
            <DeletionProtection>false</DeletionProtection>
            <StoppedMode>KeepCharging</StoppedMode>
            <GPUAmount>4</GPUAmount>
            <HostName>testHostName</HostName>
            <InstanceId>i-bp67acfmxazb4p****</InstanceId>
            <InternetMaxBandwidthOut>5</InternetMaxBandwidthOut>
            <InternetMaxBandwidthIn>50</InternetMaxBandwidthIn>
            <InstanceType>ecs.g5.large</InstanceType>
            <InstanceChargeType>PostPaid</InstanceChargeType>
            <RegionId>cn-hangzhou</RegionId>
            <IoOptimized>true</IoOptimized>
            <StartTime>2017-12-10T04:04Z</StartTime>
            <Cpu>8</Cpu>
            <LocalStorageAmount>2</LocalStorageAmount>
            <ExpiredTime>2017-12-10T04:04Z</ExpiredTime>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <InternetChargeType>PayByTraffic</InternetChargeType>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <Recyclable>false</Recyclable>
            <ISP>null</ISP>
            <CreditSpecification>Standard</CreditSpecification>
            <InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
            <OSType>linux</OSType>
            <NetworkInterfaces>
                <NetworkInterface>
                    <Type>Primary</Type>
                    <MacAddress>00:16:3e:32:b4:**</MacAddress>
                    <PrimaryIpAddress>172.17.**.***</PrimaryIpAddress>
                    <NetworkInterfaceId>eni-2zeh9atclduxvf1z****</NetworkInterfaceId>
                    <PrivateIpSets>
                        <PrivateIpSet>
                            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
                            <Primary>true</Primary>
                        </PrivateIpSet>
                    </PrivateIpSets>
                    <Ipv6Sets>
                        <Ipv6Set>
                            <Ipv6Address>2408:4321:180:1701:94c7:bc38:3bfa:***</Ipv6Address>
                        </Ipv6Set>
                    </Ipv6Sets>
                    <Ipv4PrefixSets>
                        <Ipv4PrefixSet>
                            <Ipv4Prefix>192.168.*.*/28</Ipv4Prefix>
                        </Ipv4PrefixSet>
                    </Ipv4PrefixSets>
                    <Ipv6PrefixSets>
                        <Ipv6PrefixSet>
                            <Ipv6Prefix>2001:1111:*:*::/80</Ipv6Prefix>
                        </Ipv6PrefixSet>
                    </Ipv6PrefixSets>
                    <OperationLocks>
                        <OperationLock>
                            <LockMsg>The specified instance is locked due to financial reason.</LockMsg>
                            <LockReason>Recycling</LockReason>
                        </OperationLock>
                    </OperationLocks>
                    <Tags>
                        <Tag>
                            <TagValue>TestValue</TagValue>
                            <TagKey>TestKey</TagKey>
                        </Tag>
                    </Tags>
                    <RdmaIpAddresses>
                        <RdmaIpAddress>10.10.10.102</RdmaIpAddress>
                    </RdmaIpAddresses>
                    <SecurityGroupIds>
                        <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
                    </SecurityGroupIds>
                    <PublicIpAddress>
                        <PublicIpAddres>121.40.**.**</PublicIpAddres>
                    </PublicIpAddress>
                    <InnerIpAddress>
                        <InnerIpAddres>10.170.**.**</InnerIpAddres>
                    </InnerIpAddress>
                    <VpcAttributes>
                        <VpcId>vpc-2zeuphj08tt7q3brd****</VpcId>
                        <NatIpAddress>172.17.**.**</NatIpAddress>
                        <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
                        <PrivateIpAddress>
                            <PrivateIpAddres>172.17.**.**</PrivateIpAddres>
                        </PrivateIpAddress>
                    </VpcAttributes>
                    <EipAddress>
                        <IsSupportUnassociate>true</IsSupportUnassociate>
                        <InternetChargeType>PayByTraffic</InternetChargeType>
                        <IpAddress>42.112.**.**</IpAddress>
                        <Bandwidth>5</Bandwidth>
                        <AllocationId>eip-2ze88m67qx5z****</AllocationId>
                    </EipAddress>
                    <HibernationOptions>
                        <Configured>false</Configured>
                    </HibernationOptions>
                    <DedicatedHostAttribute>
                        <DedicatedHostId>dh-bp67acfmxazb4p****</DedicatedHostId>
                        <DedicatedHostName>testDedicatedHostName</DedicatedHostName>
                        <DedicatedHostClusterId>dc-bp67acfmxazb4h****</DedicatedHostClusterId>
                    </DedicatedHostAttribute>
                    <EcsCapacityReservationAttr>
                        <CapacityReservationPreference>cr-bp67acfmxazb4p****</CapacityReservationPreference>
                        <CapacityReservationId>cr-bp67acfmxazb4p****</CapacityReservationId>
                    </EcsCapacityReservationAttr>
                    <DedicatedInstanceAttribute>
                        <Affinity>default</Affinity>
                        <Tenancy>default</Tenancy>
                    </DedicatedInstanceAttribute>
                    <CpuOptions>
                        <Numa>2</Numa>
                        <CoreCount>2</CoreCount>
                        <ThreadsPerCore>4</ThreadsPerCore>
                    </CpuOptions>
                    <MetadataOptions>
                        <HttpEndpoint>enabled</HttpEndpoint>
                        <HttpPutResponseHopLimit>0</HttpPutResponseHopLimit>
                        <HttpTokens>optional</HttpTokens>
                    </MetadataOptions>
                    <ImageOptions>
                        <LoginAsNonRoot>false</LoginAsNonRoot>
                    </ImageOptions>
                </NetworkInterface>
            </NetworkInterfaces>
        </Instance>
    </Instances>
</DescribeInstancesResponse>

JSON format

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

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize" : 10,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 1,
  "Instances" : {
    "Instance" : [ {
      "CreationTime" : "2017-12-10T04:04Z",
      "SerialNumber" : "51d1353b-22bf-4567-a176-8b3e12e4****",
      "Status" : "Running",
      "DeploymentSetId" : "ds-bp67acfmxazb4p****",
      "KeyPairName" : "testKeyPairName",
      "SaleCycle" : "month",
      "SpotStrategy" : "NoSpot",
      "DeviceAvailable" : true,
      "LocalStorageCapacity" : 1000,
      "Description" : "testDescription",
      "SpotDuration" : 1,
      "InstanceNetworkType" : "vpc",
      "InstanceName" : "InstanceNameTest",
      "OSNameEn" : "CentOS  7.4 64 bit",
      "HpcClusterId" : "hpc-bp67acfmxazb4p****",
      "SpotPriceLimit" : 0.98,
      "Memory" : 16384,
      "OSName": "CentOS  7.4 64-bit",
      "DeploymentSetGroupNo" : 1,
      "ImageId" : "m-bp67acfmxazb4p****",
      "VlanId" : "10",
      "ClusterId" : "c-bp67acfmxazb4p****",
      "GPUSpec" : "NVIDIA V100",
      "AutoReleaseTime" : "2017-12-10T04:04Z",
      "DeletionProtection" : false,
      "StoppedMode" : "KeepCharging",
      "GPUAmount" : 4,
      "HostName" : "testHostName",
      "InstanceId" : "i-bp67acfmxazb4p****",
      "InternetMaxBandwidthOut" : 5,
      "InternetMaxBandwidthIn" : 50,
      "InstanceType" : "ecs.g5.large",
      "InstanceChargeType" : "PostPaid",
      "RegionId" : "cn-hangzhou",
      "IoOptimized" : true,
      "StartTime" : "2017-12-10T04:04Z",
      "Cpu" : 8,
      "LocalStorageAmount" : 2,
      "ExpiredTime" : "2017-12-10T04:04Z",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "InternetChargeType" : "PayByTraffic",
      "ZoneId" : "cn-hangzhou-g",
      "Recyclable" : false,
      "ISP" : "null",
      "CreditSpecification" : "Standard",
      "InstanceTypeFamily" : "ecs.g5",
      "OSType" : "linux",
      "NetworkInterfaces" : {
        "NetworkInterface" : [ {
          "Type" : "Primary",
          "MacAddress" : "00:16:3e:32:b4:**",
          "PrimaryIpAddress" : "172.17.**.***",
          "NetworkInterfaceId" : "eni-2zeh9atclduxvf1z****",
          "PrivateIpSets" : {
            "PrivateIpSet" : [ {
              "PrivateIpAddress" : "172.17.**.**",
              "Primary" : true
            } ]
          },
          "Ipv6Sets" : {
            "Ipv6Set" : [ {
              "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:***"
            } ]
          },
          "Ipv4PrefixSets" : {
            "Ipv4PrefixSet" : [ {
              "Ipv4Prefix" : "192.168.*.*/28"
            } ]
          },
          "Ipv6PrefixSets" : {
            "Ipv6PrefixSet" : [ {
              "Ipv6Prefix" : "2001:1111:*:*::/80"
            } ]
          },
          "OperationLocks" : {
            "OperationLock" : [ {
              "LockMsg" : "The specified instance is locked due to financial reason.",
              "LockReason" : "Recycling"
            } ]
          },
          "Tags" : {
            "Tag" : [ {
              "TagValue" : "TestValue",
              "TagKey" : "TestKey"
            } ]
          },
          "RdmaIpAddresses" : {
            "RdmaIpAddress" : [ "10.10.10.102" ]
          },
          "SecurityGroupIds" : {
            "SecurityGroupId" : [ "sg-bp67acfmxazb4p****" ]
          },
          "PublicIpAddress" : {
            "PublicIpAddres" : [ "121.40.**.**" ]
          },
          "InnerIpAddress" : {
            "InnerIpAddres" : [ "10.170.**.**" ]
          },
          "VpcAttributes" : {
            "VpcId" : "vpc-2zeuphj08tt7q3brd****",
            "NatIpAddress" : "172.17.**.**",
            "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****",
            "PrivateIpAddress" : {
              "PrivateIpAddres" : [ "172.17.**.**" ]
            }
          },
          "EipAddress" : {
            "IsSupportUnassociate" : true,
            "InternetChargeType" : "PayByTraffic",
            "IpAddress" : "42.112.**.**",
            "Bandwidth" : 5,
            "AllocationId" : "eip-2ze88m67qx5z****"
          },
          "HibernationOptions" : {
            "Configured" : false
          },
          "DedicatedHostAttribute" : {
            "DedicatedHostId" : "dh-bp67acfmxazb4p****",
            "DedicatedHostName" : "testDedicatedHostName",
            "DedicatedHostClusterId" : "dc-bp67acfmxazb4h****"
          },
          "EcsCapacityReservationAttr" : {
            "CapacityReservationPreference" : "cr-bp67acfmxazb4p****",
            "CapacityReservationId" : "cr-bp67acfmxazb4p****"
          },
          "DedicatedInstanceAttribute" : {
            "Affinity" : "default",
            "Tenancy" : "default"
          },
          "CpuOptions" : {
            "Numa" : "2",
            "CoreCount" : 2,
            "ThreadsPerCore" : 4
          },
          "MetadataOptions" : {
            "HttpEndpoint" : "enabled",
            "HttpPutResponseHopLimit" : 0,
            "HttpTokens" : "optional"
          },
          "ImageOptions" : {
            "LoginAsNonRoot" : false
          }
        } ]
      }
    } ]
  }
}

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 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 maximum number of tags is exceeded.
400	InvalidHpcClusterId.NotFound	The specified HpcClusterId is not found.	The specified HpcClusterId value is not found.
400	InvalidHpcClusterId.Creating	The specified HpcClusterId is creating.	The HPC cluster is being created.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred. Try again later.
404	InvalidInstanceChargeType.NotFound	The InstanceChargeType does not exist in our records.	The instance billing method is not found.
404	InvalidInternetChargeType.ValueNotSupported	The specified InternetChargeType is not valid.	Invalid instance billing method for network usage.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	The specified LockReason value is not found.
404	InvalidStatus.NotFound	The specified Status is not found.	The specified Status value is not found.

For a list of error codes, see Service error codes.