この操作を呼び出して、ゾーン内のリソースを照会できます。 たとえば、ゾーンで ECS インスタンスを作成 (RunInstances)、 またはインスタンスタイプを変更 (ModifyInstanceSpec) する前に、リソースを照会できます。

説明

この操作を呼び出すときは、次のことに注意してください。

  • ZoneId パラメーターが指定されていない場合、システムは、リージョン内のすべてのゾーンの他の基準に一致するリソースを返します。
  • DestinationResource パラメーターを指定してさまざまなタイプのリソースを取得し、他のパラメーターを指定して検索を絞り込むことができます。 DestinationResource パラメーターのオプションには依存関係があります。 以下のようにオプションを選択する場合、このオプションの左側のオプションはすべて必須です。
    • 順番: (Zone) > IoOptimized > InstanceType > SystemDisk > DataDisk
    • 例:
      • DestinationResource パラメーターを SystemDisk に設定する場合、IoOptimized および InstanceType パラメーターを指定する必要があります。
      • DestinationResource パラメーターを InstanceType に設定する場合、IoOptimized パラメーターを指定する必要があります。
      • DestinationResource パラメーターを DataDisk に設定する場合、IoOptimized、InstanceType、および SystemDiskCategory パラメーターを指定する必要があります。

デバッグ

API の使用を簡単にするため、Alibaba Cloud では、OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、および SDK サンプルコードの動的な生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
DestinationResource String 必須 InstanceType

照会するリソースタイプ。 有効な値:

  • Zone
  • IoOptimized
  • InstanceType
  • SystemDisk
  • DataDisk
  • Network
RegionId String 必須 cn-hangzhou

リソースを照会するリージョンの ID。 最新のリージョン一覧は、DescribeRegions 操作を呼び出して照会できます。

Action String 任意 DescribeAvailableResource

実行する操作。 HTTP および HTTPS メソッドを使用した API リクエストの場合、Action が必要です。 値を DescribeAvailableResource に設定します。

Cores Integer 任意 2

インスタンスタイプの vCPU コアの数。 詳細については、「インスタンスタイプファミリー」をご参照ください。

Cores パラメーターは、DestinationResource パラメーターが InstanceType に設定されている場合にのみ有効です。

DataDiskCategory String 任意 cloud_ssd

システムディスクのカテゴリ。 有効な値:

  • cloud: ベーシックディスク
  • cloud_efficiency: ウルトラディスク
  • cloud_ssd: スタンダード SSD
  • ephemeral_ssd: ローカル SSD
  • cloud_essd: Enhanced SSD (ESSD)
DedicatedHostId String 任意 dh-dedicatedhostid

DDH の ID。

InstanceChargeType String 任意 PrePaid

リソースの課金方法。 詳細については、 「料金の概要」をご参照ください。 有効な値:

  • PrePaid: サブスクリプション
  • PostPaid:従量課金

デフォルト値:PostPaid

InstanceType String 任意 ecs.g5.large

インスタンスのタイプ。 詳細については、「 インスタンスタイプファミリー」をご参照ください。あるいは、DescribeInstanceTypes 操作を呼び出して、最新のインスタンスタイプ一覧を照会してください。

DestinationResource パラメーターが SystemDisk または DataDisk に設定されている場合、InstanceType パラメーターが必要です。

IoOptimized String 任意 optimized

インスタンスが I/O 最適化されているかどうかを示します。 有効な値:

  • none
  • optimized

DestinationResource パラメーターが InstanceType、SystemDisk、または DataDisk に設定されている場合、IoOptimized パラメーターが必要です。 デフォルト値:optimized。

Memory Float 任意 8.0

インスタンスタイプのメモリサイズ。 単位: GiB 詳細については、「インスタンスタイプファミリー」をご参照ください。

Memory パラメーターは、DestinationResource パラメーターが InstanceType に設定されている場合にのみ有効です。

NetworkCategory String 任意 vpc

ネットワークのタイプ。 有効な値:

  • vpc
  • classic
ResourceType String 任意 インスタンス

リソースのタイプ 。 有効な値:

  • instance
  • disk
  • reservedinstance
  • ddh
SpotStrategy String 任意 NoSpot

従量課金制インスタンスの入札ポリシー。 有効な値:

  • NoSpot:従量課金インスタンス
  • SpotWithPriceLimit:最高価格のプリエンプティブルインスタンス
  • SpotAsPriceGo:従量課金インスタンスの価格を最大値としてシステムが自動的に提供する価格

デフォルト値:NoSpot

SpotStrategy パラメーターは、InstanceChargeType パラメーターが PostPaid に設定されている場合にのみ有効です。

SystemDiskCategory String 任意 cloud_ssd

システムディスクのカテゴリ。 有効な値:

  • cloud
  • cloud_efficiency: ウルトラディスク
  • cloud_ssd: スタンダード SSD
  • ephemeral_ssd: ローカル SSD
  • cloud_essd:Enhanced SSD

DestinationResource パラメーターが SystemDisk、InstanceType、または DataDisk に設定されている場合、SystemDiskCategory パラメーターはオプションです。 デフォルト値:cloud_efficiency。

ZoneId String 任意 cn-hangzhou-e

リソースを照会するゾーンの ID。

ZoneId パラメーターが指定されていない場合、システムは、リージョン内のすべてのゾーンの他の基準に一致するリソースを返します。

レスポンスパラメーター

パラメーター データ型 説明
AvailableZones

ゾーンタイプの配列。

└AvailableResources

利用可能なリソースタイプの配列。

└SupportedResources

サポートされているリソースタイプの配列。

└Max Integer 2

作成できる特定のタイプのリソースの最大数。 このパラメーターが null の場合、値は返されません。

└Min Integer 1

作成できる特定のタイプのリソースの最小値。 パラメーターが null の場合、値は返されません。

└Status String Available

リソースの タイプ 。 有効な値:

  • Available
  • SoldOut
└StatusCategory String WithStock

在庫に基づくリソースカテゴリ。 有効な値:

  • WithStock:十分な在庫
  • ClosedWithStock:在庫不足
  • WithoutStock:在庫切れ
└Unit String null

リソースタイプの単位。 パラメーターが null の場合、値は返されません。

└Value String ecs.d1ne.xlarge

リソースの値。

└Type String InstanceType

リソースのタイプ 。 有効な値:

  • Zone
  • IoOptimized
  • InstanceType
  • SystemDisk
  • DataDisk
  • Network
└RegionId String cn-hangzhou

リージョンの ID。

└Status String Available

リソースの タイプ 。 有効な値:

  • Available
  • SoldOut
└StatusCategory String WithStock

在庫に基づくリソースカテゴリ。 有効な値:

  • WithStock:十分な在庫
  • ClosedWithStock:在庫不足
  • WithoutStock:在庫切れ
└ZoneId String cn-hangzhou-e

ゾーンの ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID。

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeAvailableResource
&DestinationResource=InstanceType
&RegionId=cn-hangzhou
&InstanceChargeType=PrePaid
&SpotStrategy=NoSpot
&ZoneId=cn-hangzhou-e
&IoOptimized=optimized
&DedicatedHostId=dh-dedicatedhostid
&InstanceType="ecs.g5.large"
&SystemDiskCategory=cloud_ssd
&DataDiskCategory=cloud_ssd
&NetworkCategory=vpc
&Cores=2
&Memory=8.0
&ResourceType=Instance
&<Common request parameters>

レスポンスの成功例

XML 形式

<DescribeAvailableResourceResponse>
  <RequestId>5272B7D8-F366-4781-AF7B-63E735FBC09A</RequestId>
  <AvailableZones>
    <AvailableZone>
      <Status>Available</Status>
      <RegionId>cn-hangzhou</RegionId>
      <ZoneId>cn-hangzhou-h</ZoneId>
    </AvailableZone>
    <AvailableZone>
      <Status>Available</Status>
      <RegionId>cn-hangzhou</RegionId>
      <ZoneId>cn-hangzhou-g</ZoneId>
    </AvailableZone>
    <AvailableZone>
      <Status>Available</Status>
      <RegionId>cn-hangzhou</RegionId>
      <ZoneId>cn-hangzhou-f</ZoneId>
    </AvailableZone>
    <AvailableZone>
      <Status>Available</Status>
      <RegionId>cn-hangzhou</RegionId>
      <ZoneId>cn-hangzhou-b</ZoneId>
    </AvailableZone>
    <AvailableZone>
      <Status>Available</Status>
      <RegionId>cn-hangzhou</RegionId>
      <ZoneId>cn-hangzhou-e</ZoneId>
    </AvailableZone>
  </AvailableZones>
</DescribeAvailableResourceResponse>

JSON 形式

{
	"RequestId":"5272B7D8-F366-4781-AF7B-63E735FBC09A",
	"AvailableZones":{
		"AvailableZone":[
			{
				"Status":"Available",
				"RegionId":"cn-hangzhou",
				"ZoneId":"cn-hangzhou-h"
			},
			{
				"Status":"Available",
				"RegionId":"cn-hangzhou",
				"ZoneId":"cn-hangzhou-g"
			},
			{
				"Status":"Available",
				"RegionId":"cn-hangzhou",
				"ZoneId":"cn-hangzhou-f"
			},
			{
				"Status":"Available",
				"RegionId":"cn-hangzhou",
				"ZoneId":"cn-hangzhou-b"
			},
			{
				"Status":"Available",
				"RegionId":"cn-hangzhou",
				"ZoneId":"cn-hangzhou-e"
			}
		]
	}
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 Invalid.RegionId The specified RegionId does not exist. 指定された RegionId パラメーターが無効の場合に返されるエラーメッセージ。
404 Unavailable.Regions The available regions does not exists 指定された RegionId パラメーターが無効の場合に返されるエラーメッセージ。
400 Invalid.InstanceChargeType The specified InstanceChargeType is not valid. 指定された InstanceChargeType パラメーターが無効の場合に返されるエラーメッセージ。
400 Invalid.Param The input parameter DestinationResource that is mandatory for processing this request is not supplied. 指定された DestinationResource パラメーターが無効の場合に返されるエラーメッセージ。
404 Invalid.ResourceType The ResourceType provided does not exist in our records. 指定された ResourceType パラメーターが無効の場合に返されるエラーメッセージ。
404 Invalid.DestinationResource The specified DestinationResource is not valid. 指定された DestinationResource パラメーターが無効の場合に返されるエラーメッセージ。
404 Invalid.IoOptimized The specified IoOptimized is not valid. 指定された IoOptimized パラメーターが無効の場合に返されるエラーメッセージ。
404 Invalid.NetworkCategory The specified NetworkCategory is not valid. 指定された NetworkCategory パラメーターが無効の場合に返されるエラーメッセージ。
404 Invalid.SpotStrategy The specified SpotStrategy is not valid. 指定された SpotStrategy パラメーターが無効の場合に返されるエラーメッセージ。
403 InvalidDedicatedHostId.NotFound The specified DedicatedHostId does not exist. 指定された DDH ID が存在しない場合に返されるエラーメッセージ。
404 Invalid.NetworkType The specified NetworkType is not valid. 指定された NetworkType パラメーターが無効の場合に返されるエラーメッセージ。
404 InvalidResourceId.NotFound The specified ResourceId is not found in our records 指定された ResourceId パラメーターが無効の場合に返されるエラーメッセージ。
403 InvalidParam.TypeAndCpuMem.Conflict The specified 'InstanceType' and 'Cores','Memory' are not blank at the same time. 指定された InstanceType、Cores、および Memory パラメーターが互いに競合する場合に返されるエラーメッセージ。
403 InvalidParam.Cores The specified parameter 'Cores' should be empty 指定された Cores パラメーターが無効の場合に返されるエラーメッセージ。
403 InvalidParam.Memory The specified parameter 'Memory' should be empty 指定された Memory パラメーターが無効の場合に返されるエラーメッセージ。
400 InvalidRegionId.MalFormed The specified parameter RegionId is not valid. 指定された RegionId パラメーターが無効の場合に返されるエラーメッセージ。

エラーコードの表示