文档

AllocateDedicatedHosts - 创建一台或多台按量付费或者包年包月专有宿主机

更新时间:

调用AllocateDedicatedHosts创建一台或多台按量付费或者包年包月专有宿主机。专有宿主机是单租户独享的物理机资源,您可以在专有宿主机上自行创建ECS实例和获取物理服务器属性等信息。

接口说明

创建专有宿主机前,您可以调用 DescribeAvailableResource 查看指定地域或者可用区内的资源供给情况。

创建专有宿主机会产生费用,建议您提前了解资源的计费方式。更多详情,请参见计费概述

  • 单次最多能创建 100 台包年包月或按量付费专有宿主机。
  • 创建成功后,您可以将返回的专有宿主机 ID 列表作为请求参数,调用 DescribeDedicatedHosts 查询新建专有宿主机状态。
  • 提交创建专有宿主机的请求后,指定的参数值不合规或者库存不足时会报错。具体的报错原因,请参见错误码。
  • 创建专有宿主机后,您可以通过 ModifyInstanceDeployment 将 ECS 实例从共享宿主机迁移到专有宿主机,也可以在两台专有宿主机上调整实例部署。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:AllocateDedicatedHostsWrite
  • DedicatedHost
    acs:ecs:{#regionId}:{#accountId}:ddh/*

请求参数

名称类型必填描述示例值
RegionIdstring

专有宿主机所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
Tagobject []

标签列表。

Keystring

专有宿主机的标签键。N 的取值范围:1~20。

一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 或者 acs:开头,不能包含http://或者https://

Environment
Valuestring

专有宿主机的标签值。N 的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含http://或者https://

Production
ResourceGroupIdstring

专有宿主机要加入的资源组 ID。

rg-bp67acfmxazb4ph***
ZoneIdstring

专有宿主机所属的可用区编号。

默认值:空,表示由系统选择。

cn-hangzhou-f
DedicatedHostNamestring

专有宿主机的名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

myDDH
DedicatedHostClusterIdstring

专有宿主机所属的专有宿主机集群 ID。

dc-bp12wlf6am0vz9v2****
DedicatedHostTypestring

专有宿主机的规格。您可以调用 DescribeDedicatedHostTypes 接口获得最新的专有宿主机规格表。

ddh.c5
ActionOnMaintenancestring

当专有宿主机发生故障或者在线修复时,为其所宿实例设置迁移方案。取值范围:

  • Migrate:迁移实例到其他物理机并重新启动实例。

    当专有宿主机上挂载云盘存储时,默认值:Migrate。

  • Stop:在当前专有宿主机上停止实例,确认无法修复专有宿主机后,迁移实例到其他物理机并重新启动实例。

    当专有宿主机上挂载本地盘存储时,默认值:Stop。

Migrate
NetworkAttributes.SlbUdpTimeoutinteger

负载均衡连接的 UDP 会话超时时间,单位:秒。取值范围:15~310。

60
NetworkAttributes.UdpTimeoutinteger

为专有宿主机上运行的云服务设置用户访问的 UDP 会话超时时间,单位:秒。取值范围:15~310。

60
Descriptionstring

专有宿主机的描述。长度为 2~256 个英文或中文字符,不能以http://https://开头。

This-is-my-DDH
AutoPlacementstring

专有宿主机是否加入自动部署资源池。当您在专有宿主机上创建实例,却不指定 DedicatedHostId 时,阿里云将自动从加入资源池的专有宿主机中,为您选取适合的宿主机部署实例,更多信息,请参见自动部署功能介绍。取值范围:

  • on:加入自动部署资源池。

  • off:不加入自动部署资源池。

默认值:on。

说明 若您不希望专有宿主机加入自动部署资源池,请将该参数设置为 off。
off
CpuOverCommitRatiofloat

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
MinQuantityinteger

指定专有宿主机的最小购买数量。取值范围:1~100。

说明 当专有宿主机的库存小于最小购买数量时,创建专有宿主机将会失败。
2
ChargeTypestring

专有宿主机的计费方式。取值范围:

  • PrePaid:包年包月。选择包年包月时,请确认您的支付方式支持余额或者信用额度支付,否则会提示InvalidPayMethod

  • PostPaid:按量付费。

默认值:PostPaid。

PrePaid
Quantityinteger

本次创建的专有宿主机的数量。取值范围:1~100。

默认值:1。

2
Periodinteger

购买专有宿主机的包年包月时长。当参数ChargeType取值为PrePaid时,Period参数方可生效并为必选参数。取值范围:

  • PeriodUnit=Week 时:1、2、3、4。
  • PeriodUnit=Month 时:1、2、3、4、5、6、7、8、9、12、24、36、48、60。
  • PeriodUnit=Year 时:1、2、3、4、5。
6
PeriodUnitstring

购买专有宿主机的时长单位。取值范围:

  • Week
  • Month
  • Year

默认值:Month。

Month
AutoRenewboolean

是否自动续费包年包月专有宿主机。

说明 当参数 ChargeType 取值 PrePaid 时,AutoRenew 参数方可生效。

默认值:false。

false
AutoRenewPeriodinteger

单次自动续费的周期。当参数 AutoRenew 为 true 时,AutoRenewPeriod 参数方可生效,并为必选参数。取值范围:

  • PeriodUnit=Week 时:1、2、3。
  • PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。
1
AutoReleaseTimestring

专有宿主机自动释放时间。需按照 ISO 8601 标准表示,并使用 UTC+0 时间,格式为yyyy-MM-ddTHH:mm:ssZ

说明
  • 最短设置为当前时间之后半小时。
  • 最长不能超过当前时间之后三年。
  • 若参数值中的秒(ss)不是 00,则自动取为 00。
  • 2019-08-21T12:30:24Z
    ClientTokenstring

    保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

    123e4567-e89b-12d3-a456-426655440000

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    RequestIdstring

    请求 ID。

    E2A664A6-2933-4C64-88AE-5033D003****
    DedicatedHostIdSetsarray

    专有宿主机 ID(DedicatedHostId)组成的列表。

    string

    专有宿主机 ID(DedicatedHostId)。

    "DedicatedHostIdSets":{"DedicatedHostId":["dh-bp67acfmxazb4p****", "dh-bp67acfmxazb4d****"]}

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.指定的实例规格未授权使用。
    400InvalidDescription.MalformedThe specified parameter "Description" is not valid.指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
    400InvalidParameter.ConflictThe specified region and cluster do not match.指定的地域与指定的集群不匹配。
    400InvalidAutoRenewPeriod.ValueNotSupportedThe specified autoRenewPeriod is not valid.指定的参数 AutoRenewPeriod 不合法。
    400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
    400InvalidDedicatedHostType.ValueNotSupported%s指定的专有宿主机类型无效。
    400RegionUnauthorized%s该地域未被授权。%s为变量,将根据调用API的实际情况动态返回错误信息。
    400Zone.NotOnSale%s该可用区暂时关闭了售卖。%s为变量,将根据调用API的实际情况动态返回错误信息。
    400OperationDeniedThe specified DedicatedHostType or Zone is not available or not authorized.指定宿主机规格、可用区不可用或者没有操作的权限。
    400InvalidPeriodUnit.ValueNotSupportedThe specified parameter PeriodUnit is not valid.参数 PeriodUnit 无效。
    400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
    400QuotaExceed.AfterpayDedicatedHostThe maximum number of Pay-As-You-Go DedicatedHosts is exceeded: %s按量付费的宿主机库存不足,请减少创建数量。
    400InvalidChargeType.ValueNotSupportedChargeType is not valid付费类型无效。
    400InvalidParameter.SlbUdpTimeoutThe specified value is invalid.指定的参数 SlbUdpTimeout 无效。
    400InvalidParameter.UdpTimeoutThe specified value is invalid.指定的参数 UdpTimeout 无效。
    400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
    400InvalidParameter.QuantityThe specified Quantity is invalid.-
    400InvalidDedicatedHostPrice.NotFoundThe specified Dedicated price is not found.-
    400InvalidDedicatedHostType.CpuOverCommitRatioNotSupported%s-
    400InvalidCpuOverCommitRatio.ValueNotSupported%s-
    403OperationDeniedThe creation of Host to the specified Zone is not allowed.无法在指定可用区创建专用宿主机。
    403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.库存不足。
    403OperationDeniedSales of this resource are temporarily suspended in the specified region; please try again later.指定的地域暂时关闭了此资源的售卖,请稍后重试。
    403NodeControllerUnavailableThe Node Controller is temporarily unavailable.节点控制器暂不可用。
    403OperationDeniedThe resource is out of usage.该实例不在运行状态,请您启动实例或检查操作是否合理。
    403InvalidParameter.ResourceOwnerAccountResourceOwnerAccount is Invalid.指定的 ResourceOwnerAccount 不合法。
    403InvalidUserData.ForbiddenUser not authorized to input the parameter "UserData", please apply for permission "UserData"-
    403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.用户未被授权购买指定的可用区的资源。
    403Zone.NotOnSaleThe specified zone is not available for purchase.指定可用区已经售罄,请您更换实例规格或者更换地域创建。
    403InvalidResourceType.NotSupported%s-
    403InvalidDedicatedHostType.ValueNotSupportedThe specified DedicatedHostType does not exist or beyond the permitted range.指定的宿主机规格不存在。
    403InvalidDedicatedHostType.ZoneNotSupportedThe specified zone does not support this dedicatedHostType.指定可用区不支持指定宿主机规格。
    403InvalidUserData.Base64FormatInvalidThe specified UserData is not valid指定的UserData参数编码出错
    403InvalidParameter.NotMatch%s您输入的参数无效,请检查参数之间是否冲突。
    403Account.ArrearageYour account has been in arrears.账户余额不足,请先充值再操作。
    404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.指定的可用区 ID 不存在。
    404OperationDeniedAnother Host has been creating另一个宿主机正在创建。
    404PaymentMethodNotFoundNo payment method has been registered on the account.账户尚未注册支付方式。
    404InvalidDedicatedHostName.MalformedThe specified parameter DedicatedHostName is not valid.指定的参数 DedicatedHostName 无效。
    404InvalidZoneId.NotFoundThe specified ZoneId does not exist.指定的可用区 ID 不存在。
    404InvalidDedicatedHostClusterId.NotFoundThe specified DedicatedHostClusterId does not exist.-
    404InvalidDedicatedHostClusterId.ExceedMaxSizeThe specified Dedicated Host Cluster exceeded max capacity.-
    404InvalidParameter.ActionOnMaintenanceThe specified ActionOnMaintenance does not exist.指定的迁移方案不存在。
    500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。
    500InternalError%s内部错误。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-09-04OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    • 本页导读 (1)