创建云服务器
功能介绍
创建一台或多台云服务器。
本接口为异步接口,当前创建云服务器请求下发成功后会返回job_id,此时创建云服务器并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云服务器创建成功。
调用接口前,您需要了解API认证鉴权。
调用接口前,您需要提前获取到地区和终端节点。
弹性云服务器的登录鉴权方式包括两种:密钥对、密码。为安全起见,推荐使用密钥对方式。
- 密钥对
接口调用方法:使用key_name字段,指定弹性云服务器登录时使用的密钥文件。
- 密码
指使用设置初始密码方式作为弹性云服务器的鉴权方式,此时,您可以通过用户名密码方式登录弹性云服务器,Linux操作系统时为root用户的初始密码,Windows操作系统时为Administrator用户的初始密码。
- 镜像密码
使用Linux操作系统私有镜像创建云服务器,支持使用私有镜像的密码。
接口调用方法:使用镜像密码,则无需指定key_name、adminPass字段。
URI
POST /v1/{project_id}/cloudservers
请求消息
请求参数
请求参数如表2所示。
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
server |
是 |
Object |
弹性云服务器信息,请参见表3。 |
dry_run |
否 |
Boolean |
是否只预检此次请求,默认为false。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
imageRef |
是 |
String |
待创建云服务器的系统镜像,需要指定已创建镜像的ID,ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID)。 |
flavorRef |
是 |
String |
待创建云服务器的系统规格的ID。 已上线的规格请参见《弹性云服务器用户指南》的“实例类型与规格”章节。 |
name |
是 |
String |
云服务器名称。 取值范围:
|
user_data |
否 |
String |
创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。
说明:
更多关于待注入实例自定义数据的信息,请参见《弹性云服务器用户指南 》的“实例自定义数据注入”章节。 示例: base64编码前:
base64编码后:
|
adminPass |
否 |
String |
如果需要使用密码方式登录云服务器,可使用adminPass字段指定云服务器管理员账户初始登录密码。其中,Linux管理员账户为root,Windows管理员账户为Administrator。
密码复杂度要求:
|
key_name |
否 |
String |
如果需要使用SSH密钥方式登录云服务器,请指定已创建密钥的名称。 密钥可以通过密钥创建接口进行创建(请参见 创建和导入SSH密钥),或使用SSH密钥查询接口查询已有的密钥(请参见查询SSH密钥列表 )。 |
vpcid |
是 |
String |
待创建云服务器所属虚拟私有云(简称VPC),需要指定已创建VPC的ID,UUID格式。 VPC的ID可以从控制台或者参考《虚拟私有云接口参考》的“查询VPC”章节获取。 |
nics |
是 |
Array of objects |
待创建云服务器的网卡信息。详情请参见表4。 约束:
|
publicip |
否 |
Object |
配置云服务器的弹性公网IP信息,弹性公网IP有三种配置方式。
详情请参见表1。 |
count |
否 |
Integer |
创建云服务器数量。 约束:
|
root_volume |
是 |
Object |
云服务器对应系统盘相关配置。 详情请参见表5。 |
data_volumes |
否 |
Array of objects |
云服务器对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。 约束:目前云服务器最多可挂载59块数据盘(部分规格只支持23块数据盘) 详情请参见表6。 |
security_groups |
否 |
Array of objects |
云服务器对应安全组信息。 约束:当该值指定为空时,默认给云服务器绑定default安全组。 详情请参见表2。 |
availability_zone |
否 |
String |
待创建云服务器所在的可用区,需要指定可用分区名称。
说明:
如果为空,会自动指定一个符合要求的可用区。 如果在专属主机上创建云服务器,需指定云服务器与专属主机所在可用区一致。 |
extendparam |
否 |
Object |
创建云服务器附加信息。 详情请参见表7。 |
metadata |
否 |
Map<String,String> |
创建云服务器元数据。 可以通过元数据自定义键值对。
说明:
系统预留键值对请参见表9。 |
tags |
否 |
Array of strings |
弹性云服务器的标签。 标签的格式为“key.value”。其中,key的长度不超过36个字符,value的长度不超过43个字符。 标签命名时,需满足如下要求:
说明:
|
description |
否 |
String |
云服务器描述信息,默认为空字符串。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
subnet_id |
是 |
String |
待创建云服务器所在的子网信息。 需要指定vpcid对应VPC下已创建的子网(subnet)的网络ID,UUID格式。 |
ip_address |
否 |
String |
待创建云服务器网卡的IP地址,IPv4格式。
约束:
|
ipv6_enable |
否 |
Boolean |
是否支持ipv6。取值为true时,表示此网卡支持ipv6。 |
ipv6_bandwidth |
否 |
Object |
绑定的共享带宽信息,详情请参见ipv6_bandwidth字段数据结构说明。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
volumetype |
是 |
String |
云服务器系统盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。
目前支持“SSD”,“SAS”。
当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。
说明:
|
size |
否 |
Integer |
系统盘大小,容量单位为GB,输入大小范围为[1,1024]。 约束:
说明:
镜像系统盘的最小值(镜像的min_disk属性)可在控制台上单击镜像详情查看。或通过调用“查询镜像详情(OpenStack原生)”API获取,详细操作请参考《镜像服务API参考》中“查询镜像详情(OpenStack原生)”章节。 |
extendparam |
否 |
Object |
磁盘的产品信息。 详情请参见创建磁盘的extendparam字段数据结构说明。 |
hw:passthrough |
否 |
Boolean |
设置云硬盘的设备类型:
|
metadata |
否 |
Object |
创建云硬盘的metadata信息,metadata中的key和value长度不大于255个字节。 仅在创建加密盘时使用metadata字段。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
volumetype |
是 |
String |
云服务器数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。
目前支持“SSD”,“SAS”。
当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。
说明:
|
size |
是 |
Integer |
数据盘大小,容量单位为GB,输入大小范围为[10,32768]。 如果使用数据盘镜像创建数据盘时,size取值不能小于创建数据盘镜像的源数据盘的大小。 |
shareable |
否 |
Boolean |
是否为共享磁盘。true为共享盘,false为普通云硬盘。
说明:
该字段已废弃,请使用multiattach。 |
multiattach |
否 |
Boolean |
创建共享磁盘的信息。
说明:
shareable当前为废弃字段,如果确实需要同时使用shareable字段和multiattach字段,此时,请确保两个字段的参数值相同。当不指定该字段时,系统默认创建普通云硬盘。 |
hw:passthrough |
否 |
Boolean |
设置云硬盘的设备类型:
|
extendparam |
否 |
Object |
磁盘的产品信息。 详情请参见表6。 |
data_image_id |
否 |
String |
数据镜像的ID,UUID格式。 如果使用数据盘镜像创建数据盘,则data_image_id为必选参数,且不支持使用metadata。 |
metadata |
否 |
Object |
创建云硬盘的metadata信息,metadata中的key和value长度不大于255个字节。 仅在创建加密盘时使用metadata字段。 如果使用数据盘镜像创建数据盘,不支持使用metadata。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态,请参考5.8 查询Job状态。 |
异常响应请参考响应(任务类),异常响应要素说明。
请求示例
- 创建一台按需计费云服务器,操作系统为CentOS 7.6 64bit,4U8G,磁盘类型为“SSD”,绑定10M的按带宽计费的弹性公网IP,采用密钥方式登录鉴权。
POST https://{endpoint}/v1/{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, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s3.xlarge.2", "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", "security_groups": [ { "id": "507ca48f-814c-4293-8706-300564d54620" } ], "nics": [ { "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" } ], "publicip": { "eip": { "iptype": "5_bgp", "bandwidth": { "size": 10, "sharetype": "PER" } } }, "key_name": "sshkey-123", "count": 1, "server_tags": [ { "key": "key1", "value": "value1" } ], "metadata": { "op_svc_userid": "8ea65f4099ba412883e2a0da72b96873", "agency_name": "test" } } }
- 使用系统盘加密且自带两个数据盘的整机镜像创建云服务器,对于恢复的两块数据盘,一块按默认属性恢复,另一块更改磁盘属性为“SSD,100GB”;再为创建的云服务器新挂载一个属性为“SSD,50GB”的数据盘。
POST https://{endpoint}/v1/{project_id}/cloudservers { "server": { "availability_zone":"az1-dc1", "name": "wholeImageServer", "imageRef": "ff49b1f1-3e3e-4913-89c6-a026041661e8", "root_volume": { "volumetype": "SSD", "metadata": { "__system__encrypted": "1", "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" } }, "data_volumes": [ { "volumetype": "SSD", "size": 100, "extendparam":{ "snapshotId": "ef020653-9742-4d24-8672-10af42c9702b" } }, { "volumetype": "SSD", "size": 50 } ], "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" } }
- 发送预校验请求,检查创建弹性云服务器的请求消息是否填写了必选参数,请求格式是否正确。
POST https://{endpoint}/v1/{project_id}/cloudservers { "dry_run": true, "server": { "availability_zone":"az1-dc1", "name": "newserver", "imageRef": "1189efbf-d48b-46ad-a823-94b942e2a000", "root_volume": { "volumetype": "SSD" }, "data_volumes": [ { "volumetype": "SSD", "size": 100, "multiattach": true, "hw:passthrough": true } ], "flavorRef": "s3.xlarge.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", "count": 1 } }
响应示例
{ "job_id": "93c82933d6b7827d3016b8771f2070873" }
或
{ "error": { "code": "request body is illegal.", "message": "Ecs.0005" } }
或
{ "error": { "message": "privateIp [%s] is not in this subnet [%s]", "code": "Ecs.0005", "details": [ { "code": "Ecs.0039" } ] } }
返回值
请参考通用请求返回值。
错误码
请参考错误码。