# 创建云服务器 - CreateServers #### 功能介绍 创建一台或多台云服务器。 V1.1版本创建云服务器的接口兼容了V1版本[创建云服务器（按需） - CreatePostPaidServers](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212668.html)的功能，同时合入新功能，支持创建包年/包月的弹性云服务器。 本接口为异步接口，当前创建云服务器请求下发成功后会返回job_id，此时创建云服务器并没有立即完成，需要通过调用[查询任务的执行状态 - ShowJob](https://support.huaweicloud.com/api-ecs/ecs_02_0901.html)查询job状态，当Job状态为SUCCESS时代表云服务器创建成功。 本接口支持在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考[请求幂等性说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0000001105258814.html)。 弹性云服务器的登录鉴权方式包括两种：密钥对、密码。为安全起见，推荐使用密钥对方式。 - 密钥对 指使用密钥对作为弹性云服务器的鉴权方式。 接口调用方法：使用**key_name** 字段，指定弹性云服务器登录时使用的密钥文件，key_name字段的使用方法请参见[表2]。 - 密码 指使用设置初始密码方式作为弹性云服务器的鉴权方式，此时，您可以通过用户名密码方式登录弹性云服务器，Linux操作系统时为root用户的初始密码，Windows操作系统时为Administrator用户的初始密码。 接口调用方法：使用**adminPass** 字段，指定管理员账号的初始登录密码，adminPass字段的使用方法请参见[表2]。对于镜像已安装Cloud-init的Linux云服务器，如果需要使用密文密码，可以使用**user_data** 字段进行密码注入，具体请参见[表2]。 ![](https://support.huaweicloud.com/api-ecs/public_sys-resources/note_3.0-zh-cn.png) 对于安装Cloud-init镜像的Linux云服务器，若指定user_data字段，则adminPass字段不生效。 - 镜像密码 使用Linux操作系统私有镜像创建云服务器，支持使用私有镜像的密码。 接口调用方法：使用镜像密码，则无需指定**key_name** 、**adminPass**字段。 购买操作示例： - [使用API购买ECS过程中常见问题及处理方法](https://support.huaweicloud.com/api-ecs/ecs_04_0007.html) - [获取Token并检验Token的有效期](https://support.huaweicloud.com/api-ecs/ecs_04_0008.html) #### 接口约束 - 创建包年/包月云服务器时，支持自动支付和手动支付。 - 如果将请求中的isAutoPay字段设置为true，表示采用自动支付方式，系统会自动匹配账户支持的付款方式进行扣费。 - 自动支付支持的付款方式和顺序如下： 折扣优惠（每次只能使用一项）→代金券（每次只能使用一张）→现金券或储值卡（每次可使用多张，可同时使用）→账户余额（先扣现金额度后扣信用额度）或月末结算 - 如果上述付款方式无法完成支付，系统会自动生成一个待支付订单，您可以手动在控制台上选择支付方式进行支付。 自动支付的更多内容请参见[自动支付](https://support.huaweicloud.com/usermanual-billing/isautopay_topic_1000001.html)。 - 如果将请求中的isAutoPay字段设置为false，表示采用手动支付方式，系统会自动生成一个待支付订单，您可以手动在控制台上选择支付方式进行支付。 - 创建按需计费云服务器时，系统会自动匹配适用的代金券进行使用。 - 如果您需要退订该包年/包月资源，请参考"[退订包年/包月资源](https://support.huaweicloud.com/api-bpconsole/api_order_00019.html)"。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ECS&api=CreateServers)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ecs/ecs_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ecs:cloudServers:createServers | write | - | - g:RequestTag/\ - g:EnterpriseProjectId - g:TagKeys - ecs:imageID - ecs:FlavorId - ecs:VpcId - ecs:SubnetId - ecs:PortId - ecs:KmsKeyId - eip:AssociatePublicIp - ecs:AvailabilityZone - evs:Encrypted - cbr:VaultId - ecs:SSHKeyPairName - ecs:SupportAgentType - ecs:ImageSupportAgentType - ecs:ImageType - ecs:OsVersion - ecs:OsType - ecs:ImagePlatform | ecs:cloudServers:create | - eip:publicIps:create - eip:publicIps:associateInstance - iam:agencies:pass - eip:bandwidths:insertPublicIps | #### URI - URI格式 POST /v1.1/{project_id}/cloudservers - 参数说明 | 参数 | 是否必选 | 描述 | |:---|:---|:---| | project_id | 是 | **参数解释：** 项目ID。 获取方法请参见 [获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求消息 表1请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | server | 是 | Object | **参数解释：** 弹性云服务器信息，请参见[表2]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dry_run | 否 | Boolean | **参数解释** **：** 是否预检此次请求。配置为预检时，此次请求不会创建实例。 **约束限制：** 不涉及 **取值范围：** - true：预检此次请求，检查项包括是否填写了必需参数、请求格式等。 - 如果检查不通过，则返回对应错误。 - 如果检查通过，则返回202状态码。 - false：发送正常请求，不对请求体做预检。 **默认取值：** false | 表2创建云服务器请求参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | imageRef | 是 | String | **参数解释：** 待创建云服务器的系统镜像，需要指定已创建镜像的ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。 镜像的ID可以从控制台或者参考《镜像服务API参考》的[查询镜像列表](https://support.huaweicloud.com/api-ims/ims_03_0602.html)接口获取。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | flavorRef | 是 | String | **参数解释：** 待创建云服务器的系统规格的ID。 已上线的规格请参见《弹性云服务器产品介绍》的"[实例类型与规格](https://support.huaweicloud.com/productdesc-ecs/ecs_01_0008.html)"章节。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 云服务器名称。 创建的云服务器数量（count字段对应的值）大于1时，可以使用"自动排序"和"正则排序"设置有序的云服务器名称。 请参考[创建多台云服务器云主机时怎样设置有序的云服务器云主机名称？](https://support.huaweicloud.com/ecs_faq/ecs_faq_0620.html) **约束限制：** - 创建的云服务器数量（count字段对应的值）大于1时，为区分不同云服务器，创建过程中系统会自动在名称后加"-0000"的类似标记。若用户在名称后已指定"-0000"的类似标记，系统将从该标记后继续顺序递增编号。故此时名称的长度为\[1-59\]个字符。 - 弹性云服务器内部主机名(hostname)命名规则遵循 [RFC 952](https://tools.ietf.org/html/rfc952)和[RFC 1123](https://tools.ietf.org/html/rfc1123)命名规范，建议使用a-z或0-9以及中划线"-"组成的名称命名，"_"将在弹性云服务器内部默认转化为"-"。 **取值范围：** 只能由中文字符、英文字母、数字及"_"、"-"、"."组成，且长度为\[1-128\]个英文字符或\[1-64\]个中文字符。 **默认取值：** 不涉及 | | user_data | 否 | String | **参数解释：** 创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。 示例： base64编码前： - Linux服务器： ``` #!/bin/bash echo user_test > /home/user.txt ``` - Windows服务器： ``` rem cmd echo 111 > c:\aaa.txt ``` base64编码后： - Linux服务器： ``` IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA== ``` - Windows服务器： ``` cmVtIGNtZAplY2hvIDExMSA+IGM6XGFhYS50eHQ= ``` 更多关于待注入实例自定义数据的信息，请参见《弹性云服务器用户指南 》的"[用户数据注入](https://support.huaweicloud.com/usermanual-ecs/zh-cn_topic_0032380449.html)"章节。 **约束限制：** - user_data的值为base64编码之后的内容。 - 注入内容（编码之前的内容）最大长度为32K。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | adminPass | 否 | String | **参数解释：** 如果需要使用密码方式登录云服务器，可使用adminPass字段指定云服务器管理员账户初始登录密码。其中，Linux管理员账户为root，Windows管理员账户为Administrator。 **约束限制：** - 密码不能包含用户名或用户名的逆序。 - Windows系统密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。 - 对于安装Cloud-init镜像的Linux云服务器，若指定user_data字段，则adminPass字段不生效。 关于Cloud-init和Cloudbase-init的更多信息，请参见[Cloud-init/Cloudbase-init](https://support.huaweicloud.com/productdesc-ecs/ecs_01_0055.html)。 - 对于安装Cloud-init镜像的云服务器，若指定key_name字段，则adminPass字段不生效。 **取值范围：** - 长度为8-26位。 - 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%\^-_=+\[{}\]:,./?）中的三种。 **默认取值：** 不涉及 | | key_name | 否 | String | **参数解释：** 如果需要使用SSH密钥方式登录云服务器，请指定已创建密钥的名称。 密钥可以通过密钥创建接口进行创建（请参见[创建和导入SSH密钥对](https://support.huaweicloud.com/api-dew/CreateKeypair.html)），或使用SSH密钥查询接口查询已有的密钥（请参见[查询SSH密钥对列表](https://support.huaweicloud.com/api-dew/ListKeypairs.html)）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vpcid | 是 | String | **参数解释：** 待创建云服务器所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 VPC的ID可以从控制台或者参考《虚拟私有云API参考》的"[查询VPC](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)"章节获取。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | nics | 是 | Array of objects | **参数解释：** 待创建云服务器的网卡信息。详情请参见[表3] **约束限制：** - 主网卡对应的网络（network）必须属于vpcid对应的VPC。用户创建网卡时，指定的第一张网卡信息为主网卡。 - 当前单个弹性云服务器默认支持最多挂载12张网卡。 - 不同的规格对网卡上限有一定的区别，参考[规格清单](https://support.huaweicloud.com/productdesc-ecs/zh-cn_topic_0159822360.html)。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | publicip | 否 | Object | **参数解释：** 配置云服务器的弹性IP信息，弹性IP有三种配置方式。 - 不使用（无该字段） - 自动分配，需要指定新创建弹性IP的信息 - 使用已有，需要指定已创建弹性IP的信息 详情请参见[publicip字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section1846944811410)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不使用 | | count | 否 | Integer | **参数解释：** 创建云服务器数量。 **约束限制：** - 不传该字段时默认取值为1。 - 当extendparam结构中的chargingMode为postPaid（即创建按需付费的云服务器），且租户的配额足够时，最大值为100。 - 当extendparam结构中的chargingMode为prePaid（即创建包年包月付费的云服务器）时，该值取值范围为\[1，100\]。但一次订购不要超过400个资源（比如购买一个弹性云服务器，至少包含了1个云主机、1个系统盘，有可能还包含数据盘、弹性IP、带宽多个资源，这些都属于资源，会算到400个内），超过400个资源时报错。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | isAutoRename | 否 | Boolean | **参数解释：** 批量创建时是否使用相同的名称。 **约束限制：** 当count大于1的时候该参数生效。 **取值范围：** - true，表示使用相同名称。 - false，表示自动增加后缀。 **默认取值：** false | | root_volume | 是 | Object | **参数解释：** 云服务器对应系统盘相关配置。 创建包年/包月的弹性云服务器的时候，创建的系统盘/数据盘也是包年/包月，周期和弹性云服务器一致 详情请参见[表5]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | data_volumes | 否 | Array of objects | **参数解释：** 云服务器对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。 **约束限制：** 目前弹性云服务器最多可挂载59块数据盘（部分规格只支持23块数据盘） 详情请参见[表6]。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | security_groups | 否 | Array of objects | **参数解释：** 云服务器对应安全组信息。 **约束限制：** 当该值指定为空时，默认给云服务器绑定default安全组。 详情请参见[security_groups字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section332191084315)。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | availability_zone | 否 | String | **参数解释：** 待创建云服务器所在的可用区，需要指定可用分区名称。 可通过接口 [查询可用区列表（废弃） - NovaListAvailabilityZones](https://support.huaweicloud.com/api-ecs/ecs_03_1801.html) 获取，也可参考[地区和终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/ECS)获取。 **约束限制**： - 如果为空，会自动指定一个符合要求的可用区。 - 如果在专属主机上创建云服务器，需指定云服务器与专属主机所在可用区一致。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | batch_create_in_multi_az | 否 | Boolean | **参数解释：** 是否支持随机多AZ部署。 **约束限制：** 当availability_zone为空时该字段生效。 **取值范围：** - true：批量创建的ecs部署在多个AZ上 - false：批量创建的ecs部署在单个AZ上 **默认取值：** false | | extendparam | 否 | Object | **参数解释：** 创建云服务器附加信息。 详情请参见[表9](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__table7721122141311)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | metadata | 否 | Map\ | **参数解释：** 创建云服务器元数据。 可以通过元数据自定义键值对。系统预留键值对请参见[表11](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__table2373623012315)。 **约束限制：** 如果元数据中包含了敏感数据，您应当采取适当的措施来保护敏感数据，比如限制访问范围、加密等。 **取值范围：** - 最多可注入10对键值（Key/Value）。 - 主键（Key）：只能由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、中划线（-）、下划线（_）、冒号（:）、空格（ ）和小数点（.）组成，长度为\[1-255\]个字符。 - 值（value）：最大长度为255个字符。 **默认取值：** 不涉及 | | os:scheduler_hints | 否 | Object | **参数解释：** 云服务器调度信息，例如设置云服务器组。 详情请参见[表12](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__table24430409172542)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | tags | 否 | Array of strings | **参数解释：** 弹性云服务器的标签。标签的格式为"key.value"。 **约束限制：** - 创建弹性云服务器时，一台弹性云服务器最多可以添加20个标签。 - 云服务新增server_tags字段，该字段与tags字段功能相同，支持的key、value取值范围更广，建议使用server_tags字段。 **取值范围：** - key的长度不超过128个字符，value的长度不超过255个字符。 - 标签的key值： - 只能包含大写字母（A\~Z）、小写字母（a\~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。 - 不能包含"="、"\*"、"\<"、"\>"、"\\"、","、"\|"、"/"。 - 标签的value值： - 只能包含大写字母（A\~Z）、小写字母（a\~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。 - 不能包含"="、"\*"、"\<"、"\>"、"\\"、","、"\|"。 **默认取值：** 不涉及 | | server_tags | 否 | Array of objects | **参数解释：** 弹性云服务器的标签。详情请参见[server_tags字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section137661941116)。 **约束限制：** - 创建弹性云服务器时，一台弹性云服务器最多可以添加20个标签。 - 云服务新增server_tags字段，该字段与tags字段功能相同，支持的key、value取值范围更广，建议使用server_tags字段。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | description | 否 | String | **参数解释：** 云服务器描述信息。 **约束限制：** 不能包含"\<" 和 "\>"。 **取值范围：** 长度最多允许85个字符。 **默认取值：** 空字符串 | | auto_terminate_time | 否 | String | **参数解释：** 定时删除时间。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 示例：2020-09-25T12:05:00Z **约束限制：** - 仅按需实例支持设置定时删除时间。 - 该字段当前仅在华北-北京四、华南-广州区域生效。 - 如果秒（ss）取值不是 00，则自动取为当前分钟（mm）开始时。 - 最短定时删除时间为当前时间半小时之后。 - 最长定时删除时间不能超过当前时间三年。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | cpu_options | 否 | Object | **参数解释：** 自定义CPU选项。 详情请参见[表7]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | enclave_options | 否 | Object | **参数解释：** Enclave使能开关。 详情请参见[表8]。 **约束限制：** 目标flavor的os_extra_specs参数必须包含"security:enclave_supported"字段。 os_extra_specs参数详情可通过调用[查询规格详情和规格扩展信息列表 - ListFlavors](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212656.html)接口进行查询。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | security_options | 否 | Object | **参数解释：** 安全启动选项security_options。 详情请参见[表9]。 **约束限制：** 目标flavor的os_extra_specs参数： - 包含"security:secure_boot_supported"字段，支持安全启动。 - 包含"security:tpm_supported"字段，支持vtpm。 os_extra_specs参数详情可通过调用[查询规格详情和规格扩展信息列表 - ListFlavors](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212656.html)接口进行查询。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | serial_console_options | 否 | Object | **参数解释：** 是否支持串口登录。 详情请参见[表10]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | metadata_options | 否 | Object | **参数解释：** 实例元数据配置。 详情请参见[表11]。 **约束限制：** 该参数仅在"拉美-圣保罗一"区域支持，其他区域暂不支持。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3nics字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | port_id | 否 | String | **参数解释：** 网卡ID，UUID格式。 当该字段不为空时，表示挂载指定的网卡。 网卡ID可以从虚拟私有云的[查询端口列表](https://support.huaweicloud.com/api-vpc/vpc_port01_0003.html)接口查询到。 **约束限制：** - 网卡状态必须为DOWN。 - 若主网卡为弹性网卡，则该网卡的vpcid必须和传入的vpcid一致。 - port_id和subnet_id不能同时为空。 - 当port_id和subnet_id同时存在的时候，优先使用port_id。 - 当选择port_id不为空时，代表此时使用的是弹性网卡，此时security_groups和ip_address等参数不生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | subnet_id | 否 | String | **参数解释：** 待创建云服务器所在的子网信息。 **约束限制：** 需要指定vpcid对应VPC下已创建的子网（subnet）的网络ID，UUID格式。 可以通过VPC服务[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)接口查询。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ip_address | 否 | String | **参数解释：** 待创建云服务器网卡的IP地址，IPv4格式。 **约束限制：** - 不填或空字符串，默认在子网（subnet）中自动分配一个未使用的IP作网卡的IP地址。 - 若指定IP地址，该IP地址必须在子网（subnet）对应的网段内，且未被使用。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ipv6_enable | 否 | Boolean | **参数解释：** 是否支持ipv6。 **约束限制：** 不涉及 **取值范围：** - true，表示此网卡支持ipv6。 - false，表示此网卡不支持ipv6 **默认取值：** false | | ipv6_bandwidth | 否 | Object | **参数解释：** 绑定的共享带宽信息，详情请参见[ipv6_bandwidth字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section2872318176)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | allowed_address_pairs | 否 | Array of [allow_address_pair] objects | **参数解释：** IP/Mac对列表，详情请参见[表4](扩展属性)。 **约束限制：** - IP地址不允许为 "0.0.0.0/0"。 - 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 - 如果allowed_address_pairs为"1.1.1.1/0"，表示关闭源目的地址检查开关。 - 如果是虚拟IP绑定云服务器， - 则mac_address可为空或者填写被绑定云服务器网卡的Mac地址。 - 被绑定的云服务器网卡allowed_address_pairs的IP地址填"1.1.1.1/0"。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | efi_enable | 否 | Boolean | **参数解释：** 使能网卡的efi能力，只支持从网卡，主网卡不支持。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4allow_address_pairs对象 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | ip_address | 否 | String | **参数解释：** IP地址。 **约束限制：** - 不支持0.0.0.0/0 - 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | mac_address | 否 | String | **参数解释：** MAC地址。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表5root_volume字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | volumetype | 是 | String | **参数解释：** 云服务器系统盘对应的磁盘类型。 了解不同磁盘类型的详细信息，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)。 **约束限制：** - 当指定的云硬盘类型在availability_zone内不存在时，则创建云硬盘失败。 **取值范围：** 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"和"ESSD2"。 - "SATA"为普通IO云硬盘（已售罄） - "SAS"为高IO云硬盘 - "GPSSD"为通用型SSD云硬盘 - "SSD"为超高IO云硬盘 - "ESSD"为极速型SSD云硬盘 - "GPSSD2"为通用型SSD V2云硬盘 - "ESSD2"为极速型SSD V2云硬盘 **默认取值：** 不涉及 | | size | 否 | Integer | **参数解释：** 系统盘大小，容量单位为GiB。 **约束限制：** - 系统盘大小取值应不小于镜像支持的系统盘的最小值（镜像的min_disk属性，若无min_disk，则取default_disk属性）。 - 若该参数没有指定或者指定为0时，系统盘大小默认取值为镜像中系统盘的最小值。 说明： 镜像系统盘的最小值（镜像的min_disk属性）可通过调用"[查询镜像列表](https://support.huaweicloud.com/api-ims/ims_03_0602.html)"API获取。 **取值范围：** 输入大小范围为\[1,1024\] **默认取值：** 不涉及 | | extendparam | 否 | Object | **参数解释：** 磁盘的扩展参数。 详情请参见[创建磁盘的extendparam字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section1361484104817)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | cluster_type | 否 | String | **参数解释：** 云服务器系统盘对应的磁盘存储类型。 **约束限制：** 该参数需要与"cluster_id"配合使用，仅当"cluster_id"不为空时，才可以成功创建专属存储类型的磁盘。 **取值范围：** 磁盘存储类型枚举值：DSS（专属存储类型） **默认取值：** 不涉及 | | cluster_id | 否 | String | **参数解释：** 云服务器系统盘对应的存储池的ID。 可通过接口[获取专属存储详情列表](https://support.huaweicloud.com/api-dss/dss_02_1002.html)获取。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hw:passthrough | 否 | Boolean | **参数解释：** 设置云硬盘的设备类型。 **约束限制：** 非QingTian规格仅支持设置系统盘为VBD类型。 **取值范围：** - 参数指定为false，创建VBD类型磁盘。 - 参数指定为true，创建SCSI类型磁盘。 **默认取值：** 参数未指定或者指定非Boolean类型的字符，默认创建VBD类型磁盘。 | | metadata | 否 | Object | **参数解释：** 创建云硬盘的metadata信息。详情请参见[创建磁盘的metadata字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section1228814491353)。 **约束限制：** 仅在创建加密盘时使用metadata字段。 **取值范围：** metadata中的key和value长度不大于255个字节。 **默认取值：** 不涉及 | | iops | 否 | Integer | **参数解释：** 为云硬盘配置iops。 了解GPSSD2、ESSD2类型云硬盘的iops，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **约束限制：** - 当"volumetype"设置为GPSSD2、ESSD2类型的云硬盘时，该参数必填，其他类型无需设置。 - 仅支持按需计费。 **取值范围：** - GPSSD2：3000\~128000 - ESSD2：100\~256000 **默认取值：** 不涉及 | | throughput | 否 | Integer | **参数解释：** 为云硬盘配置吞吐量，单位是MiB/s。 了解GPSSD2类型云硬盘的吞吐量大小范围，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **约束限制：** - 当"volumetype"设置为GPSSD2类型的云硬盘时必填，其他类型不能设置。 - 仅支持按需计费 **取值范围：** - GPSSD2：125 MiB/s\~1000 MiB/s - ESSD2：256 MiB/s\~ 4000 MiB/s **默认取值：** 不涉及 | 表6data_volumes字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | volumetype | 是 | String | **参数解释：** 云服务器数据盘对应的磁盘类型。 了解不同磁盘类型的详细信息，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)。 **约束限制：** - 当指定的云硬盘类型在availability_zone内不存在时，则创建云硬盘失败。 **取值范围：** 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"和"ESSD2"。 - "SATA"为普通IO云硬盘（已售罄） - "SAS"为高IO云硬盘 - "GPSSD"为通用型SSD云硬盘 - "SSD"为超高IO云硬盘 - "ESSD"为极速型SSD云硬盘 - "GPSSD2"为通用型SSD V2云硬盘 - "ESSD2"为极速型SSD V2云硬盘 **默认取值：** 不涉及 | | size | 是 | Integer | **参数解释：** 数据盘大小，容量单位为GiB。 **约束限制：** 如果使用数据盘镜像创建数据盘时，size取值不能小于创建数据盘镜像的源数据盘的大小。 **取值范围：** 输入大小范围为\[10,32768\]。 **默认取值** **：** 不涉及 | | shareable | 否 | Boolean | **参数解释：** 是否为共享磁盘。 **约束限制：** 该字段已废弃，请使用multiattach。 **取值范围：** - true：创建的磁盘为共享盘。 - false：创建的磁盘为普通云硬盘。 **默认取值：** false | | multiattach | 否 | Boolean | **参数解释：** 创建共享磁盘的信息。 **约束限制：** shareable当前为废弃字段，如果确实需要同时使用shareable字段和multiattach字段，此时，请确保两个字段的参数值相同。当不指定该字段时，系统默认创建普通云硬盘。 **取值范围：** - true：创建的磁盘为共享盘。 - false：创建的磁盘为普通云硬盘。 **默认取值：** false | | hw:passthrough | 否 | Boolean | **参数解释：** 设置云硬盘的设备类型。 **约束限制：** 非QingTian规格仅支持设置系统盘为VBD类型。 **取值范围：** - 参数指定为false，创建VBD类型磁盘。 - 参数指定为true，创建SCSI类型磁盘。 - 参数未指定或者指定非Boolean类型的字符，默认创建VBD类型磁盘。 **默认取值：** 不涉及 | | extendparam | 否 | Object | **参数解释：** 磁盘的扩展参数。 详情请参见[表7](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__table7562101331712)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | cluster_type | 否 | String | **参数解释：** 云服务器数据盘对应的磁盘存储类型。 **约束限制：** 该参数需要与"cluster_id"配合使用，仅当"cluster_id"不为空时，才可以成功创建专属存储类型的磁盘。 **取值范围：** 磁盘存储类型枚举值：DSS（专属存储类型） **默认取值：** 不涉及 | | cluster_id | 否 | String | **参数解释：** 云服务器数据盘对应的存储池的ID。 可通过接口[获取专属存储详情列表](https://support.huaweicloud.com/api-dss/dss_02_1002.html)获取。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | data_image_id | 否 | String | **参数解释：** 数据镜像的ID，UUID格式。 可通过接口[查询镜像列表](https://support.huaweicloud.com/api-ims/ims_03_0602.html)获取。 **约束限制：** 如果使用数据盘镜像创建数据盘，则data_image_id为必选参数，且不支持使用metadata。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | metadata | 否 | Object | **参数解释：** 创建云硬盘的metadata信息。 详情请参见[创建磁盘的metadata字段数据结构说明](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0167957246.html#ZH-CN_TOPIC_0167957246__section1228814491353)。 **约束限制：** - metadata中的key和value长度不大于255个字节。 - 仅在创建加密盘时使用metadata字段。 - 如果使用数据盘镜像创建数据盘，不支持使用metadata。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | delete_on_termination | 否 | Boolean | **参数解释：** 数据盘随实例释放策略。 **约束限制：** 该字段仅按需、竞价实例支持。 **取值范围：** - true：数据盘随实例释放。 - false：数据盘不随实例释放。 **默认取值：** false | | iops | 否 | Integer | **参数解释：** 为云硬盘配置iops。 了解GPSSD2、ESSD2类型云硬盘的iops，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **约束限制：** - 当"volumetype"设置为GPSSD2、ESSD2类型的云硬盘时，该参数必填，其他类型无需设置。 - 仅支持按需计费。 **取值范围：** - GPSSD2：3000\~128000 - ESSD2：100\~256000 **默认取值：** 不涉及 | | throughput | 否 | Integer | **参数解释：** 为云硬盘配置吞吐量，单位是MiB/s。 了解GPSSD2类型云硬盘的吞吐量大小范围，请参见[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **约束限制：** - 当"volumetype"设置为GPSSD2类型的云硬盘时必填，其他类型不能设置。 - 仅支持按需计费。 **取值范围：** - GPSSD2：125 MiB/s\~1000 MiB/s - ESSD2：256 MiB/s\~ 4000 MiB/s **默认取值：** 不涉及 | 表7cpu_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | hw:cpu_threads | 否 | Integer | **参数解释：** 用于控制CPU是否开启超线程。 **约束限制：** 需要同时满足如下条件，才能设置为"关闭超线程"： - 只能在实例创建或者resize时指定。 - 只有目标flavor的os_extra_specs参数： - 存在"hw:cpu_policy"并取值为"dedicated"。 - 存在"hw:cpu_threads"并取值为"2"。 os_extra_specs参数详情可通过调用[查询规格详情和规格扩展信息列表 - ListFlavors](https://support.huaweicloud.com/api-ecs/zh-cn_topic_0020212656.html)接口进行查询。 **取值范围：** - 1: 关闭超线程。 - 2: 打开超线程。 **默认取值：** 1: 关闭超线程 | 表8enclave_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enabled | 否 | Boolean | **参数解释：** enclave使能开关。 **约束限制：** 不涉及 **取值范围：** - true: 打开enclave。 - false: 关闭enclave。 **默认取值：** false | 表9security_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | secure_boot_enabled | 否 | Boolean | **参数解释：** 安全启动开关。 **约束限制：** 不涉及 **取值范围：** - true: 打开安全启动。 - false: 关闭安全启动。 **默认取值：** false | | tpm_enabled | 否 | Boolean | **参数解释：** tpm启动开关。 **约束限制：** 不涉及 **取值范围：** - true: 打开tpm。 - false: 关闭tpm。 **默认取值：** false | 表10serial_console_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enabled | 否 | Boolean | **参数解释：** 是否支持串口登录。 **约束限制：** 不涉及 **取值范围：** - true：支持串口登录。 - false：不支持串口登录。 **默认取值：** false | 表11metadata_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | http_endpoint | 否 | String | **参数解释：** 是否启用IMDS服务。 **约束限制：** 不涉及 **取值范围：** - enabled：启用IMDS服务 - disabled：禁用IMDS服务 **默认取值：** enabled | | http_tokens | 否 | String | **参数解释：** 是否要求携带token。 **约束限制：** 不涉及 **取值范围：** - optional：不要求携带token - required：要求必须携带token，即IMDS服务禁用v1版本，启用v2版本 **默认取值：** optional | #### 响应消息 表12响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释：** 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态，请参考[查询Job状态](https://support.huaweicloud.com/api-ecs/ecs_02_0900.html)。 **取值范围：** 不涉及 | | order_id | String | **参数解释：** 订单号，创建包年包月的弹性云服务器时返回该参数。 说明： - 创建包年/包月云服务器资源后，请参考"[支付包年/包月产品订单](https://support.huaweicloud.com/api-bpconsole/api_order_00016.html)"进行支付。 - 如果需要查询订单的资源开通详情，请参考"[查询订单详情](https://support.huaweicloud.com/api-oce/api_order_00014.html)"。 - 如果需要退订该包年/包月资源，请参考"[退订包年/包月资源](https://support.huaweicloud.com/api-oce/api_order_00019.html)"。 **取值范围：** 不涉及 | | serverIds | Array of strings | **参数解释：** 云服务器ID列表。 说明： 通过云服务器ID查询云服务器详情 ，若返回404 可能云服务器还在创建或者已经创建失败。 **取值范围：** 不涉及 | 异常响应请参考[响应（任务类）](https://support.huaweicloud.com/api-ecs/ecs_07_0005.html)，异常响应要素说明。 #### 请求示例 - 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的弹性公网IP，采用密钥方式登录鉴权。 ``` POST https://{endpoint}/v1.1/{project_id}/cloudservers { "server": { "availability_zone":"az1-dc1", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100 }, { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s2.small.1", "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", "security_groups": [ { "id": "6242ef48-4d35-49c8-8711-a6e54902e44a" } ], "nics": [ { "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08" } ], "publicip": { "eip": { "iptype": "5_sbgp", "bandwidth": { "size": 1, "sharetype": "PER" } } }, "key_name": "id_rsa", "count": 1, "metadata": { "op_svc_userid": "f79791beca3c48159ac2553fff22e166" }, "extendparam": { "chargingMode": "prePaid", "periodType": "month", "periodNum": 1, "isAutoRenew": "true", "isAutoPay": "true", "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "os:scheduler_hints": { "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc" } } } ``` - 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的弹性公网IP，采用密码方式登录鉴权请求中的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 ``` POST https://{endpoint}/v1.1/{project_id}/cloudservers { "server": { "availability_zone":"az1-dc1", "name": "newserver", "adminPass": "$ADMIN_PASS", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100 }, { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s2.small.1", "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", "security_groups": [ { "id": "6242ef48-4d35-49c8-8711-a6e54902e44a" } ], "nics": [ { "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08" } ], "publicip": { "eip": { "iptype": "5_sbgp", "bandwidth": { "size": 1, "sharetype": "PER" } } }, "count": 1, "metadata": {}, "extendparam": { "chargingMode": "prePaid", "periodType": "month", "periodNum": 1, "isAutoRenew": "true", "isAutoPay": "true", "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "os:scheduler_hints": { "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc" } } } ``` - 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的按需按流量计费的弹性公网IP，采用密钥方式登录鉴权。 ``` POST https://{endpoint}/v1.1/{project_id}/cloudservers { "server": { "availability_zone":"az1-dc1", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100 }, { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s2.small.1", "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", "security_groups": [ { "id": "6242ef48-4d35-49c8-8711-a6e54902e44a" } ], "nics": [ { "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08" } ], "publicip": { "eip": { "iptype": "5_sbgp", "bandwidth": { "size": 1, "sharetype": "PER", "chargemode": "traffic" }, "extendparam": { "chargingMode": "postPaid" } } }, "key_name": "id_rsa", "count": 1, "metadata": { "op_svc_userid": "f79791beca3c48159ac2553fff22e166" }, "extendparam": { "chargingMode": "prePaid", "periodType": "month", "periodNum": 1, "isAutoRenew": "true", "isAutoPay": "true", "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "os:scheduler_hints": { "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc" } } } ``` - 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定共享带宽的弹性公网IP，采用密钥方式登录鉴权。 ``` POST https://{endpoint}/v1.1/{project_id}/cloudservers { "server": { "availability_zone":"az1-dc1", "name": "newserver", "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100 }, { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s2.small.1", "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", "security_groups": [ { "id": "6242ef48-4d35-49c8-8711-a6e54902e44a" } ], "nics": [ { "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08" } ], "publicip": { "eip": { "iptype": "5_sbgp", "bandwidth": { "id": "a0d4b26f-699d-49a0-bcc8-6f707a925abf", "sharetype": "WHOLE" } } }, "key_name": "id_rsa", "count": 1, "metadata": { "op_svc_userid": "f79791beca3c48159ac2553fff22e166", "agency_name": "test" }, "extendparam": { "chargingMode": "prePaid", "periodType": "month", "periodNum": 1, "isAutoRenew": "true", "isAutoPay": "true", "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb" }, "os:scheduler_hints": { "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc" } } } ``` - 发送预校验请求，检查创建云服务器的请求消息是否填写了必选参数，请求格式是否正确。 ``` POST https://{endpoint}/v1.1/{project_id}/cloudservers { "dry_run": true, "server": { "availability_zone":"az1-dc1", "name": "server", "imageRef": "ff49b1f1-3e3e-4913-89c6-a026041661e8", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100 }, { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s2.large.2", "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", "security_groups": [ { "id": "507ca48f-814c-4293-8706-300564d54620" } ], "nics": [ { "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" } ], "key_name": "sshkey-123" } } ``` #### 响应示例 ``` { "job_id": "ff808082739334d80173943ec9b42130", "order_id": "CS2007281506xxxxx", "serverIds": [ "fe0528f0-5b1c-4c8c-9adf-e5d5047b8c17", "679854ae-a50d-40c9-8132-b19bf3a306a1" ] } ``` 或 ``` { "error": { "code": "Ecs.0005", "message": "request body is illegal." } } ``` 或 ``` { "error": { "message": "privateIp [%s] is not in this subnet [%s]", "code": "Ecs.0005", "details": [ { "code": "Ecs.0039" } ] } } ``` #### 返回值 请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-ecs/ecs_07_0002.html)。