DescribeInstances

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 RAM user or RAM role, an empty list is returned when the user or the role does not have the permission to call this operation. You can include the DryRun parameter in your request to check whether the empty list is caused by the lack of permissions.
• When you call an API operation by using Alibaba Cloud Command Line Interface (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: Use NextToken to configure the query token. Set this parameter to the NextToken value returned in the last call to the DescribeInstances operation. Then, use MaxResults to specify the maximum number of entries to return on each page.

  • 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. If NextToken is set, the PageSize and PageNumber request parameters become invalid.

Request parameters

Response parameters

Examples

Sample requests

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

Sample success responses

XML format

<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></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></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></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></CapacityReservationPreference>
                        <CapacityReservationId></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></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

{
	"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

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