調用AllocateDedicatedHosts創建一臺或多臺按量付費或者包年包月專有宿主機。專有宿主機是單租戶獨享的物理機資源,您可以在專有宿主機上自行創建ECS實例和獲取物理服務器屬性等信息。
接口說明
創建專有宿主機前,您可以調用 DescribeAvailableResource 查看指定地域或者可用區內的資源供給情況。
創建專有宿主機會產生費用,建議您提前了解資源的計費方式。更多詳情,請參見計費概述。
- 單次最多能創建 100 臺包年包月或按量付費專有宿主機。
- 創建成功后,您可以將返回的專有宿主機 ID 列表作為請求參數,調用 DescribeDedicatedHosts 查詢新建專有宿主機狀態。
- 提交創建專有宿主機的請求后,指定的參數值不合規或者庫存不足時會報錯。具體的報錯原因,請參見錯誤碼。
- 創建專有宿主機后,您可以通過 ModifyInstanceDeployment 將 ECS 實例從共享宿主機遷移到專有宿主機,也可以在兩臺專有宿主機上調整實例部署。
調試
您可以在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 | 是 | 專有宿主機所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Tag | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽列表。 | ||
Key | string | 否 | 專有宿主機的標簽鍵。N 的取值范圍:1~20。 一旦傳入該值,則不允許為空字符串。最多支持 128 個字符,不能以 aliyun 或者 acs:開頭,不能包含 | Environment |
Value | string | 否 | 專有宿主機的標簽值。N 的取值范圍:1~20。 一旦傳入該值,可以為空字符串。最多支持 128 個字符,不能包含 | Production |
ResourceGroupId | string | 否 | 專有宿主機要加入的資源組 ID。 | rg-bp67acfmxazb4ph*** |
ZoneId | string | 否 | 專有宿主機所屬的可用區編號。 默認值:空,表示由系統選擇。 | cn-hangzhou-f |
DedicatedHostName | string | 否 | 專有宿主機的名稱。長度為 2~128 個字符,支持 Unicode 中 letter 分類下的字符(其中包括英文、中文和數字等)。可以包含半角冒號(:)、下劃線(_)、半角句號(.)或者短劃線(-)。 | myDDH |
DedicatedHostClusterId | string | 否 | 專有宿主機所屬的專有宿主機集群 ID。 | dc-bp12wlf6am0vz9v2**** |
DedicatedHostType | string | 是 | 專有宿主機的規格。您可以調用 DescribeDedicatedHostTypes 接口獲得最新的專有宿主機規格表。 | ddh.c5 |
ActionOnMaintenance | string | 否 | 當專有宿主機發生故障或者在線修復時,為其所宿實例設置遷移方案。取值范圍:
| Migrate |
NetworkAttributes.SlbUdpTimeout | integer | 否 | 負載均衡連接的 UDP 會話超時時間,單位:秒。取值范圍:15~310。 | 60 |
NetworkAttributes.UdpTimeout | integer | 否 | 為專有宿主機上運行的云服務設置用戶訪問的 UDP 會話超時時間,單位:秒。取值范圍:15~310。 | 60 |
Description | string | 否 | 專有宿主機的描述。長度為 2~256 個英文或中文字符,不能以 | This-is-my-DDH |
AutoPlacement | string | 否 | 專有宿主機是否加入自動部署資源池。當您在專有宿主機上創建實例,卻不指定 DedicatedHostId 時,阿里云將自動從加入資源池的專有宿主機中,為您選取適合的宿主機部署實例,更多信息,請參見自動部署功能介紹。取值范圍:
默認值:on。 說明
若您不希望專有宿主機加入自動部署資源池,請將該參數設置為 off。
| off |
CpuOverCommitRatio | float | 否 | CPU 超賣比。僅自定義規格 g6s、c6s、r6s 支持設置 CPU 超賣比。取值范圍:1~5。 CPU 超賣比影響 DDH 的可用 vCPU 數,一臺 DDH 的可用 vCPU 數=物理 CPU 核數*2*CPU 超賣比。例如,g6s 的物理 CPU 核數為 52,如果設置 CPU 超賣比為 4,則 DDH 創建完成后 vCPU 總數顯示為 416。針對 CPU 絕對穩定性要求不嚴苛或 CPU 負載不高的場景,例如開發測試環境,提升超賣比可以提升可用 vCPU 數,用于部署更多同等規格的 ECS 實例,降低單位部署成本。 | 1 |
MinQuantity | integer | 否 | 指定專有宿主機的最小購買數量。取值范圍:1~100。 說明
當專有宿主機的庫存小于最小購買數量時,創建專有宿主機將會失敗。
| 2 |
ChargeType | string | 否 | 專有宿主機的計費方式。取值范圍:
默認值:PostPaid。 | PrePaid |
Quantity | integer | 否 | 本次創建的專有宿主機的數量。取值范圍:1~100。 默認值:1。 | 2 |
Period | integer | 否 | 購買專有宿主機的包年包月時長。當參數
| 6 |
PeriodUnit | string | 否 | 購買專有宿主機的時長單位。取值范圍:
默認值:Month。 | Month |
AutoRenew | boolean | 否 | 是否自動續費包年包月專有宿主機。 說明
當參數 ChargeType 取值 PrePaid 時,AutoRenew 參數方可生效。
默認值:false。 | false |
AutoRenewPeriod | integer | 否 | 單次自動續費的周期。當參數 AutoRenew 為 true 時,AutoRenewPeriod 參數方可生效,并為必選參數。取值范圍:
| 1 |
AutoReleaseTime | string | 否 | 專有宿主機自動釋放時間。需按照 ISO 8601 標準表示,并使用 UTC+0 時間,格式為 說明
| 2019-08-21T12:30:24Z |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "E2A664A6-2933-4C64-88AE-5033D003****",
"DedicatedHostIdSets": {
"DedicatedHostId": [
"dh-bp67acfmxazb4d****"
]
}
}
錯誤碼
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 | 指定的專有宿主機類型無效。 |
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. | - |
400 | InvalidDedicatedHostPrice.NotFound | The specified Dedicated price is not found. | - |
400 | InvalidDedicatedHostType.CpuOverCommitRatioNotSupported | %s | - |
400 | InvalidCpuOverCommitRatio.ValueNotSupported | %s | - |
400 | InvalidDedicatedHostType.ValueNotSupported | The specified HostType does not exist or beyond the permitted range. | 指定的宿主機規格不合法(超出可選范圍)。 |
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 | OperationDenied | Sales of this resource are temporarily suspended in the specified region; please try again later. | 指定的地域暫時關閉了此資源的售賣,請稍后重試。 |
403 | NodeControllerUnavailable | The Node Controller is temporarily unavailable. | 節點控制器暫不可用。 |
403 | OperationDenied | The resource is out of usage. | 該實例不在運行狀態,請您啟動實例或檢查操作是否合理。 |
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 | InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. | 指定的可用區 ID 不存在。 |
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. | 指定的參數 DedicatedHostName 無效。 |
404 | InvalidZoneId.NotFound | The specified ZoneId does not exist. | 指定的可用區 ID 不存在。 |
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. | 指定的遷移方案不存在。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | InternalError | %s | 內部錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |