589
windows
查詢實例列表__實例相關接口_API 參考_雲服務器 ECS-阿裏雲
描述
查詢所有實例的詳細信息。
此接口不會校驗參數之間的依賴關係,返回結果是所有條件的"交集"。
如果參數為空,則過濾器不起作用,但是 InstanceIds 如果是一個空 Json Array(即[]),則視為該過濾器有效,且返回空。
請求參數
名稱 | 類型 | 是否必須 | 描述 |
---|---|---|---|
Action | String | 是 | 係統規定參數,取值:DescribeInstances |
RegionId | String | 是 | 地域 |
VpcId | String | 否 | 專有網絡 Id |
VSwitchId | String | 否 | 交換機 Id |
ZoneId | String | 否 | 可用區 Id |
InstanceIds | String | 否 |
實例的編號列表 一個帶有格式的 Json Array:[“i-xxxxxxxxx”, ”i-yyyyyyyyy”, … “i-zzzzzzzzz”],最多 100 個 Id,用半角逗號字符隔開。 |
InstanceType | String | 否 | 實例的規格 |
InstanceTypeFamily | String | 否 | 實例的規格族 |
InstanceNetworkType | String | 否 | 實例網絡類型 |
PrivateIpAddresses | String | 否 |
VPC 類型實例的私網 IP 列表. 當 NetworkType 為 VPC 時,這個參數生效. 一個帶有格式的 Json Array:[“172.16.1.1”, ”172.16.2.1”, … “172.16.10.1”],最多 100 個 IP,用半角逗號字符隔開。 |
InnerIpAddresses | String | 否 |
Classic 類型實例的私網 IP 列表. 當 NetworkType 為 Classic 時,這個參數生效. 一個帶有格式的 Json Array:[“10.1.1.1”, ”10.1.2.1”, … “10.1.10.1”],最多 100 個 IP,用半角逗號字符隔開。 |
PublicIpAddresses | String | 否 |
Classic 類型實例的公網 IP 列表. 當 NetworkType 為 Classic 時,這個參數生效. 一個帶有格式的 Json Array:[“42.1.1.1”, ”42.1.2.1”, … “42.1.10.1”],最多 100 個 IP,用半角逗號字符隔開。 |
SecurityGroupId | String | 否 | 實例所屬的安全組 |
InstanceChargeType | String | 否 |
實例的付費方式。
|
InternetChargeType | String | 否 | 網絡計費類型,PayByBandwidth | PayByTraffic兩個值中的一個。預付費實例顯示PayByBandwidth(按帶寬計費)。
|
InstanceName | String | 否 | 實例名稱 |
ImageId | String | 否 | 鏡像 ID |
Status | String | 否 |
實例狀態,可選值:
|
DeviceAvailable | String | 否 |
實例是否還可以掛載磁盤。 True | False |
IoOptimized | String | 否 |
是否是 IO 優化型實例 True | False |
Tag.n.Key | String | 否 |
標簽 key,n 從 1 開始,最大為 5。 不允許為空字符串。 |
Tag.n.Value | String | 否 |
標簽 value,n 從 1 開始,最大為 5。 允許為空字符串。 |
PageNumber | Integer | 否 | 實例狀態列表的頁碼,起始值為 1,默認值為 1 |
PageSize | Integer | 否 | 分頁查詢時設置的每頁行數,最大值 100 行,默認為 10 |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
TotalCount | Integer | 實例總個數 |
PageNumber | Integer | 實例列表的頁碼 |
PageSize | Integer | 輸入時設置的每頁行數 |
Instances | InstanceAttributesType | 由 InstanceAttributesType 組成的數組格式,返回實例的信息 |
錯誤碼
錯誤代碼 | 描述 | Http狀態碼 | 語義 |
---|---|---|---|
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 不存在 |
示例
請求示例
https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共請求參數>
返回示例
XML
格式
<DescribeInstancesResponse>
<CreationTime>2014-09-21T01:12:35Z</CreationTime>
<DeviceAvailable>true</DeviceAvailable>
<Description></Description>
<EipAddress>
<AllocationId></AllocationId>
<InternetChargeType></InternetChargeType>
<IpAddress></IpAddress>
</EipAddress>
<ExpiredTime>2011-09-08T16:00Z</ExpiredTime>
<HostName>iZ25skktcp4Z</HostName>
<ImageId>ubuntu1404_64_20G_aliaegis_20140703.vhd</ImageId>
<InnerIpAddress></InnerIpAddress>
<InstanceChargeType>PostPaid</InstanceChargeType>
<IpAddress></IpAddress>
<InstanceId>i-25skktcp4</InstanceId>
<InstanceName>iZ25skktcp4Z</InstanceName>
<InstanceNetworkType>vpc</InstanceNetworkType>
<InstanceType>ecs.t1.xsmall</InstanceType>
<InternetChargeType></InternetChargeType>
<InternetMaxBandwidthIn>-1</InternetMaxBandwidthIn>
<InternetMaxBandwidthOut></InternetMaxBandwidthOut>
<IoOptimized>false</IoOptimized>
<OperationLocks>
<LockReason></LockReason>
</OperationLocks>
<PublicIpAddress>
<IpAddress></IpAddress>
</PublicIpAddress>
<RegionId>cn-beijing</RegionId>
<SecurityGroupIds>
<SecurityGroupId>sg-25am0n4q0</SecurityGroupId>
</SecurityGroupIds>
<SerialNumber>51d1353b-22bf-4567-a176-8b3e12e43135</SerialNumber>
<Status>Running</Status>
<VlanId></VlanId>
<VpcAttributes>
<NatIpAddress>10.175.68.212</NatIpAddress>
<PrivateIpAddress>
<IpAddress>192.168.2.3</IpAddress>
</PrivateIpAddress>
<VSwitchId>vsw-25gbsqby3</VSwitchId>
<VpcId>vpc-25onv3oi4</VpcId>
</VpcAttributes>
<ZoneId>cn-beijing-a</ZoneId>
</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.106.80"
]
},
"InstanceChargeType": "PostPaid",
"InstanceId": "i-94t3s0jxk",
"InstanceName": "ddu6027u80fdu6d4bu8bd5",
"InstanceNetworkType": "classic",
"InstanceType": "ecs.s2.large",
"InternetChargeType": "PayByTraffic",
"InternetMaxBandwidthIn": -1,
"InternetMaxBandwidthOut": 1,
"IoOptimized": false,
"OperationLocks": {
"LockReason": []
},
"PublicIpAddress": {
"IpAddress": [
"120.25.13.106"
]
},
"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
}
最後更新:2016-11-23 16:03:50
上一篇:
查詢實例狀態__實例相關接口_API 參考_雲服務器 ECS-阿裏雲
下一篇:
刪除實例__實例相關接口_API 參考_雲服務器 ECS-阿裏雲
修改服務器信息__服務器管理_快速入門_數據管理-阿裏雲
AutoSnapshotExecutionStatusType__數據類型_API 參考_雲服務器 ECS-阿裏雲
如何查看代金券?___代金券_代金券及推薦碼_財務-阿裏雲
查詢執行計劃實例__執行計劃_API參考_E-MapReduce-阿裏雲
連接OceanBase實例__快速入門_雲數據庫 OceanBase-阿裏雲
ClusterMetrics__數據類型_API文檔_批量計算-阿裏雲
阿裏雲棲大會明日開幕,9月重卡銷量再增89%
ALIYUN::ECS::Instance__資源列表_資源編排-阿裏雲
收費方式與價格__購買指導_批量計算-阿裏雲
查詢專有網絡列表__專有網絡相關接口_API 參考_雲服務器 ECS-阿裏雲
相關內容
常見錯誤說明__附錄_大數據計算服務-阿裏雲
發送短信接口__API使用手冊_短信服務-阿裏雲
接口文檔__Android_安全組件教程_移動安全-阿裏雲
運營商錯誤碼(聯通)__常見問題_短信服務-阿裏雲
設置短信模板__使用手冊_短信服務-阿裏雲
OSS 權限問題及排查__常見錯誤及排除_最佳實踐_對象存儲 OSS-阿裏雲
消息通知__操作指南_批量計算-阿裏雲
設備端快速接入(MQTT)__快速開始_阿裏雲物聯網套件-阿裏雲
查詢API調用流量數據__API管理相關接口_API_API 網關-阿裏雲
使用STS訪問__JavaScript-SDK_SDK 參考_對象存儲 OSS-阿裏雲