文档首页/ 专属主机 DeH/ API参考/ API/ 分配专属主机 - CreateDedicatedHost
更新时间：2026-01-05 GMT+08:00
查看PDF
分享

分配专属主机 - CreateDedicatedHost

功能介绍

分配一台或多台专属主机，需要设置实例规格、所属AZ、数量等参数。

约束条件

可分配的专属主机数量依赖于租户的专属主机配额。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1.0/{project_id}/dedicated-hosts

参数说明请参见表1。

表1 参数说明

参数

参数类型

是否必选

描述

project_id

String

是

项目ID。

获取方式请参见获取项目ID。

请求消息

表2 请求参数

参数

位置

参数类型

是否必选

描述

name

body

String

是

专属主机名称。

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成，且长度为[1-255]个英文字符或[1-64]个中文字符。

auto_placement

body

String

否

在创建云服务器时（未指定专属主机ID），是否允许云服务器自动分配在一台可用的专属主机上。

取值范围：“on”或“off”。

默认值：“on”。

availability_zone

body

String

是

专属主机所属AZ。

最大长度为255个字符。

host_type

body

String

是

专属主机类型。

支持的专属主机类型请参见规格族概述。

quantity

body

Integer

是

待分配的专属主机数量。

tags

body

Array of objects

否

专属主机标签列表。

详情见表3。

extend_param

body

Object

否

专属主机扩展属性。

详情见表4。
表3 tag字段数据结构说明

参数

参数类型

是否必选

描述

key

String

是

键。

  • 长度不超过36个Unicode字符。
  • 不能为空。
  • 不能包含以下ASCII非打印字符：“=”,“*”,“<”,“>”,“\”,“|”,“/”,“,”。

value

String

是

值。

  • 长度不超过43个Unicode字符。
  • 不能包含以下ASCII非打印字符：“=”,“*”,“<”,“>”,“\”,“|”,“/”,“,”。
表4 extend_param字段数据结构说明

参数

参数类型

是否必选

描述

charging_mode

String

否

专属主机计费模式，不传该参数时默认为postPaid。

  • prePaid：包周期
  • postPaid：按需

period_type

String

否

订购周期类型。当charging_mode为prePaid时生效。

  • month：包月
  • year：包年

period_num

Integer

否

订购周期数。

大于0的整数，当charging_mode为prePaid时生效，且该字段必选。

  • periodType=month（周期类型为月）时，取值为[1，2，3，4，5，6，7，8，9]。
  • periodType=year（周期类型为年）时，取值为[1，2，3]。

is_auto_pay

Boolean

否

是否自动支付。

  • true：是（自动支付）
  • false：否（需要客户手动支付）

is_auto_renew

Boolean

否

是否自动续费。

  • true：自动续订
  • false：不自动续订

enterprise_project_id

String

否

企业项目ID。

响应消息

表5 响应参数

参数

位置

参数类型

描述

job_id

body

String

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。

order_id

body

String

订单号，创建包年包月的专属主机时返回该参数。

请求示例

分配专属主机，分配的可用区为az1，专属主机名称为General Computing server1，类型为s3，数量为2台。 
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts
{
     "availability_zone": "dc1.az1",
     "name": "General Computing server1",
     "auto_placement": "off",
     "host_type": "c4",
     "quantity": 2,
     "tags": [
         {
             "key": "key1",
             "value": "value1"
         }
     ],
     "extend_param": {
         "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
     }
}

响应示例

{
    "job_id": "ff808082739334d80173943ec9b42130",
    "order_id": "CS2007281506xxxxx"
}

返回值

表6 返回值-错误码说明

错误码

说明

403 Forbidden
  1. 配额不足。
  2. 不支持该规格。

404 FlavorNotFound

该规格无效。

更多返回值，请参见状态码。

父主题： API

相关文档