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

インスタンスタイプ、インスタンスの総数、効果モード、およびゾーンを指定して、キャパシティ予約を作成します。

操作説明

操作の説明

キャパシティ予約サービスを使用して、ゾーンやインスタンスタイプなどのプロパティ設定を指定できます。システムは、非公開プール内で指定されたプロパティ設定に一致するリソースを予約します。詳細については、「即時キャパシティ予約の概要」を参照してください。

現在、このサービスは即時効果モードのみをサポートしています。即時キャパシティ予約を購入した後、従量課金インスタンスが実際に作成されるかどうかに関わらず、手動でリリースするか、有効期限切れによりシステムが自動的にリリースするまで、インスタンスタイプは従量課金の標準課金主題となります。
- CreateInstance または RunInstances を呼び出してインスタンスを作成する際に非公開プールのキャパシティ設定を構成するか、 ModifyInstanceAttachmentAttributes を呼び出してインスタンスの非公開プールのキャパシティオプションを変更できます。インスタンスが非公開プールのキャパシティに正常に一致した後、インスタンスの設定に基づいて、インスタンスタイプ、クラウドディスク、パブリック帯域幅などのリソースに対して課金されます。
- 従量課金インスタンスが実際に作成されない場合、インスタンスタイプに対してのみ課金されます。
即時キャパシティ予約の一致したインスタンスおよび未使用キャパシティの請求額は、節約プランまたはリージョン予約インスタンスによって 1 時間単位でオフセットできますが、ゾーン予約インスタンスではオフセットできません。最初に予約インスタンスまたは節約プランを購入することをお勧めします。予約インスタンスまたは節約プランのカバー率内で即時キャパシティ予約を使用すると、保証されたリソースを無料で取得できます。

説明

この API を呼び出して作成できるのは即時キャパシティ予約のみです。即時キャパシティ予約またはスケジュールされたキャパシティ予約は、ECS コンソールで作成できます。詳細については、「リソース保証」を参照してください。

今すぐお試しください

この 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:CreateCapacityReservation

create

*CapacityReservation。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	キャパシティ予約のリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	キャパシティ予約が属するエンタープライズリソースグループの ID。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	キャパシティ予約にバインドされているタグのリスト。
	object	任意	タグ。
Key	string	任意	キャパシティ予約のタグキー。N の有効値: 1～20。このパラメーターが指定されている場合、空の文字列にすることはできません。タグキーの長さは最大 128 文字で、`aliyun` または `acs:` で始まるもの、あるいは `http://` または `https://` を含むものは使用できません。	TestKey
Value	string	任意	キャパシティ予約のタグ値。N の有効値: 1～20。このパラメーターが指定されている場合、空の文字列にすることができます。タグ値の長さは最大 128 文字で、`acs:` で始まるもの、あるいは `http://` または `https://` を含むものは使用できません。	TestValue
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」を参照してください。	0c593ea1-3bea-11e9-b96b-88e9fe637760
PrivatePoolOptions.Name	string	任意	キャパシティ予約の名前。名前の長さは 2～128 文字である必要があります。英字または漢字で始める必要があり、`http://` または `https://` で始めることはできません。数字、コロン (:)、アンダースコア (_)、およびハイフン (-) を含めることができます。	crpTestName
Description	string	任意	キャパシティ予約の説明。説明の長さは 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。デフォルト値: 空。	This is description.
PrivatePoolOptions.MatchCriteria	string	任意	キャパシティ予約が効果になった後に生成される非公開プールのタイプ。有効な値: Open: オープンモード。インスタンスを起動すると、システムはオープンな非公開プールのキャパシティを自動的に一致させます。条件を満たす非公開プールのキャパシティが利用できない場合、インスタンスはパブリックプールリソースを使用します。 Target: 専用モード。インスタンスは指定された非公開プールのキャパシティを使用します。非公開プールのキャパシティが利用できない場合、インスタンスの起動は失敗します。デフォルト値: Open。	Open
InstanceAmount	integer	必須	単一のインスタンスタイプに対して予約されるインスタンスの総数。	2
InstanceType	string	必須	インスタンスタイプ。現在、キャパシティ予約設定を構成できるのは 1 つのインスタンスタイプのみです。 DescribeInstanceTypes 操作を呼び出して、Elastic Compute サービス (ECS) が提供するインスタンスタイプをクエリできます。	ecs.g6.xlarge
StartTime	string	任意	キャパシティ予約の効果モード。現在、API の呼び出しでは、このパラメーターを即時効果に設定することのみがサポートされています。時間は ISO 8601 規格の `yyyy-MM-ddTHH:mm:ssZ` 初期化で指定します。時間は協定世界時 (UTC) である必要があります。説明このパラメーターが指定されていない場合、キャパシティ予約は直ちに効果になります。	2021-10-30T05:32:00Z
EndTime	string	任意	キャパシティ予約の有効期限。時間は ISO 8601 規格の `yyyy-MM-ddTHH:mm:ssZ` 初期化で指定します。時間は協定世界時 (UTC) である必要があります。詳細については、「ISO 8601」を参照してください。	2021-10-30T06:32:00Z
EndTimeType	string	任意	キャパシティ予約の有効期限モード。有効な値: Limited: 指定された時間に予約をリリースします。EndTime パラメーターも指定する必要があります。 Unlimited: 無制限版。手動解放。時間制限は課されません。	Unlimited
Platform	string	任意	インスタンスが使用するイメージのオペレーティングシステムタイプ。このパラメーターは、リージョン予約インスタンスの Platform パラメーターに対応します。キャパシティ予約のオペレーティングシステムタイプがリージョン予約インスタンスのものと一致する場合、リージョン予約インスタンスを使用してキャパシティ予約の未使用キャパシティの請求額をオフセットできます。有効な値: Windows: Windows Server オペレーティングシステム。 Linux: Linux および UNIX 系オペレーティングシステム。デフォルト値: Linux。説明このパラメーターは利用できません。	Linux
InstanceChargeType	string	任意	インスタンスの支払い方法。現在、PostPaid (従量課金) のみがサポートされています。デフォルト値: PostPaid。	PostPaid
ZoneId	array	必須	キャパシティ予約が属するリージョンのゾーン ID。現在、キャパシティ予約を作成できるのは 1 つのゾーンのみです。	cn-hangzhou-h
	string	任意	キャパシティ予約が属するリージョンのゾーン ID。	cn-hangzhou-h

レスポンスフィールド

フィールド	型	説明	例
	object
PrivatePoolOptionsId	string	キャパシティ予約の ID。	crp-bp67acfmxazb4****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "PrivatePoolOptionsId": "crp-bp67acfmxazb4****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.RegionId	The specified RegionId is invalid.	指定された RegionId は存在しません。
400	NoStock	The stock in the availability zone is insufficient.	指定されたゾーンの在庫が不足しています。
400	MissingParameter	The input parameter StartTime is missing.
400	OperationDenied	The specified instanceType or zone is not available or not authorized.	指定されたスナップショットではデータボリュームの作成が許可されていません。
400	MissingParameter.RegionId	The specified RegionId should not be null.	RegionId パラメーターは空にできません。
400	InvalidStartTime.NotSupported	The specified StartTime should be within 180 calendar days from the current date, and you must specify a precision to hour.	指定された StartTime パラメーターが有効値の範囲内にありません。
400	InvalidStartTime.MalFormed	The specified StartTime is out of the permitted range.
400	Invalid.PrivatePoolOptionsName.MalFormed	The specified PrivatePoolOptions.Name is not valid.	指定された PrivatePoolOptions.Name は有効ではありません。
400	Invalid.ZoneId	The specified ZoneId is not valid.	ゾーンがプライベートプールと一致しません。
400	Invalid.InstanceType	The specified InstanceType is not valid.	インスタンスタイプがプライベートプールと一致しません。
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.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	指定された InstanceChargeType パラメーターが無効です。
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	Invalid.TimeSlot	The param time slot is invalid.	TimeSlot パラメーターは無効です。
400	Invalid.EndTime	The specified parameter "EndTime" is not valid.	指定された EndTime パラメーターは無効です。
400	StartTime.NotNeed	The specified parameter "StartTime" should leave empty.	リクエストパラメーターリストから StartTime フィールドを削除してください。
400	AccountForbidden.ProductCreationLimited	The commodity must be officially operated by Aliyun and in pay-as-you-go billing method.	企業のクラウド移行のお客様は、従量課金制の ECS インスタンスのみを購入でき、Alibaba Cloud Marketplace が提供するイメージなどのサードパーティプロダクトは購入できません。パラメーターを確認し、有効なパラメーターでリトライしてください。
400	RegionUnauthorized	There is no authority to create private pool in the specified region.	ユーザーには、指定されたリージョンでインスタンスを作成する権限がありません。
400	PriceNotFound	The price of your queried resource is not available now, please try other resources.	料金が見つかりませんでした。対応するパラメーター値を変更して、もう一度お試しください。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部エラーが発生しました。もう一度お試しください。
403	Zone.NotOpen	The specified zone is not granted to you to buy resources yet.
403	InvalidResourceType.NotSupported	%s	このリソースタイプはサポートされていません。
403	OperationDenied.NoStock	The resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.	指定されたディスクカテゴリが指定されたゾーンまたはクラスターに存在しないか、あるいは指定されたゾーンがクラスターと一致しません。
403	InvalidInstanceType.NotSupported	The specified InstanceType is invalid.
403	Invalid.ZoneIds	At least one of the specified ZoneIds are invalid.	指定された ZoneIds の少なくとも 1 つは無効です。
403	Zone.NotOnSale	The specified zone is not available for purchase.	指定されたゾーンは在庫切れです。インスタンスタイプを変更するか、別のリージョンにインスタンスを作成してください。
404	InvalidZoneId.NotFound	The specified zoneId does not exist.	指定されたゾーン ID が存在しません。
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	レコードにリソースグループが見つかりません。

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

変更履歴

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