查詢指定可用區的資源庫存狀態。該介面主要用於在建立執行個體(RunInstances)或修改執行個體規格(ModifyInstanceSpec)前,確認目標資源(如執行個體規格、系統磁碟類型)在特定可用區是否庫存充足。
介面說明
參數DestinationResource的取值有不同的邏輯與要求。在下列的順序列表中,順序越低的取值需要設定更多的參數,不支援透過低順序的取值篩選高順序的資源類別。
-
取值順序:
Zone > IoOptimized > InstanceType = Network = ddh > SystemDisk > DataDisk -
取值示例:
-
若參數
DestinationResource取值為DataDisk:-
ResourceType取值為disk表示查詢與 ECS 執行個體規格無關的資料磁碟類型,可以不傳入參數InstanceType。 -
ResourceType取值為instance表示查詢待掛載至 ECS 執行個體的資料磁碟類型,由於執行個體規格對資料磁碟有限制,所以需要同時指定InstanceType與參數DataDiskCategory。
-
-
若參數
DestinationResource取值為SystemDisk,ResourceType取值為instance,由於 ECS 執行個體規格對系統磁碟存在限制,則必須要傳入參數InstanceType。 -
若參數
DestinationResource取值為InstanceType,建議傳入參數IoOptimized和InstanceType。 -
查詢指定地域下所有可用區的 ecs.g5.large 庫存供應情況:
RegionId=cn-hangzhou &DestinationResource=InstanceType &IoOptimized=optimized &InstanceType=ecs.g5.large。 -
查詢指定地域下有 ecs.g5.large 庫存供應的可用區列表:
RegionId=cn-hangzhou &DestinationResource=Zone &IoOptimized=optimized &InstanceType=ecs.g5.large。
-
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
目標地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| InstanceChargeType |
string |
否 |
資源的計費方式。更多資訊,請參見計費概述。取值範圍:
預設值:PostPaid。 |
PrePaid |
| SpotStrategy |
string |
否 |
隨用隨付執行個體的競價策略。取值範圍:
預設值:NoSpot。 當參數 |
NoSpot |
| SpotDuration |
integer |
否 |
搶佔式執行個體的保留時長,單位為小時。 預設值:1。取值範圍:
執行個體回收前 5 分鐘阿里雲會透過 ECS 系統事件向您傳送通知。搶佔式執行個體按秒計費,建議您結合具體任務執行耗時來選擇合適的保留時長。 說明
當 |
1 |
| DestinationResource |
string |
是 |
要查詢的資源類型。取值範圍:
說明
當 DestinationResource 取值為 參數 DestinationResource 的取值方式請參見本文中的介面說明。 |
InstanceType |
| ZoneId |
string |
否 |
可用區 ID。 預設值:無。返回該地域( |
cn-hangzhou-e |
| IoOptimized |
string |
否 |
是否為 I/O 優化執行個體。取值範圍:
預設值:optimized。 |
optimized |
| DedicatedHostId |
string |
否 |
專有宿主機 ID。 |
dh-bp165p6xk2tlw61e**** |
| InstanceType |
string |
否 |
執行個體規格。更多資訊,請參見執行個體規格族,您也可以呼叫 DescribeInstanceTypes 介面獲得最新的規格表。 參數 InstanceType 的取值方式請參見本文開頭的介面說明。 |
ecs.g5.large |
| SystemDiskCategory |
string |
否 |
系統磁碟類型。取值範圍:
參數預設值說明:
說明
參數 ResourceType 取值為 instance、DestinationResource 取值為 DataDisk 時,參數 SystemDiskCategory 是必選參數。如果未傳遞參數值,則以預設值生效。 |
cloud_ssd |
| DataDiskCategory |
string |
否 |
資料磁碟類型。取值範圍:
|
cloud_ssd |
| NetworkCategory |
string |
否 |
網路類型。取值範圍:
|
vpc |
| Cores |
integer |
否 |
執行個體規格的 vCPU 核心數目。取值參見執行個體規格族。 當 DestinationResource 取值為 InstanceType 時,Cores 才為有效參數。 |
2 |
| Memory |
number |
否 |
執行個體規格的記憶體大小,單位為 GiB。取值參見執行個體規格族。 當 DestinationResource 取值為 InstanceType 時,Memory 才為有效參數。 |
8.0 |
| ResourceType |
string |
否 |
資源類型。取值範圍:
|
instance |
| Scope |
string |
否 |
預留執行個體券的範圍。取值範圍:
|
Region |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
0041D94C-FB92-4C49-B115-259DA1C***** |
| AvailableZones |
object |
||
| AvailableZone |
array<object> |
可用區庫存資訊的集合。 |
|
|
array<object> |
可用區庫存資訊。 |
||
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-e |
| Status |
string |
可用性區域的狀態原因。可能值:
|
Available |
| StatusCategory |
string |
根據可用性區域下庫存情況對可用性區域狀態進行詳細描述。可能值:
|
WithStock |
| RegionId |
string |
地區 ID。 |
cn-hangzhou |
| AvailableResources |
object |
||
| AvailableResource |
array<object> |
可供建立的具體資源群組成的數組。 |
|
|
array<object> |
可供建立的具體資源集合。 |
||
| Type |
string |
資源類型。可能值:
|
InstanceType |
| SupportedResources |
object |
||
| SupportedResource |
array<object> |
支援的可供建立的具體資源群組成的數組。 |
|
|
object |
支援的可供建立的具體資源資訊。 |
||
| Status |
string |
具體資源類型的狀態原因。可能值:
|
Available |
| Value |
string |
資源值。 |
ecs.d1ne.xlarge |
| Max |
integer |
雲端硬碟容量範圍的最大值。 說明
僅當入參 DestinationResource 取值為 |
2048 |
| Unit |
string |
雲端硬碟容量的單位。 說明
僅當入參 DestinationResource 取值為 |
GiB |
| StatusCategory |
string |
根據庫存情況對資源狀態進行詳細描述。可能值:
|
WithStock |
| Min |
integer |
雲端硬碟容量範圍的最小值。 說明
僅當入參 DestinationResource 取值為 |
20 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "0041D94C-FB92-4C49-B115-259DA1C*****",
"AvailableZones": {
"AvailableZone": [
{
"ZoneId": "cn-hangzhou-e",
"Status": "Available",
"StatusCategory": "WithStock",
"RegionId": "cn-hangzhou",
"AvailableResources": {
"AvailableResource": [
{
"Type": "InstanceType",
"SupportedResources": {
"SupportedResource": [
{
"Status": "Available",
"Value": "ecs.d1ne.xlarge",
"Max": 2048,
"Unit": "GiB",
"StatusCategory": "WithStock",
"Min": 20
}
]
}
}
]
}
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Invalid.InstanceChargeType | The specified InstanceChargeType is not valid. | |
| 400 | Invalid.Param | The input parameter DestinationResource that is mandatory for processing this request is not supplied. | |
| 400 | InvalidRegionId.MalFormed | The specified parameter RegionId is not valid. | |
| 403 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist. | |
| 403 | InvalidParam.TypeAndCpuMem.Conflict | The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time. | |
| 403 | InvalidParam.Cores | The specified parameter 'Cores' should be empty. | |
| 403 | InvalidParam.Memory | The specified parameter 'Memory' should be empty. | |
| 403 | InvalidParameter.Scope | The specified parameter Scope is invalid. | |
| 403 | OperationDenied.RegionIdNotSupported | The region does not support preemptible instances. | |
| 403 | OperationDenied.FlavorNotSupported | The flavor does not support preemptible instances. | |
| 403 | OperationDenied.TimestampNotSupported | Preemptible instances are not for sale for current time. | |
| 403 | InvalidParameter.ResourceOwnerId | The specified parameter ResourceOwnerId is not available anymore. | |
| 404 | Invalid.RegionId | The specified RegionId does not exist. | |
| 404 | Unavailable.Regions | The available region does not exist. | |
| 404 | Invalid.ResourceType | The ResourceType provided does not exist in our records. | |
| 404 | Invalid.DestinationResource | The specified DestinationResource is not valid. | |
| 404 | Invalid.IoOptimized | The specified IoOptimized is not valid. | |
| 404 | Invalid.NetworkCategory | The specified NetworkCategory is not valid. | |
| 404 | Invalid.SpotStrategy | The specified SpotStrategy is not valid. | |
| 404 | Invalid.NetworkType | The specified NetworkType is not valid. | |
| 404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records. | |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | |
| 404 | InvalidDedicatedHostId.NotFound | The specified Dedicated Host does not exist. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。