查詢某一可用性區域的資源清單。例如,您可以在某一可用性區域建立執行個體(RunInstances)時查詢該可用性區域的資源清單。

描述

調用該介面時,您需要注意:
  • 不指定參數 ZoneId 時,返回該地域(RegionId)下所有可用性區域的符合其他條件的目標資源。
  • 您可以通過指定參數 DestinationResource 查詢不同類型的資源清單,再指定其他參數細化資源條件。參數 DestinationResource 的各個可選取值有不同的邏輯與(&&)要求。在下列兩個順序列表中,排在越後面的參數其邏輯與(&&)苛刻程度越高。
    • 順序:(Zone)> IoOptimized > InstanceType > SystemDisk > DataDisk
    • 取值樣本
      • 若參數 DestinationResource 取值為 SystemDisk,則必須傳入參數 IoOptimizedInstanceType
      • 若參數 DestinationResource 取值為 InstanceType,則必須傳入參數 IoOptimized
      • 若參數 DestinationResource 取值為 DataDisk,則必須傳入參數 IoOptimizedInstanceTypeSystemDiskCategory

請求參數

名稱 類型 是否必需 描述
Action String 系統規定參數。取值:DescribeAvailableResource
RegionId String 目標地域 ID。您可以調用DescribeRegions查看最新的阿里雲地域列表。
DestinationResource String 要查詢的資源類型。取值範圍:
  • Zone:可用性區域
  • IoOptimized:I/O 優化
  • InstanceType:執行個體規格
  • SystemDisk:系統盤
  • DataDisk:資料盤
  • Network:網路類型
ZoneId String 可用性區域 ID,不傳入參數 ZoneId 則表示隨機分配當前地域下的可用性區域。
InstanceChargeType String 資源的計費方式。更多詳情,請參閱 計費概述。取值範圍:
  • PrePaid:預付費(訂用帳戶)
  • PostPaid:隨用隨付
預設值:PostPaid
SpotStrategy String 隨用隨付執行個體的競價策略。取值範圍:
  • NoSpot:正常隨用隨付執行個體
  • SpotWithPriceLimit:設定上限價格的搶佔式執行個體
  • SpotAsPriceGo:系統自動出價,最高隨用隨付價格
預設值:NoSpot 當參數 InstanceChargeType 取值為 PostPaid 時,參數 SpotStrategy 才有效。
IoOptimized String 是否為 I/O 優化執行個體。取值範圍:
  • none:非 I/O 優化執行個體
  • optimized:I/O 優化執行個體
當參數 DestinationResource 取值為 InstanceTypeSystemDisk 或者 DataDisk時,IoOptimized 為必需參數。
InstanceType String 執行個體規格。更多詳情,請參閱 執行個體規格類型系列,也可以調用 DescribeInstanceTypes介面獲得最新的規格表。當參數 DestinationResource 取值為 SystemDisk 或者 DataDisk 時,InstanceType 為必需參數。
Cores Integer 執行個體規格的vCPU核心數目。取值參閱 執行個體規格類型系列。當 DestinationResource=InstanceType 參數有效,Cores 才為有效參數。
Memory Integer 執行個體規格的記憶體大小,單位為GiB。取值參閱 執行個體規格類型系列。當 DestinationResource=InstanceTypeMemory 才為有效參數。
SystemDiskCategory String 系統盤類型。取值範圍:
  • cloud:普通雲端碟
  • cloud_efficiency:高效雲端碟
  • cloud_ssd:SSD 雲端碟
  • ephemeral_ssd:本地 SSD 盤
DataDiskCategory String 資料盤類型。取值範圍:
  • cloud:普通雲端碟
  • cloud_efficiency:高效雲端碟
  • cloud_ssd:SSD 雲端碟
  • ephemeral_ssd:本地 SSD 盤
NetworkCategory String 網路類型。取值範圍:
  • vpc:專有網路
  • classic:經典網路

返回參數

名稱 類型 描述
AvailableZones Array of AvailableZoneType 資料中心資訊組成的集合
AvailableZoneType
名稱 類型 描述
RegionId String 地域 ID
ZoneId String 可用性區域 ID
Status String 資源狀態。傳回值:
  • Available:資源充足
  • SoldOut:資源已售罄
AvailableResources Array of AvailableResourcesType 可供建立的具體資源群組成的數組
AvailableResourcesType
名稱 類型 描述
Type String 資源類型。傳回值:
  • Zone:可用性區域
  • IoOptimized:I/O 優化
  • InstanceType:執行個體規格
  • SystemDisk:系統盤
  • DataDisk:資料盤
  • Network:網路類型
SupportedResources Array of \SupportedResourcesType 支援的可供建立的具體資源群組成的數組
SupportedResourcesType
名稱 類型 描述
Value String 資源值
Status String 資源類型。傳回值:
  • Available:資源充足
  • SoldOut:資源已售罄
Min Integer 資源規格的最小值,該參數值為空時將不返回
Max Integer 資源規格的最大值,該參數值為空時將不返回
Unit Integer 資源規格單位,該參數值為空時將不返回

樣本

請求樣本
https://ecs.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&DestinationResource=InstanceType
&<公共請求參數>
返回樣本

XML 格式

<DescribeAvailableResourceResponse>
    <AvailableZones>
        <AvailableZone>
            <ZoneId>cn-hangzhou-d</ZoneId>
            <RegionId>cn-hangzhou</RegionId>
            <Status>Available</Status>
            <AvailableResources>
                <AvailableResource>
                    <Type>instanceType</Type>
                    <SupportedResources>
                        <SupportedResource>
                            <Value>ecs.d1ne.xlarge</Value>
                            <Status>Available</Status>
                        </SupportedResource>
                        <SupportedResource>
                            <Value>ecs.d1ne.2xlarge</Value>
                            <Status>Available</Status>
                        </SupportedResource>
                    </SupportedResources>
                </AvailableResource>
            </AvailableResources>
        </AvailableZone>
        <AvailableZone>
            <ZoneId>cn-hangzhou-e</ZoneId>
            <RegionId>cn-hangzhou</RegionId>
            <Status>Available</Status>
            <AvailableResources>
                <AvailableResource>
                    <Type>instanceType</Type>
                    <SupportedResources>
                        <SupportedResource>
                            <Value>ecs.d1ne.xlarge</Value>
                            <Status>Available</Status>
                        </SupportedResource>
                         <SupportedResource>
                            <Value>ecs.d1ne.2xlarge</Value>
                            <Status>Available</Status>
                        </SupportedResource>
                    </SupportedResources>
                </AvailableResource>
            </AvailableResources>
        </AvailableZone>
    </AvailableZones>
    <RequestId>6DB97BCC-92BA-424D-A7C8-3F6486612BAE</RequestId>
</DescribeAvailableResourceResponse>
JSON 格式
{
    "RequestId": "D0233A65-7F00-4B50-8023-101427229D4F",
    "AvailableZones": {
        "AvailableZone": [
            {
                "Status": "available",
                "RegionId": "cn-hangzhou",
                "AvailableResources": {
                    "AvailableResource": [
                        {
                            "Type": "instanceType",
                            "SupportedResources": {
                                "SupportedResource": [
                                    {
                                        "Status": "available",
                                        "Value": "ecs.sn1ne.xlarge"
                                    },
                                    {
                                        "Status": "available",
                                        "Value": "ecs.sn2ne.xlarge"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "ZoneId": "cn-hangzhou-e",
            }
        ]
    }
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API錯誤中心

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
Invalid.Param The input parameter DestinationResource that is mandatory for processing this request is not supplied. 400 您必須指定必需參數 DestinationResource
Invalid.InstanceChargeType The specified InstanceChargeType is not valid. 400 指定的 InstanceChargeType 不存在。
InvalidParam.Cores The specified parameter 'Cores' should be empty 403 DestinationResource=InstanceTypeCores 才為有效參數。
InvalidParam.Memory The specified parameter 'Memory' should be empty 403 DestinationResource=InstanceTypeMemory 才為有效參數。
InvalidParam.TypeAndCpuMem.Conflict The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time. 403 DestinationResource=InstanceTypeCoresMemory 才為有效參數。
Invalid.IoOptimized The specified IoOptimized is not valid. 404 I/O 優化參數 IoOptimized 不合法。
Invalid.DestinationResource The specified DestinationResource is not valid 404 指定的 DestinationResource 不存在。
Invalid.SpotStrategy The specified SpotStrategy is not valid. 404 指定的 SpotStrategy 不存在。
Invalid.NetworkCategory The specified NetworkCategory is not valid. 404 網路型別參數不合法。
InvalidRegionId.NotFound The specified RegionId does not exist. 404 指定的 RegionId 不存在。
Unavailable.Regions The available regions does not exists. 404 您暫時無法使用指定的 RegionId 裡的資源。