调用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 参数方可生效，并为必选参数。取值范围： PeriodUnit=Month 时：1、2、3、6、12。 | 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 错误码发生变更 | 查看变更详情 |