CreateCapacityReservation - Elastic Compute Service

指定需要預留的執行個體規格、總數量，生效方式和可用區等，建立容量預定服務。

介面說明

您可以透過容量預定服務，指定可用區、執行個體規格等屬性，系統會以私有池的方式預留屬性相符的資源。更多資訊，請參閱立即生效容量預定概述。

目前服務僅支援立即生效模式。購買立即生效容量預定服務後，執行個體規格即開始遵循按量計費標準計費，不論是否實際建立了按量計費執行個體，直至您自行手動釋放或到期系統自動釋放立即生效容量預定。
- 您可以透過 CreateInstance 或 RunInstances 建立執行個體時設定私有池容量選項，或者透過 ModifyInstanceAttachmentAttributes 修改執行個體的私有池容量選項。執行個體成功匹配私有池容量後，將根據您的執行個體設定收取執行個體規格、雲端硬碟、公網頻寬等相關資源費用。
- 未實際建立按量計費執行個體時，僅收取執行個體規格的費用。
立即生效容量預定的匹配的執行個體和未使用的容量帳單支援透過節省方案、地域級預留執行個體券抵扣小時帳單，不支援透過可用區級預留執行個體券抵扣小時帳單。建議您先購買預留執行個體券或節省方案，在預留執行個體券或節省方案的涵蓋下使用立即生效容量預定服務，可以免費獲取資源的確定性保障。

說明

呼叫 API 方式僅支援建立立即生效容量預定。透過 ECS 主控台可以建立立即生效容量預定或指定時間生效容量預定，更多資訊，請參閱資源預定服務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	是	執行個體規格。目前僅支援為一個執行個體規格設定容量預定服務。您可以呼叫 DescribeInstanceTypes 查詢雲端伺服器 ECS 提供的執行個體規格資訊。	ecs.g6.xlarge
StartTime	string	否	容量預定服務的生效方式。目前呼叫 API 的方式僅支援設定為立即生效。時間格式以 ISO 8601 為標準，時區為 UTC，格式為 `yyyy-MM-ddTHH:mm:ssZ`。說明該參數不傳值即表示設定為立即生效。	2021-10-30T05:32:00Z
EndTime	string	否	容量預定服務的失效時間。時間格式以 ISO 8601 為標準，並需要使用 UTC +0 時間，格式為 `yyyy-MM-ddTHH:mm:ssZ`。更多資訊，請參閱 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。目前僅支援在一個可用區下建立容量預定服務。	cn-hangzhou-h
	string	否	容量預定服務所屬地域下的可用區 ID。	cn-hangzhou-h

返回參數

名稱	類型	描述	樣本值
	object
PrivatePoolOptionsId	string	容量預定服務 ID。	crp-bp67acfmxazb4****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	指定的Platform參數與私有池不匹配。
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，且不能購買第三方的商品例如由映像市場提供的映像。請檢查參數，傳入符合條件的參數重試。
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中至少有一個無效。
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.	資源群組並不在記錄中。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。