AllocateDedicatedHosts - 建立一台或多台隨用隨付或者訂用帳戶Dedicated Host - Elastic Compute Service

調用AllocateDedicatedHosts建立一台或多台隨用隨付或者訂用帳戶Dedicated Host。Dedicated Host是單租戶獨享的物理機資源，您可以在Dedicated Host上自行建立ECS執行個體和擷取物理伺服器屬性等資訊。

介面說明

建立Dedicated Host前，您可以調用 DescribeAvailableResource 查看指定地區或者可用性區域內的資源供給情況。

建立Dedicated Host會產生費用，建議您提前瞭解資源的計費方式。更多詳情，請參見計費概述。

單次最多能建立 100 台訂用帳戶或隨用隨付Dedicated Host。
建立成功後，您可以將返回的Dedicated Host ID 列表作為請求參數，調用 DescribeDedicatedHosts 查詢建立Dedicated Host狀態。
提交建立Dedicated Host的請求後，指定的參數值不合規或者庫存不足時會報錯。具體的報錯原因，請參見錯誤碼。
建立Dedicated Host後，您可以通過 ModifyInstanceDeployment 將 ECS 執行個體從共用宿主機遷移到Dedicated Host，也可以在兩台Dedicated Host上調整執行個體部署。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:AllocateDedicatedHosts

create

*DedicatedHost

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	Dedicated Host所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	Dedicated Host的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以 aliyun 或者 acs:開頭，不能包含`http://`或者`https://`。	Environment
Value	string	否	Dedicated Host的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空白字串。最多支援 128 個字元，不能包含`http://`或者`https://`。	Production
ResourceGroupId	string	否	Dedicated Host要加入的資源群組 ID。	rg-bp67acfmxazb4ph***
ZoneId	string	否	Dedicated Host所屬的可用性區域編號。預設值：空，表示由系統選擇。	cn-hangzhou-f
DedicatedHostName	string	否	Dedicated Host的名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。	myDDH
DedicatedHostClusterId	string	否	Dedicated Host所屬的Dedicated Host叢集 ID。	dc-bp12wlf6am0vz9v2****
DedicatedHostType	string	是	Dedicated Host的規格。您可以調用 DescribeDedicatedHostTypes 介面獲得最新的Dedicated Host規格表。	ddh.c5
ActionOnMaintenance	string	否	當Dedicated Host發生故障或者線上修複時，為其所宿執行個體設定遷移方案。取值範圍： Migrate：遷移執行個體到其他物理機並重新啟動執行個體。當Dedicated Host上掛載雲端硬碟儲存時，預設值：Migrate。 Stop：在當前Dedicated Host上停止執行個體，確認無法修複Dedicated Host後，遷移執行個體到其他物理機並重新啟動執行個體。當Dedicated Host上掛載本地碟儲存時，預設值：Stop。	Migrate
NetworkAttributes.SlbUdpTimeout	integer	否	負載平衡串連的 UDP 會話逾時時間，單位：秒。取值範圍：15~310。	60
NetworkAttributes.UdpTimeout	integer	否	為Dedicated Host上啟動並執行雲端服務設定使用者訪問的 UDP 會話逾時時間，單位：秒。取值範圍：15~310。	60
Description	string	否	Dedicated Host的描述。長度為 2~256 個英文或中文字元，不能以`http://`或`https://`開頭。	This-is-my-DDH
AutoPlacement	string	否	Dedicated Host是否加入自動部署資源集區。當您在Dedicated Host上建立執行個體，卻不指定 DedicatedHostId 時，阿里雲將自動從加入資源集區的Dedicated Host中，為您選取適合的宿主機部署執行個體，更多資訊，請參見自動部署功能介紹。取值範圍： on：加入自動部署資源集區。 off：不加入自動部署資源集區。預設值：on。說明若您不希望Dedicated Host加入自動部署資源集區，請將該參數設定為 off。	off
CpuOverCommitRatio	number	否	CPU 超賣比。僅自訂規格 g6s、c6s、r6s 支援設定 CPU 超賣比。取值範圍：1~5。 CPU 超賣比影響 DDH 的可用 vCPU 數，一台 DDH 的可用 vCPU 數=物理 CPU 核心數2CPU 超賣比。例如，g6s 的物理 CPU 核心數為 52，如果設定 CPU 超賣比為 4，則 DDH 建立完成後 vCPU 總數顯示為 416。針對 CPU 絕對穩定性要求不嚴苛或 CPU 負載不高的情境，例如開發測試環境，提升超賣比可以提升可用 vCPU 數，用於部署更多同等規格的 ECS 執行個體，降低單位部署成本。	1
MinQuantity	integer	否	指定Dedicated Host的最小購買數量。取值範圍：1~100。說明當Dedicated Host的庫存小於最小購買數量時，建立Dedicated Host將會失敗。	2
ChargeType	string	否	Dedicated Host的計費方式。取值範圍： PrePaid：訂用帳戶。選擇訂用帳戶時，請確認您的支付方式支援信用額度支付，否則會提示`InvalidPayMethod`。 PostPaid：隨用隨付。預設值：PostPaid。	PrePaid
Quantity	integer	否	本次建立的Dedicated Host的數量。取值範圍：1~100。預設值：1。	2
Period	integer	否	購買Dedicated Host的訂用帳戶時間長度。當參數`ChargeType`取值為`PrePaid`時，`Period`參數方可生效並為必選參數。取值範圍： PeriodUnit=Month 時：1、2、3、4、5、6、7、8、9、12、24、36、48、60。 PeriodUnit=Year 時：1、2、3、4、5。	6
PeriodUnit	string	否	購買Dedicated Host的時間長度單位。取值範圍： Month Year 預設值：Month。	Month
AutoRenew	boolean	否	是否自動續約訂用帳戶Dedicated Host。說明當參數 ChargeType 取值 PrePaid 時，AutoRenew 參數方可生效。預設值：false。	false
AutoRenewPeriod	integer	否	單次自動續約的周期。當參數 AutoRenew 為 true 時，AutoRenewPeriod 參數方可生效，並為必選參數。取值範圍： PeriodUnit=Month 時：1、2、3、6、12。	1
AutoReleaseTime	string	否	Dedicated Host自動釋放時間。需按照 ISO 8601 標準表示，並使用 UTC+0 時間，格式為`yyyy-MM-ddTHH:mm:ssZ`。說明最短設定為目前時間之後半小時。最長不能超過目前時間之後三年。若參數值中的秒（ss）不是 00，則自動取為 00。	2019-08-21T12:30:24Z
ClientToken	string	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。	123e4567-e89b-12d3-a456-426655440000

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
RequestId	string	請求 ID。	E2A664A6-2933-4C64-88AE-5033D003****
DedicatedHostIdSets	object
DedicatedHostId	array	Dedicated Host ID（DedicatedHostId）組成的列表。
	string	Dedicated Host ID（DedicatedHostId）。	dh-bp67acfmxazb4d****
OrderId	string	訂單 ID。說明該參數只有建立訂用帳戶Dedicated Host（請求參數ChargeType=PrePaid）時才有傳回值。	23841229****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E2A664A6-2933-4C64-88AE-5033D003****",
  "DedicatedHostIdSets": {
    "DedicatedHostId": [
      "dh-bp67acfmxazb4d****"
    ]
  },
  "OrderId": "23841229****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidInstanceType.ValueUnauthorized	The specified InstanceType is not authorized.
400	InvalidDescription.Malformed	The specified parameter "Description" is not valid.	指定的資源描述格式不合法。長度為2-256個字元，不能以http://和https://開頭。
400	InvalidParameter.Conflict	The specified region and cluster do not match.	指定的地區與指定的叢集不匹配。
400	InvalidAutoRenewPeriod.ValueNotSupported	The specified autoRenewPeriod is not valid.	指定的參數 AutoRenewPeriod 不合法。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的標籤鍵參數有誤。
400	InvalidDedicatedHostType.ValueNotSupported	%s	指定的Dedicated Host類型無效。
400	RegionUnauthorized	%s	該地區未被授權。%s為變數，將根據調用API的實際情況動態返回錯誤資訊。
400	Zone.NotOnSale	%s	該可用性區域暫時關閉了售賣。%s為變數，將根據調用API的實際情況動態返回錯誤資訊。
400	OperationDenied	The specified DedicatedHostType or Zone is not available or not authorized.	指定宿主機規格、可用性區域不可用或者沒有操作的許可權。
400	InvalidPeriodUnit.ValueNotSupported	The specified parameter PeriodUnit is not valid.	參數 PeriodUnit 無效。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的標籤值參數有誤。
400	QuotaExceed.AfterpayDedicatedHost	The maximum number of Pay-As-You-Go DedicatedHosts is exceeded: %s	隨用隨付的宿主機庫存不足，請減少建立數量。
400	InvalidChargeType.ValueNotSupported	ChargeType is not valid	付費類型無效。
400	InvalidParameter.SlbUdpTimeout	The specified value is invalid.	指定的參數 SlbUdpTimeout 無效。
400	InvalidParameter.UdpTimeout	The specified value is invalid.	指定的參數 UdpTimeout 無效。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	標籤中存在重複的鍵，請保持鍵的唯一性。
400	InvalidParameter.Quantity	The specified Quantity is invalid.	指定的數量參數（Quantity）無效。
400	InvalidDedicatedHostPrice.NotFound	The specified Dedicated price is not found.	指定的專用宿主機配置詢價失敗。
400	InvalidDedicatedHostType.CpuOverCommitRatioNotSupported	%s
400	InvalidCpuOverCommitRatio.ValueNotSupported	%s
500	InternalError	The request processing has failed due to some unknown error.
403	OperationDenied	The creation of Host to the specified Zone is not allowed.	無法在指定可用性區域建立專用宿主機。
403	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	庫存不足。
403	NodeControllerUnavailable	The Node Controller is temporarily unavailable.
403	InvalidParameter.ResourceOwnerAccount	ResourceOwnerAccount is Invalid.	指定的 ResourceOwnerAccount 不合法。
403	InvalidUserData.Forbidden	User not authorized to input the parameter "UserData", please apply for permission "UserData"
403	Zone.NotOpen	The specified zone is not granted to you to buy resources yet.
403	Zone.NotOnSale	The specified zone is not available for purchase.	指定可用性區域已經售罄，請您更換執行個體規格或者更換地區建立。
403	InvalidResourceType.NotSupported	%s	指定資源群組合不存在，請更換其他可用性區域或規格
403	InvalidDedicatedHostType.ValueNotSupported	The specified DedicatedHostType does not exist or beyond the permitted range.	指定的宿主機規格不存在。
403	InvalidDedicatedHostType.ZoneNotSupported	The specified zone does not support this dedicatedHostType.	指定可用性區域不支援指定宿主機規格。
403	InvalidUserData.Base64FormatInvalid	The specified UserData is not valid	指定的UserData參數編碼出錯
403	InvalidParameter.NotMatch	%s	您輸入的參數無效，請檢查參數之間是否衝突。
403	Account.Arrearage	Your account has been in arrears.
404	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.
404	OperationDenied	Another Host has been creating	另一個宿主機正在建立。
404	PaymentMethodNotFound	No payment method has been registered on the account.
404	InvalidDedicatedHostName.Malformed	The specified parameter DedicatedHostName is not valid.
404	InvalidDedicatedHostClusterId.NotFound	The specified DedicatedHostClusterId does not exist.
404	InvalidDedicatedHostClusterId.ExceedMaxSize	The specified Dedicated Host Cluster exceeded max capacity.
404	InvalidParameter.ActionOnMaintenance	The specified ActionOnMaintenance does not exist.	指定的遷移方案不存在。

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

變更歷史

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