DescribeInstances - 云服务器 ECS

接口说明

• 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。但是参数InstanceIds如果是一个空JSON数组，则视为该过滤器有效，且返回空。
• 如果您使用的是RAM用户账号或者RAM角色，当用户或者角色缺乏接口权限时，将会返回空列表。您可以在请求中加入DryRun参数，判断是否因权限问题导致的空列表现象。
• 通过阿里云CLI调用API时，不同数据类型的请求参数取值必须遵循格式要求。更多信息，请参见CLI参数格式说明。
• 支持以下两种方式查看返回数据：
  • 方式一：通过NextToken设置查询凭证（Token），其取值是上一次调用DescribeInstances返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数。

  • 方式二：通过PageSize设置单页返回的条目数，再通过PageNumber设置页码。

    以上两种方式只能任选其中之一。当返回的条目数较多时，推荐使用方式一。如果设置了NextToken，则请求参数PageSize和PageNumber将失效。

请求参数

返回数据

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&PageSize=1
&PageNumber=1
&<公共请求参数>

正常返回示例

XML格式

<DescribeInstancesResponse>
      <Instances>
            <Instance>
                  <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
                  <Memory>16384</Memory>
                  <InstanceChargeType>PostPaid</InstanceChargeType>
                  <Cpu>8</Cpu>
                  <OSName>CentOS  7.4 64 位</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格式

{
	"Instances": {
		"Instance": [
			{
				"ResourceGroupId": "rg-bp67acfmxazb4p****",
				"Memory": 16384,
				"InstanceChargeType": "PostPaid",
				"Cpu": 8,
				"OSName": "CentOS  7.4 64 位",
				"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"
}

错误码

访问错误中心查看更多错误码。