查詢一台或多台實例的詳細資料。
描述
請求參數的作用類似於一個過濾器,過濾器為邏輯與(AND
)關係。如果某一參數為空,則過濾器不起作用。但是參數InstanceIds
如果是一個空JSON數組,即[]
,則視為該過濾器有效,且返回空。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstances |
RegionId | String | 是 | 地域ID。您可以調用DescribeRegions查看最新的阿里雲地域列表。 |
VpcId | String | 否 | Virtual Private Cloud ID。 |
VSwitchId | String | 否 | 虛擬交換器ID。 |
ZoneId | String | 否 | 可用區 ID。 |
InstanceIds | String | 否 | 實例ID。取值可以由多個實例ID 組成一個JSON數組,格式為 ["i-xxxxxxxxx", "i-yyyyyyyyy", … "i-zzzzzzzzz"],最多支援100個ID,ID之間用半形逗號(, )隔開。 |
InstanceType | String | 否 | 實例的規格。 |
InstanceTypeFamily | String | 否 | 實例的規格族。 |
InstanceNetworkType | String | 否 | 實例網路類型。取值範圍:
|
PrivateIpAddresses | String | 否 | VPC網路類型實例的私有IP。當InstanceNetworkType=vpc 時生效,取值可以由多個IP組成一個JSON數組,格式為["172.16.1.1", "172.16.2.1", … "172.16.10.1"],最多支援100個IP,IP之間用半形逗號(, )隔開。 |
InnerIpAddresses | String | 否 | 經典網路類型實例的內網IP列表。當InstanceNetworkType=classic 時生效,取值可以由多個IP組成一個JSON數組,格式為["10.1.1.1", "10.1.2.1", … "10.1.10.1"],最多支援100個IP,IP之間用半形逗號(, )隔開。 |
PublicIpAddresses | String | 否 | 實例的公網IP列表。當InstanceNetworkType=classic 時生效,取值可以由多個IP組成一個JSON數組,格式為["42.1.1.1", "42.1.2.1", … "42.1.10.1"],最多支援100個IP,IP之間用半形逗號(, )隔開。 |
EipAddresses | String | 否 | 實例的Elastic IP Address列表。當InstanceNetworkType=classic 時生效,取值可以由多個IP組成一個JSON數組,格式為["42.1.1.1", "42.1.2.1", … "42.1.10.1"],最多支援100個IP,IP之間用半形逗號(, )隔開。 |
SecurityGroupId | String | 否 | 實例所屬的安全性群組。 |
InstanceChargeType | String | 否 | 實例的計費方式。取值範圍:
|
SpotStrategy | String | 否 | 後付費實例的搶佔策略。當InstanceChargeType=PostPaid 時生效,取值範圍:
|
InternetChargeType | String | 否 | 網路計費方式。取值範圍:
|
InstanceName | String | 否 | 實例名稱。支援模糊搜索,您可以配合萬用字元使用。 |
ImageId | String | 否 | 鏡像ID。 |
DeploymentSetId | String | 否 | 部署集ID。 |
Status | String | 否 | 實例狀態。取值範圍:
|
IoOptimized | String | 否 | 是否是I/O優化型實例。取值範圍:
|
Tag.n.Key | String | 否 | 實例的標籤鍵。n的取值範圍:[1, 5]。最多支援64個字元。不能以aliyun、acs:、http://或者https://開頭。 |
Tag.n.Value | String | 否 | 實例的標籤值。n的取值範圍:[1, 5]。最多支援128個字元。不能以aliyun、http://或者https://開頭。 |
PageNumber | Integer | 否 | 實例狀態列表的頁碼。起始值:1 預設值:1 |
PageSize | Integer | 否 | 分頁查詢時設定的每頁行數。最大值:100 預設值:10 |
DryRun | Boolean | 否 | 是否只預檢此次請求。
預設值:false |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
TotalCount | Integer | 實例總台數 |
PageNumber | Integer | 實例列表的頁碼 |
PageSize | Integer | 輸入時設定的每頁行數 |
Instances | InstanceAttributesType | 由InstanceAttributesType組成的數組格式,返回實例的資訊 |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共請求參數>
返回樣本
XML格式
<DescribeInstancesResponse>
<PageNumber>1</PageNumber>
<TotalCount>6</TotalCount>
<PageSize>10</PageSize>
<RequestId>8EF01A45-FFFA-497B-B5C3-1DE1B74DB32D</RequestId>
<Instances>
<Instance>
<InnerIpAddress/>
<ImageId>ubuntu_16_0402_64_20G_alibase_20170818.vhd</ImageId>
<InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
<VlanId/>
<NetworkInterfaces>
<NetworkInterface>
<MacAddress>00:16:3e:32:b4:dc</MacAddress>
<PrimaryIpAddress>172.17.XX.XXX</PrimaryIpAddress>
<NetworkInterfaceId>eni-2zeh9atclduxvf1zcyal</NetworkInterfaceId>
</NetworkInterface>
</NetworkInterfaces>
<InstanceId>XXXXXXXXXXX</InstanceId>
<EipAddress>
<IpAddress/>
<AllocationId/>
<InternetChargeType/>
</EipAddress>
<InternetMaxBandwidthIn>1000</InternetMaxBandwidthIn>
<ZoneId>cn-beijing-e</ZoneId>
<InternetChargeType>PayByBandwidth</InternetChargeType>
<SpotStrategy>NoSpot</SpotStrategy>
<StoppedMode>Not-applicable</StoppedMode>
<SerialNumber>d9bd1cdc-624d-4736-9da5-2ba2f741a304</SerialNumber>
<IoOptimized>true</IoOptimized>
<Memory>8192</Memory>
<Cpu>2</Cpu>
<VpcAttributes>
<NatIpAddress/>
<PrivateIpAddress>
<IpAddress>172.17.XX.XXX</IpAddress>
</PrivateIpAddress>
<VSwitchId>vsw-2zeh0r1pabwtg6wcssgca</VSwitchId>
<VpcId>vpc-2zeuphj08tt7q3brdb36x</VpcId>
</VpcAttributes>
<InternetMaxBandwidthOut>1</InternetMaxBandwidthOut>
<DeviceAvailable>true</DeviceAvailable>
<SecurityGroupIds>
<SecurityGroupId>sg-2ze21r9qb638hvtrvsus</SecurityGroupId>
</SecurityGroupIds>
<SpotPriceLimit>0.0</SpotPriceLimit>
<SaleCycle>Week</SaleCycle>
<AutoReleaseTime/>
<InstanceName>ECS-BUY-2017-57-10</InstanceName>
<Description/>
<ResourceGroupId/>
<OSType>linux</OSType>
<OSName>Ubuntu 16.04 64</OSName>
<InstanceNetworkType>vpc</InstanceNetworkType>
<PublicIpAddress>
<IpAddress>47.94.XX.XX</IpAddress>
</PublicIpAddress>
<HostName>iZ2zeh9atclduxvf1zxuylZ</HostName>
<InstanceType>ecs.g5.large</InstanceType>
<CreationTime>2017-12-10T04:04Z</CreationTime>
<Tags>
<Tag>
<TagValue>fqwfew</TagValue>
<TagKey>fefqe</TagKey>
</Tag>
<Tag>
<TagValue>weqfwq</TagValue>
<TagKey>fqewfwqewf</TagKey>
</Tag>
<Tag>
<TagValue>ewqffeqw</TagValue>
<TagKey>fqfwewfqw</TagKey>
</Tag>
</Tags>
<Status>Running</Status>
<ClusterId/>
<Recyclable>false</Recyclable>
<RegionId>cn-beijing</RegionId>
<GPUSpec/>
<OperationLocks/>
<GPUAmount>0</GPUAmount>
<InstanceChargeType>PrePaid</InstanceChargeType>
<ExpiredTime>2017-12-17T16:00Z</ExpiredTime>
</Instance>
</Instances>
</DescribeInstancesResponse>
JSON格式
{
"Instances": {
"Instance": [
{
"CreationTime": "2015-07-27T07:08Z",
"DeviceAvailable": "true",
"EipAddress": {},
"ExpiredTime": "2011-09-08T16:00Z",
"HostName": "iZ94t3s0jxkZ",
"ImageId": "centos6u5_64_20G_aliaegis_20150130.vhd",
"InnerIpAddress": {
"IpAddress": [
"10.170.XX.XXX"
]
},
"InstanceChargeType": "PostPaid",
"InstanceId": "XXXXXXXXX",
"InstanceName": "dd\u6027\u80fd\u6d4b\u8bd5",
"InstanceNetworkType": "classic",
"InstanceType": "ecs.s2.large",
"InternetChargeType": "PayByTraffic",
"InternetMaxBandwidthIn": "-1",
"InternetMaxBandwidthOut": "1",
"IoOptimized": "false",
"OperationLocks": {
"LockReason": []
},
"PublicIpAddress": {
"IpAddress": [
"120.25.XX.XXX"
]
},
"RegionId": "cn-shenzhen",
"SecurityGroupIds": {
"SecurityGroupId": [
"sg-94kd0cyg0"
]
},
"SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e43135",
"Status": "Running",
"VpcAttributes": {
"PrivateIpAddress": {
"IpAddress": []
}
},
"ZoneId": "cn-shenzhen-a"
}
]
},
"PageNumber": "1",
"PageSize": "10",
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"TotalCount": "1"
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API錯誤中心 。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
DryRunOperation | Request validation has been passed with DryRun flag set. | 400 | 此次DryRun預檢請求合格。 |
InvalidInstanceChargeType.NotFound | The InstanceChargeType does not exist in our records. | 404 | 指定的InstanceChargeType 不存在。 |
InvalidInternetChargeType.ValueNotSupported | The specified InternetChargeType is not valid | 404 | 指定的InternetChargeType 不合法。 |
InvalidNetworkType.NotFound | The specified InstanceNetworkType is not found | 404 | 指定的InstanceNetworkType 不存在。 |
InvalidStatus.NotFound | The specified Status is not found | 404 | 指定的Status 不存在。 |
InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 400 | 指定的Tag.n.Key 和Tag.n.Value 必須鍵值匹配。 |
InvalidTagCount | The specified tags are beyond the permitted range. | 400 | 指定的標籤數不能超過五個。 |