创建云服务器

server

是

Object

参数解释：

弹性云服务器信息，请参见表2。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dry_run

否

Boolean

参数解释：

是否预检此次请求。配置为预检时，此次请求不会创建实例。

约束限制：

不涉及

取值范围：

• true：预检此次请求，检查项包括是否填写了必需参数、请求格式等。
  • 如果检查不通过，则返回对应错误。
  • 如果检查通过，则返回202状态码。

• false：不预检此次请求

默认取值：

false

imageRef

是

String

参数解释：

待创建云服务器的系统镜像，需要指定已创建镜像的ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。

镜像的ID可以从控制台或者参考《镜像服务API参考》的“查询镜像列表”的章节获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

flavorRef

是

String

参数解释：

待创建云服务器的系统规格的ID。

已上线的规格请参见《弹性云服务器产品介绍》的“实例类型与规格”章节。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

是

String

参数解释：

云服务器名称。

请参考创建多台云服务器云主机时怎样设置有序的云服务器云主机名称？

约束限制：

• 创建的云服务器数量（count字段对应的值）大于1时，为区分不同云服务器，创建过程中系统会自动在名称后加“-0000”的类似标记。若用户在名称后已指定“-0000”的类似标记，系统将从该标记后继续顺序递增编号。故此时名称的长度为[1-59]个字符。
• 弹性云服务器内部主机名(hostname)命名规则遵循 RFC 952和RFC 1123命名规范，建议使用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=

更多关于待注入实例自定义数据的信息，请参见《弹性云服务器用户指南 》的“用户数据注入”章节。

约束限制：

• user_data的值为base64编码之后的内容。
• 注入内容（编码之前的内容）最大长度为32K。

取值范围：

不涉及

默认取值：

不涉及

adminPass

否

String

参数解释：

如果需要使用密码方式登录云服务器，可使用adminPass字段指定云服务器管理员账户初始登录密码。其中，Linux管理员账户为root，Windows管理员账户为Administrator。

取值范围：

• 长度为8-26位。
• 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。

默认取值：

不涉及

key_name

否

String

参数解释：

如果需要使用SSH密钥方式登录云服务器，请指定已创建密钥的名称。

密钥可以通过密钥创建接口进行创建（请参见创建和导入SSH密钥对），或使用SSH密钥查询接口查询已有的密钥（请参见查询SSH密钥对列表）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

vpcid

是

String

参数解释：

待创建云服务器所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。

VPC的ID可以从控制台或者参考《虚拟私有云接口参考》的“查询VPC”章节获取。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nics

是

Array of objects

参数解释：

待创建云服务器的网卡信息。详情请参见表3

约束限制：

• 主网卡对应的网络（network）必须属于vpcid对应的VPC。用户创建网卡时，指定的第一张网卡信息为主网卡。
• 当前单个弹性云服务器默认支持最多挂载12张网卡。
• 不同的规格对网卡上限有一定的区别，参考规格清单。

取值范围：

不涉及

默认取值：

不涉及

publicip

否

Object

参数解释：

配置云服务器的弹性IP信息，弹性IP有三种配置方式。

• 不使用（无该字段）
• 自动分配，需要指定新创建弹性IP的信息
• 使用已有，需要指定已创建弹性IP的信息

详情请参见publicip字段数据结构说明。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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字段数据结构说明。

取值范围：

不涉及

默认参数：

不涉及

availability_zone

否

String

参数解释：

待创建云服务器所在的可用区，需要指定可用分区名称。

可参考接口 查询可用区列表（废弃） 获取，也可参考地区和终端节点获取。

约束限制：

• 如果为空，会自动指定一个符合要求的可用区。
• 如果在专属主机上创建云服务器，需指定云服务器与专属主机所在可用区一致。

取值范围：

不涉及

默认参数：

不涉及

batch_create_in_multi_az

否

Boolean

参数解释：

是否支持随机多AZ部署。

约束限制：

当availability_zone为空时该字段生效。

取值范围：

• true：批量创建的ecs部署在多个AZ上
• false：批量创建的ecs部署在单个AZ上

默认参数：

false

extendparam

否

Object

参数解释：

创建云服务器附加信息。

详情请参见表9。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

metadata

否

Map<String,String>

参数解释：

创建云服务器元数据。

可以通过元数据自定义键值对。系统预留键值对请参见表11。

约束限制：

如果元数据中包含了敏感数据，您应当采取适当的措施来保护敏感数据，比如限制访问范围、加密等。

取值范围：

• 最多可注入10对键值（Key/Value）。
• 主键（Key）：只能由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、中划线（-）、下划线（_）、冒号（:）、空格（ ）和小数点（.）组成，长度为[1-255]个字符。
• 值（value）：最大长度为255个字符。

默认取值：

不涉及

os:scheduler_hints

否

Object

参数解释：

云服务器调度信息，例如设置云服务器组。

详情请参见表12。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tags

否

Array of strings

参数解释：

弹性云服务器的标签。标签的格式为“key.value”。

约束限制：

• 创建弹性云服务器时，一台弹性云服务器最多可以添加10个标签。
• 云服务新增server_tags字段，该字段与tags字段功能相同，支持的key、value取值范围更广，建议使用server_tags字段。

取值范围：

• key的长度不超过36个字符，value的长度不超过43个字符。
• 标签的key值：只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。
• 标签的value值：只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。

默认取值：

不涉及

server_tags

否

Array of objects

参数解释：

弹性云服务器的标签。详情请参见server_tags字段数据结构说明。

约束限制：

• 创建弹性云服务器时，一台弹性云服务器最多可以添加10个标签。
• 云服务新增server_tags字段，该字段与tags字段功能相同，支持的key、value取值范围更广，建议使用server_tags字段。

取值范围：

不涉及

默认取值：

不涉及

description

否

String

参数解释：

云服务器描述信息。

约束限制：

不能包含“<” 和 “>”。

取值范围：

长度最多允许85个字符。

默认取值：

空字符串

auto_terminate_time

否

String

参数解释：

定时删除时间。

约束限制：

• 仅按需实例支持设置定时删除时间。
• 如果秒（ss）取值不是 00，则自动取为当前分钟（mm）开始时。
• 最短定时删除时间为当前时间半小时之后。
• 最长定时删除时间不能超过当前时间三年。

取值范围：

按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

示例：2020-09-25T12:05:00Z

默认取值：

不涉及

cpu_options

否

Object

参数解释：

自定义CPU选项。

详情请参见表7。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

enclave_options

否

Object

参数解释：

自定义enclave_options项。

详情请参见表8。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

security_options

否

Object

参数解释：

安全启动选项security_options。

详情请参见表9。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

serial_console_options

否

Object

参数解释：

是否支持串口登录。

详情请参见表10。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

metadata_options

否

Object

参数解释：

实例元数据配置。

详情请参见表11。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

port_id

否

String

参数解释：

网卡ID，UUID格式。 当该字段不为空时，表示挂载指定的网卡。

网卡ID可以从虚拟私有云的“查询端口列表”章节查询到。

取值范围：

不涉及

默认取值：

不涉及

subnet_id

否

String

参数解释：

待创建云服务器所在的子网信息。

约束限制：

需要指定vpcid对应VPC下已创建的子网（subnet）的网络ID，UUID格式。

可以通过VPC服务查询子网列表接口查询。

取值范围：

不涉及

默认取值：

不涉及

ip_address

否

String

参数解释：

待创建云服务器网卡的IP地址，IPv4格式。

取值范围：

不涉及

默认取值：

不涉及

ipv6_enable

否

Boolean

参数解释：

是否支持ipv6。

约束限制：

不涉及

取值范围：

• true，表示此网卡支持ipv6。
• false，表示此网卡不支持ipv6

默认取值：

false

ipv6_bandwidth

否

Object

参数解释：

绑定的共享带宽信息，详情请参见ipv6_bandwidth字段数据结构说明。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

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”。

取值范围：

不涉及

默认取值：

不涉及

ip_address

否

String

参数解释：

IP地址。

约束限制：

• 不支持0.0.0.0/0
• 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。

取值范围：

不涉及

默认取值：

不涉及

mac_address

否

String

参数解释：

MAC地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

volumetype

是

String

参数解释：

云服务器系统盘对应的磁盘类型。

了解不同磁盘类型的详细信息，请参见磁盘类型及性能介绍。

约束限制：

• 需要与系统所提供的磁盘类型相匹配。
• 当指定的云硬盘类型在availability_zone内不存在时，则创建云硬盘失败。

取值范围：

默认取值：

不涉及

size

否

Integer

参数解释：

系统盘大小，容量单位为GiB。

约束限制：

• 系统盘大小取值应不小于镜像支持的系统盘的最小值(镜像的min_disk属性)。
• 若该参数没有指定或者指定为0时，系统盘大小默认取值为镜像中系统盘的最小值(镜像的min_disk属性)。

取值范围：

输入大小范围为[1,1024]

默认取值：

不涉及

extendparam

否

Object

参数解释：

磁盘的产品信息。

详情请参见创建磁盘的extendparam字段数据结构说明。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cluster_type

否

String

参数解释：

云服务器系统盘对应的磁盘存储类型。

约束限制：

该参数需要与“cluster_id”配合使用，仅当“cluster_id”不为空时，才可以成功创建专属存储类型的磁盘。

取值范围：

磁盘存储类型枚举值：DSS（专属存储类型）

默认取值：

不涉及

cluster_id

否

String

参数解释：

云服务器系统盘对应的存储池的ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

hw:passthrough

否

Boolean

参数解释：

设置云硬盘的设备类型。

约束限制：

不涉及

默认取值：

参数未指定或者指定非Boolean类型的字符，默认创建VBD类型磁盘。

metadata

否

Object

参数解释：

创建云硬盘的metadata信息。详情请参见创建磁盘的metadata字段数据结构说明。

约束限制：

仅在创建加密盘时使用metadata字段。

取值范围：

metadata中的key和value长度不大于255个字节。

默认取值：

不涉及

iops

否

Integer

参数解释：

为云硬盘配置iops。

了解GPSSD2、ESSD2类型云硬盘的iops，请参见磁盘类型及性能介绍。

约束限制：

• 当“volumetype”设置为GPSSD2、ESSD2类型的云硬盘时，该参数必填，其他类型无需设置。
• 仅支持按需计费。

取值范围：

不涉及

默认取值：

不涉及

throughput

否

Integer

参数解释：

为云硬盘配置吞吐量，单位是MiB/s。

了解GPSSD2类型云硬盘的吞吐量大小范围，请参见磁盘类型及性能介绍。

约束限制：

• 当“volumetype”设置为GPSSD2类型的云硬盘时必填，其他类型不能设置。

• 仅支持按需计费

取值范围：

不涉及

默认取值：

不涉及

volumetype

是

String

参数解释：

云服务器数据盘对应的磁盘类型。

了解不同磁盘类型的详细信息，请参见磁盘类型及性能介绍。

约束限制：

• 需要与系统所提供的磁盘类型相匹配。
• 当指定的云硬盘类型在availability_zone内不存在时，则创建云硬盘失败。

取值范围：

默认取值：

不涉及

size

是

Integer

参数解释：

数据盘大小，容量单位为GiB。

约束限制：

如果使用数据盘镜像创建数据盘时，size取值不能小于创建数据盘镜像的源数据盘的大小。

取值范围：

输入大小范围为[10,32768]。

默认取值：

不涉及

shareable

否

Boolean

参数解释：

是否为共享磁盘。

约束限制：

该字段已废弃，请使用multiattach。

取值范围：

• true：创建的磁盘为共享盘。
• false：创建的磁盘为普通云硬盘。

默认取值：

false

multiattach

否

Boolean

参数解释：

创建共享磁盘的信息。

约束限制：

shareable当前为废弃字段，如果确实需要同时使用shareable字段和multiattach字段，此时，请确保两个字段的参数值相同。当不指定该字段时，系统默认创建普通云硬盘。

取值范围：

• true：创建的磁盘为共享盘。
• false：创建的磁盘为普通云硬盘。

默认取值：

false

hw:passthrough

否

Boolean

参数解释：

设置云硬盘的设备类型。

约束限制：

不涉及

默认取值：

不涉及

extendparam

否

Object

参数解释：

磁盘的产品信息。

详情请参见表7。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cluster_type

否

String

参数解释：

云服务器数据盘对应的磁盘存储类型。

约束限制：

该参数需要与“cluster_id”配合使用，仅当“cluster_id”不为空时，才可以成功创建专属存储类型的磁盘。

取值范围：

磁盘存储类型枚举值：DSS（专属存储类型）

默认取值：

不涉及

cluster_id

否

String

参数解释：

云服务器数据盘对应的存储池的ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

data_image_id

否

String

参数解释：

数据镜像的ID，UUID格式。

约束限制：

如果使用数据盘镜像创建数据盘，则data_image_id为必选参数，且不支持使用metadata。

取值范围：

不涉及

默认取值：

不涉及

metadata

否

Object

参数解释：

创建云硬盘的metadata信息。

详情请参见创建磁盘的metadata字段数据结构说明。

约束限制：

• metadata中的key和value长度不大于255个字节。
• 仅在创建加密盘时使用metadata字段。
• 如果使用数据盘镜像创建数据盘，不支持使用metadata。

取值范围：

不涉及

默认取值：

不涉及

delete_on_termination

否

Boolean

参数解释：

数据盘随实例释放策略。

约束限制：

该字段仅按需、竞价实例支持。

取值范围：

• true：数据盘随实例释放。
• false：数据盘不随实例释放。

默认取值：

false

iops

否

Integer

参数解释：

为云硬盘配置iops。

了解GPSSD2、ESSD2类型云硬盘的iops，请参见磁盘类型及性能介绍。

约束限制：

• 当“volumetype”设置为GPSSD2、ESSD2类型的云硬盘时，该参数必填，其他类型无需设置。
• 仅支持按需计费。

取值范围：

不涉及

默认取值：

不涉及

throughput

否

Integer

参数解释：

为云硬盘配置吞吐量，单位是MiB/s。

了解GPSSD2类型云硬盘的吞吐量大小范围，请参见磁盘类型及性能介绍。

约束限制：

• 当“volumetype”设置为GPSSD2类型的云硬盘时必填，其他类型不能设置。
• 仅支持按需计费。

取值范围：

不涉及

默认取值：

不涉及

hw:cpu_threads

否

integer

参数解释：

用于控制CPU是否开启超线程。

约束限制：

需要同时满足如下条件，才能设置为“关闭超线程”：

• 只能在实例创建或者resize时指定。
• 只有目标flavor的extra_specs参数：
  • 存在“hw:cpu_policy”并取值为“dedicated”。
  • 存在“hw:cpu_threads”并取值为“2”。

取值范围：

• 1: 关闭超线程。
• 2: 打开超线程。

默认取值：

不涉及

enabled

是

Boolean

参数解释：

enclave使能开关。

约束限制：

不涉及

取值范围：

• true: 打开enclave。
• false: 关闭enclave。

默认取值：

false

secure_boot_enabled

是

Boolean

参数解释：

安全启动开关。

约束限制：

不涉及

取值范围：

• true: 打开安全启动。
• false: 关闭安全启动。

默认取值：

false

tpm_enabled

是

Boolean

参数解释：

tpm启动开关。

约束限制：

不涉及

取值范围：

• true: 打开tpm。
• false: 关闭tpm。

默认取值：

false

enabled

否

Boolean

参数解释：

是否支持串口登录。

约束限制：

不涉及

取值范围：

• true：支持串口登录。
• false：不支持串口登录。

默认取值：

false

http_endpoint

否

String

参数解释：

是否启用IMDS服务，默认enabled。

约束限制：

不涉及

取值范围：

• enabled：启用IMDS服务
• disabled：禁用IMDS服务

默认取值：

disabled

http_tokens

否

String

参数解释：

是否要求携带token，默认optional。

约束限制：

不涉及

取值范围：

• optional：不要求携带token
• required：要求必须携带token，即IMDS服务禁用v1版本，启用v2版本

默认取值：

required

job_id

String

参数解释：

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态，请参考查询Job状态。

取值范围：

不涉及

order_id

String

参数解释：

订单号，创建包年包月的弹性云服务器时返回该参数。

取值范围：

不涉及

serverIds

Array of strings

参数解释：

云服务器ID列表。

取值范围：

不涉及