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

1 つ以上のキャパシティ予約の詳細 (ステータス、有効開始時刻と有効期限、非公開プールモード、消費済みインスタンス数など) を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeCapacityReservations

get

*CapacityReservation。

acs:ecs:{#regionId}:{#accountId}:capacityreservation/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	キャパシティ予約のリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	リソースグループ ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1000 以下である必要があります。説明デフォルトのリソースグループによるフィルターはサポートされていません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	キャパシティ予約にバインドされているタグ。
	object	任意	タグペア。
Key	string	任意	タグキー。N は、フィルター用に複数のタグキーをセットできることを示します。N の有効な値: 1 ~ 20。単一のタグを使用してリソースをフィルターする場合、そのタグが付いたリソース数は 1000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付いたリソース数は 1000 を超えることはできません。リソース数が 1000 を超える場合は、 ListTagResources 操作を呼び出してリソースをクエリします。	TestKey
Value	string	任意	タグ値。N は、フィルター用に複数のタグ値をセットできることを示します。N の有効な値: 1 ~ 20。	TestValue
MaxResults	integer	任意	ページングクエリの 1 ページあたりの最大エントリ数。最大値: 100。デフォルト値: 10。	10
NextToken	string	任意	キャパシティ予約クエリのページネーショントークン。前のリクエストの結果から値を取得します。	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	任意	キャパシティ予約 ID のリスト。値は、最大 100 個の ID で構成され、カンマ (,) で区切られた JSON 配列にすることができます。	["crp-bp1gubrkqutenqdd**", "crp-bp67acfmxazb5**"]
Platform	string	任意	インスタンスのオペレーティングシステム。有効な値: windows: Windows インスタンスのキャパシティ予約のみを照会します。 linux: Linux インスタンスのキャパシティ予約のみを照会します。 all: すべてのキャパシティ予約を照会します。デフォルト値: all。	linux
InstanceType	string	任意	インスタンスタイプ。インスタンスタイプを使用して、アクティブなキャパシティ予約のみをクエリできます。リリースされたキャパシティ予約は、PrivatePoolOptions.Ids を使用してのみクエリできます。	ecs.c6.large
ZoneId	string	任意	キャパシティ予約のゾーン ID。	cn-hangzhou-h
InstanceChargeType	string	任意	インスタンスの支払い方法。有効な値: PostPaid: 従量課金。 PrePaid: サブスクリプション。デフォルト値: PostPaid。	PostPaid
Status	string	任意	キャパシティ予約のステータス。有効な値: All: すべての状態。 Pending: 初期化中。指定された時間に効果が現れるキャパシティ予約は、最初に初期化中状態になります。 Preparing: 準備中。指定された時間に効果が現れるキャパシティ予約は、リソース配信位相中に準備中状態になります。 Prepared: 効果待ち。指定された時間に効果が現れるキャパシティ予約は、リソース配信が完了した後、サービスが正式に効果が現れる前に効果待ち状態になります。 Active: アクティブな。 Released: リリース済み。手動解放と有効期限切れ時の自動リリースを含みます。このパラメーターを指定しない場合、Pending と Released 以外のすべての状態のキャパシティ予約が照会されます。	Active

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のクエリのページネーショントークン。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	クエリ条件に一致するエントリの総数。	1
MaxResults	integer	1 ページあたりのエントリの最大値。	10
CapacityReservationSet	object
CapacityReservationItem	array<object>	キャパシティ予約の詳細。
	array<object>	キャパシティ予約の詳細。
Status	string	キャパシティ予約のステータス。有効な値: Pending: 初期化中。 Preparing: 準備中。 Prepared: 効果待ち。 Active: アクティブな。 Released: リリース済み。手動解放と有効期限切れ時の自動リリースを含みます。	Active
TimeSlot	string	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	null
PrivatePoolOptionsMatchCriteria	string	キャパシティ予約に効果が現れた後に生成される非公開プールのタイプ。有効な値: Open: オープンモード。インスタンスの起動時に、システムがオープンの非公開プールのキャパシティを自動的にマッチングします。一致する非公開プールキャパシティが利用できない場合、パブリックプールリソースが使用されてインスタンスが起動されます。 Target: ターゲットモード。指定された非公開プールのキャパシティを使用してインスタンスが起動されます。指定された非公開プールキャパシティが利用できない場合、インスタンスの起動は失敗します。	Open
PrivatePoolOptionsId	string	キャパシティ予約 ID。	crp-bp1gubrkqutenqdd****
PrivatePoolOptionsName	string	キャパシティ予約サービス名。	crpTestName
RegionId	string	キャパシティ予約のリージョン ID。	cn-hangzhou
InstanceChargeType	string	キャパシティ予約内のインスタンスの支払い方法。有効な値: PostPaid: 従量課金。 PrePaid: サブスクリプション。	PostPaid
EndTime	string	キャパシティ予約の有効期限。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。	2021-02-19T03:02Z
StartTime	string	キャパシティ予約の有効開始時刻。時刻は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。	2021-02-19T02:01Z
Description	string	キャパシティ予約の説明。	This is description.
EndTimeType	string	キャパシティ予約のリリースモード。有効な値: Limited: 指定された時間にリリースされます。 Unlimited: 無制限版。手動解放。時間制限は課されません。	Unlimited
ResourceGroupId	string	キャパシティ予約のリソースグループ ID。	rg-bp67acfmxazb4p****
Platform	string	一致したインスタンスのオペレーティングシステム。有効な値: windows。 linux。	linux
AllocatedResources	object
AllocatedResource	array<object>	リソース割り当て詳細のリスト。
	array<object>	リソース割り当ての詳細。
UsedAmount	integer	消費済みインスタンス数。	2
TotalAmount	integer	特定のインスタンスタイプに対して予約されるインスタンスの総数。	2
AvailableAmount	integer	利用可能なインスタンス数。	2
FailedAmount	integer	失敗したキャパシティ。	1
LockedAmount	integer	ロック済みキャパシティ。	1
zoneId	string	ゾーン ID。	cn-hangzhou-h
InstanceType	string	インスタンスタイプ	ecs.c6.large
CapacityReservationUsages	object
CapacityReservationUsage	array<object>	消費済みインスタンス詳細のリスト。
	object	消費済みインスタンスの詳細。
AccountId	string	Alibaba Cloud アカウント ID。	105909559088****
ServiceName	string	Alibaba Cloud サービス名。	maxcompute.aliyuncs.com
UsedAmount	integer	Alibaba Cloud アカウントまたはサービスによって消費されたインスタンス数。	20
Tags	object
Tag	array<object>	キャパシティ予約にバインドされているタグキーと値のペアのリスト。
	object	キャパシティ予約にバインドされているタグキーと値のペア。
TagValue	string	タグ値。	TestValue
TagKey	string	タグキー	TestKey
StartTimeType	string	キャパシティ予約に効果が現れるモード。有効な値: Now: すぐに効果が現れます。 Later: 指定された時間に効果が現れます。	Now
SavingPlanId	string	キャパシティ予約に関連付けられている節約プラン ID。	spn-c29b5e18pJMT****
ReservedInstanceId	string	キャパシティ予約に関連付けられているリザーブドインスタンス ID。	ri-bpzhex2ulpzf53****
CapacityReservationOwnerId	string	キャパシティ予約リソースプランのオーナー ID。	100************7
DeliveryTime	string	配信時間。時刻は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。
UnlockedTime	string	ロック解除時間。時刻は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1,
  "MaxResults": 10,
  "CapacityReservationSet": {
    "CapacityReservationItem": [
      {
        "Status": "Active",
        "TimeSlot": "null",
        "PrivatePoolOptionsMatchCriteria": "Open",
        "PrivatePoolOptionsId": "crp-bp1gubrkqutenqdd****",
        "PrivatePoolOptionsName": "crpTestName",
        "RegionId": "cn-hangzhou",
        "InstanceChargeType": "PostPaid",
        "EndTime": "2021-02-19T03:02Z",
        "StartTime": "2021-02-19T02:01Z",
        "Description": "This is description.",
        "EndTimeType": "Unlimited",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Platform": "linux",
        "AllocatedResources": {
          "AllocatedResource": [
            {
              "UsedAmount": 2,
              "TotalAmount": 2,
              "AvailableAmount": 2,
              "FailedAmount": 1,
              "LockedAmount": 1,
              "zoneId": "cn-hangzhou-h",
              "InstanceType": "ecs.c6.large",
              "CapacityReservationUsages": {
                "CapacityReservationUsage": [
                  {
                    "AccountId": "105909559088****",
                    "ServiceName": "maxcompute.aliyuncs.com",
                    "UsedAmount": 20
                  }
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "StartTimeType": "Now",
        "SavingPlanId": "spn-c29b5e18pJMT****",
        "ReservedInstanceId": "ri-bpzhex2ulpzf53****",
        "CapacityReservationOwnerId": "100************7\n",
        "DeliveryTime": "",
        "UnlockedTime": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter.RegionId	The specified RegionId should not be null.	RegionId パラメーターは空にできません。
400	InvalidParameter.Name	The specified PrivatePoolOptions.Name is invalid.
400	InvalidParameter.PrivatePoolOptions.Ids	The specified PrivatePoolOptions.Ids is invalid.
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.	プライベートプールでは専用ホストはサポートされていません。
400	SpotNotSupported	Spot is not supported for PrivatePool.	プライベートプールではスポットインスタンスはサポートされていません。
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	プライベートプールではクラシックネットワークタイプのインスタンスはサポートされていません。
400	Invalid.InstanceId	Instance does not exist.	インスタンスがプライベートプールと一致していません。
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	指定された PrivatePoolOptions.MatchCriteria パラメーターが非公開プールと一致しません。
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	PrivatePoolOptions.Id パラメーターを空にすることはできません。
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	プライベートプールが存在しません。
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	インスタンスタイプがプライベートプールと一致しません。
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	指定された InstanceChargeType パラメーターが無効です。
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	ゾーンがプライベートプールと一致しません。
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	指定された非公開プールのステータスは無効です。
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	指定されたプラットフォームパラメーターが非公開プールと一致しません。
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	プライベートプールが、インスタンスを作成するユーザーに属していません。
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	PackageType パラメーターは空にできません。
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	指定されたパラメーター PrivatePoolOptions.ids は空にできません。
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	指定されたパラメーター InstanceCpuCocount は空にできません。
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	指定されたパラメーター InstanceAmount (マウント) は空にできません。
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	InstanceCpuCoreCount パラメーターと InstanceAmount (マウント) パラメーターの両方を空にすることはできません。
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	PrivatePoolOptions.Ids の数が上限を超えています。
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	ZoneIds の数が上限を超えています。
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	InstanceTypes の数が上限を超えています。
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	複数のプライベートプールに対する支払いが完了していません。
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	InstanceCpuCoreCount パラメーターと InstanceAmount パラメーターを同時に指定する必要はありません。
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	指定された非公開プール ID が存在しません。
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	指定された PackageType パラメーターは無効です。
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	プライベートプールは既に支払い済みです。
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	AssuranceTimes パラメーターの値はサポートされていません。
400	RepeatStartPrivatePool	PrivatePool has already been started.	プライベートプールは既に開始されています。
400	InvalidParameter.RegionId	The specified RegionId is not exist.
400	InvalidPermission.ResourceShareAssocoated	The current resource is associated to a shared relationship and cannot be released.	現在のリソースは共有関係にあるため、リリースできません。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部エラーが発生しました。もう一度お試しください。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。