DescribeCapacityReservations - - Alibaba Cloud ドキュメントセンター

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須／任意	例	説明
操作	String	必須	DescribeCapacityReservations	実行する操作です。値をDescribeCapacityReservationsに設定します。
RegionId	String	必須	cn-hangzhou	容量予約のリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
ResourceGroupId	String	任意	rg-bp67acfmxazb4p****	容量予約が属するリソースグループのID。
MaxResults	Integer	任意	10	返されるページ毎のエントリ数を設定します。最大値：100。 Default value: 10.
NextToken	String	任意	caeba0bbb2be03f84eb48b699f0a4883	次のクエリの開始に使用されるトークン。前回のリクエストに対するレスポンスから取得したNextTokenの値を設定します。
PrivatePoolOptions.Ids	String	任意	["crp-bp1gubrkqutenqdd **" 、"crp-bp67acfmxazb5 **"]	容量予約のID。この値は、最大100個の容量予約IDで構成されるJSON配列にすることができます。 IDはコンマ (,) で区切ります。
プラットフォーム	String	任意	linux	容量予約を使用して作成されるインスタンスのオペレーティングシステムタイプ。設定可能な値は以下のとおりです。 Windows: Windowsインスタンスの容量予約のみが照会されます。 Linux: Linuxインスタンスの容量予約のみが照会されます。 all: すべての容量予約が照会されます。デフォルト値: all。
InstanceType	String	任意	ecs.c6.large	インスタンスタイプです。
ZoneId	String	任意	cn-hangzhou-h	容量予約のゾーンID。
InstanceChargeType	String	任意	PostPaid	容量予約を使用して作成されるインスタンスの課金方法。設定可能な値は以下のとおりです。 PostPaid ：従量課金 PrePaid：サブスクリプションデフォルト値：PostPaid。
ステータス	String	任意	Active	The state of the capacity reservation. 設定可能な値は以下のとおりです。すべて: すべての州。保留中: 容量予約は初期化中です。スケジュールされた容量予約は、作成後に保留状態に入ります。 Preparing: The capacity reservation is being prepared. リソースが配信されている間、スケジュールされた容量予約は準備状態にあります。準備: 容量の予約が有効になります。リソースが配信された後、スケジュールされた容量予約は有効になるまで準備済み状態のままです。アクティブ: 容量予約が有効です。リリース: 有効期限が切れたときに容量予約が手動または自動でリリースされました。デフォルト値: Active。
Tag.N.Key	String	任意	TestKey	容量予約のタグNのキー。 N の有効値：1 ～ 20。リソースを照会するタグが1つ指定されている場合、このタグが追加されたリソースを最大1,000個まで応答に表示できます。リソースのクエリに複数のタグが指定されている場合、これらすべてのタグが追加された最大1,000個のリソースを応答に表示できます。指定されたタグが追加された1,000を超えるリソースをクエリするには、ListTagResources操作を呼び出します。
Tag.N.Value	String	任意	TestValue	容量予約のタグNの値。 N の有効値：1 ～ 20。

レスポンスパラメーター


パラメーター	データ型	例	説明
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	次のクエリの開始に使用されるトークン。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	リクエストの ID です。
TotalCount	Integer	1	返されたエントリの総数。
MaxResults	Integer	10	1ページあたりに返されるエントリの最大数。
CapacityReservationSet	CapacityReservationItemの配列		容量予約に関する詳細。
CapacityReservationItem
ステータス	String	Active	容量予約の状態。設定可能な値は以下のとおりです。保留中: 容量予約は初期化中です。準備: 容量予約の準備中です。準備: 容量の予約が有効になります。アクティブ: 容量予約が有効です。リリース: 有効期限が切れたときに容量予約が手動または自動でリリースされました。
TimeSlot	String	null	注 This parameter is currently in invitational preview and unavailable for general users.
PrivatePoolOptionsMatchCriteria	String	オープン	容量予約に関連付けられているプライベートプールのタイプ。設定可能な値は以下のとおりです。オープン: オープンプライベートプールターゲット: 対象プライベートプール
PrivatePoolOptionsId	String	crp-bp1gubrkqutenqdd ****	容量予約の ID。
PrivatePoolOptionsName	String	crpTestName	The name of the capacity reservation.
RegionId	String	cn-hangzhou	The region ID of the capacity reservation.
InstanceChargeType	String	PostPaid	容量予約を使用して作成されるインスタンスの課金方法。設定可能な値は以下のとおりです。 PostPaid ：従量課金 PrePaid：サブスクリプション
EndTime	String	2021-02-19T03:02Z	容量予約の有効期限が切れる時刻。
StartTime	String	2021-02-19T02:01Z	容量予約が有効になる時刻。
説明	String	これは説明です。	容量予約の説明。
EndTimeType	String	無制限	The release mode of the capacity reservation. 設定可能な値は以下のとおりです。制限: 容量予約は、指定された時間に自動的にリリースされます。無制限: 容量予約は手動でリリースされます。いつでもリリースできます。
ResourceGroupId	String	rg-bp67acfmxazb4p****	容量予約が属するリソースグループのID。
プラットフォーム	String	linux	容量予約を使用して作成されるインスタンスのオペレーティングシステムタイプ。設定可能な値は以下のとおりです。 windows linux
AllocatedResources	AllocatedResourceの配列		割り当てられたリソースの詳細。
AllocatedResource
UsedAmount	Integer	2	容量予約を使用したインスタンスの数。
TotalAmount	Integer	2	インスタンスタイプの容量が予約されているインスタンスの総数。
zoneId	String	cn-hangzhou	ゾーン ID。
InstanceType	String	ecs.c6.large	インスタンスタイプです。
タグ	タグの配列		容量予約のタグ。
タグ
TagValue	String	TestValue	タグの値。
TagKey	String	TestKey	タグキー。
StartTimeType	String	現在	容量予約が有効になるモード。設定可能な値は以下のとおりです。現在: 容量予約は作成されるとすぐに有効になります。 Later: 指定された時間に容量予約が有効になります。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeCapacityReservations
&RegionId=cn-hangzhou
&PrivatePoolOptions.Ids=["crp-bp1gubrkqutenqdd ****", "crp-bp67acfmxazb5 ****"]
&InstanceType=ecs.c6.large
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCapacityReservationsResponse>
    <TotalCount>1</TotalCount>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId> 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E </ RequestId>
    <MaxResults>10</MaxResults>
    <CapacityReservationSet>
        <CapacityReservationItem>
            <Status>Active</Status>
            <説明> これは説明です。</Description>
            <EndTime>2021-02-19T03:02Z</EndTime>
            <Platform>linux</Platform>
            <ResourceGroupId>rg-bp67acfmxazb4p ****</ResourceGroupId>
            <PrivatePoolOptionsName>crpTestName</PrivatePoolOptionsName>
            <InstanceChargeType>PostPaid</InstanceChargeType>
            <StartTime>2021-02-19T02:01Z</StartTime>
            <StartTimeType> 今すぐ </StartTimeType>
            <PrivatePoolOptionsMatchCriteria> オープン </PrivatePoolOptionsMatchCriteria>
            <タイムスロット />
            <AllocatedResources>
                <AllocatedResource>
                    <UsedAmount>2</UsedAmount>
                    <zoneId>cn-hangzhou-h</zoneId>
                    <TotalAmount>2</TotalAmount>
                    <InstanceType>ecs.c6.large</InstanceType>
                </AllocatedResource>
            </AllocatedResources>
            <PrivatePoolOptionsId>crp-bp1gubrkqutenqdd ****</PrivatePoolOptionsId>
            <EndTimeType> 無制限 </EndTimeType>
            <RegionId>cn-hangzhou</RegionId>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue> テスト値 </TagValue>
                </Tag>
            </Tags>
        </CapacityReservationItem>
    </CapacityReservationSet>
</DescribeCapacityReservationsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1、
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883" 、
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E" 、
  "MaxResults" : 10、
  "CapacityReservationSet" : {
    "CapacityReservationItem" : [ {
      "ステータス" : "アクティブ" 、
      "Description" : "これは説明です。
      "EndTime" : "2021-02-19T03:02Z" 、
      "プラットフォーム" : "linux" 、
      "ResourceGroupId" : "rg-bp67acfmxazb4p ****" 、
      "PrivatePoolOptionsName" : "crpTestName" 、
      "InstanceChargeType" : "PostPaid" 、
      "StartTime" : "2021-02-19T02:01Z" 、
      "StartTimeType" : "Now" 、
      "PrivatePoolOptionsMatchCriteria" : "オープン" 、
      "TimeSlot" : "" 、
      "AllocatedResources" : {
        "AllocatedResource" : [ {
          "UsedAmount" : 2、
          "zoneId" : "cn-hangzhou-h" 、
          "TotalAmount" : 2、
          "InstanceType" : "ecs.c6.large"
        } ]
      },
      "PrivatePoolOptionsId" : "crp-bp1gubrkqutenqdd ****" 、
      "EndTimeType" : "無制限" 、
      "RegionId" : "cn-hangzhou" 、
      "タグ" : {
        "タグ" : [ {
          "TagKey" : "TestKey" 、
          "TagValue" : "TestValue"
        } ]
      }
    } ]
  }
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter.RegionId	指定されたRegionIdはnullではありません。	必要なRegionIdパラメーターが指定されていない場合に返されるエラーメッセージ。
400	DedicatedHostNotSupported	DedicatedHostはPrivatePoolでサポートされていません。	プライベートプールを使用して専用ホスト上にインスタンスを作成できない場合に返されるエラーメッセージ。
400	SpotNotSupported	スポットはPrivatePoolではサポートされていません。	プライベートプールを使用してプリエンプティブルインスタンスを作成できない場合に返されるエラーメッセージ。
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	プライベートプールを使用してクラシックネットワークでインスタンスを作成できない場合に返されるエラーメッセージ。
400	Invalid.InstanceId	インスタンスが存在しません。	インスタンスが存在しない場合に返されるエラーメッセージ。
400	Invalid.PrivatePoolOptions.MatchCriteria	ターゲットモードはこの操作をサポートしていません。	操作がターゲットプライベートプールをサポートしていない場合に返されるエラーメッセージ。
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	PrivatePoolOptions.Idsパラメーターが指定されていない場合に返されるエラーメッセージ。
400	Invalid.PrivatePoolOptions.Id	PrivatePoolは存在しません。	プライベートプールが存在しない場合に返されるエラーメッセージ。
400	Invalid.InstanceType	InstanceTypeはPrivatePoolと一致しません。	インスタンスタイプがプライベートプールと一致しない場合に返されるエラーメッセージ。
400	Invalid.InstanceChargeType	InstanceChargeTypeはPrivatePoolと一致しません。	指定された課金方法を使用するインスタンスの作成にプライベートプールを使用できない場合に返されるエラーメッセージ。
400	無効な. ZoneId	ZoneIdはPrivatePoolと一致しません。	ゾーンがプライベートプールと一致しない場合に返されるエラーメッセージ。
400	Invalid.PrivatePoolOptions.MatchCriteria	PrivatePoolOptions.MatchCriteriaはPrivatePoolと一致しません。	指定されたPrivatePoolOptions.MatchCriteriaパラメーターがプライベートプールと一致しない場合に返されるエラーメッセージ。
400	InvalidPlatform.ValueNotSupported	プラットフォームがPrivatePoolと一致しません。	指定されたPlatformパラメーターがプライベートプールと一致しない場合に返されるエラーメッセージ。
400	InvalidAliUid	PrivatePoolはインスタンスのユーザーに属していません。	プライベートプールがインスタンスの作成を試みたユーザーに属していない場合に返されるエラーメッセージ。
400	Invalid.InstanceId	インスタンスはPrivatePoolにアタッチされていません。	インスタンスがプライベートプールと一致しない場合に返されるエラーメッセージ。
400	無効な. TooManyPrivatePoolOptions.Ids	このリクエストに含まれるPrivatePoolOptions.Idが多すぎます。	指定された容量予約IDの数が上限を超えた場合に返されるエラーメッセージ。
400	無効な. TooManyZoneIds	リクエストのZoneIdが多すぎます。	指定されたゾーンIDの数が上限を超えた場合に返されるエラーメッセージ。
400	無効な. TooManyInstanceTypes	リクエスト内のInstanceTypesが多すぎます。	指定されたインスタンスタイプの数が上限を超えた場合に返されるエラーメッセージ。
400	無効な. TooManyUnpaidPrivatePool	あまりにも多くのPrivatePoolsが作成しますが、まだ未払いです。	複数のプライベートプールが作成されているが、支払われていない場合に返されるエラーメッセージ。
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	InstanceCpuCoreCountとInstanceAmountの両方が提供されます。	InstanceCpuCoreCountパラメーターとInstanceAmountパラメーターを同時に指定できない場合に返されるエラーメッセージ。
400	無効です。PrivatePool。購入	PrivatePoolはすでに支払っています。	プライベートプールがすでに支払われている場合に返されるエラーメッセージ。
400	Invalid.AssuranceTimes.NotSupported	AssuranceTimesの値はサポートされていません。	指定されたAssuranceTimesパラメーターが無効な場合に返されるエラーメッセージ。
400	RepeatStartPrivatePool	PrivatePoolはすでに開始されています。	プライベートプールがすでに開始されている場合に返されるエラーメッセージ。
400	InvalidParameter.RegionId	指定されたRegionIdは存在しません。	指定された DiskId パラメーターが存在しない場合に返されるエラーメッセージ。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部エラーが発生した場合に返されるエラーメッセージです。しばらくしてから再試行します。エラーが解決しない場合は、チケットを起票してください。

エラーコードリストについては、「API エラーセンター」をご参照ください。