创建云服务器
功能介绍
创建一台按需云服务器。
URI
POST /v2.1/servers
接口约束
- 网络的三个参数(port、uuid和fixed_ip)中,port优先级最高;指定fixed_ip时必须指明uuid。
- 云服务器的系统盘会占用云硬盘的配额。
- 用户创建弹性云服务器时在block_device_mapping_v2设置的device_name字段不会生效,系统会默认生成一个device_name。
请求消息
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
server | 是 | Object | 云服务器信息,参见表1。 |
表1 server参数信息
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
flavorRef | 是 | String | 规格ID或URL。规格ID示例:standard.4C.8G |
name | 是 | String | 云服务器名称,长度大于0小于256字节。 |
block_device_mapping_v2 | 否 | Array of objects | 扩展属性,指定云服务器存储设备的v2接口,参见表3。 |
metadata | 否 | Object | 云服务器元数据,参见表2。 |
security_groups | 否 | Array of objects | 扩展属性,指定云服务器的安全组,默认为default,参见表4。 |
networks | 是 | Array of objects | 扩展属性,指定弹性云服务器的网卡信息,参见表5。 |
key_name | 否 | String | 扩展属性,指定keypair的名称。 |
description | 否 | String | 扩展属性,表示弹性云服务器描述信息,默认为空字符串。 |
表2 metadata字段数据结构说明
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
cinder_img_volume_type | 是 | String | 云服务器使用镜像的存储类型,目前都为:容量型。 |
volume_type | 是 | String | 存储类型,在source_type是image,destination_type是volume时建议填写 |
表3 block_device_mapping_v2参数
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
source_type | String | 是 | 卷设备的源头类型,当前只支持image、snapshot类型。当使用镜像创建云服务器时,source_type设置为image;当使用快照创建云服务器时,source_type设置为snapshot。说明:**当卷设备的源头类型为snapshot时,且boot_index为0,则该快照对应的云硬盘必须为系统盘。 |
destination_type | String | 否 | 卷设备的目标类型,当前仅支持volume类型。 |
delete_on_termination | Boolean | 否 | 删除云服务器时,是否删除卷,默认值false。true:删除云服务器时,删除卷;false:删除弹性云服务器时,不删除卷 |
boot_index | String | 是 | 启动标识,“0”代表启动盘,“-1“代表非启动盘。 |
uuid | String | 否 | 当source_type值是snapshot时,uuid为快照的uuid;当source_type值是image时,uuid为镜像的uuid; |
volume_size | Integer | 否 | 卷大小,整数,在source_type是image,destination_type是volume的时候必选。单位为GB。 |
表4 security_groups参数
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
name | 否 | String | 安全组名称或者uuid。 |
表5 networks参数
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
port | 否 | String | 网络port uuid。没有指定网络uuid时必须指定。 |
uuid | 否 | String | 网络uuid。没有指定网络port时必须指定。 |
fixed_ip | 否 | String | 指定的IP地址。网络的三个参数(port、uuid和fixed_ip)中,port优先级最高;指定fixed_ip时必须指明uuid。 |
响应消息
响应参数
参数 | 参数类型 | 描述 |
---|---|---|
server | Object | 云服务器信息,详情请参见表6。 |
表6 server字段数据结构说明
参数 | 参数类型 | 描述 |
---|---|---|
id | String | 云服务器ID,UUID格式。 |
links | Array of objects | 云服务器URI自描述信息,详情参见表7。 |
security_groups | Array of objects | 云服务器所在安全组,详情参见表8。 |
OS-DCF:diskConfig | String | diskConfig方式。MANUAL,镜像空间不会扩展。AUTO,系统盘镜像空间会自动扩展为与flavor大小一致。 |
adminPass | String | 云服务器的用户密码。 |
表7 links字段数据结构说明
参数 | 参数类型 | 描述 |
---|---|---|
rel | String | 快捷链接标记名称。 |
href | String | 对应快捷链接。 |
表8 security_groups字段数据结构说明
参数 | 参数类型 | 描述 |
---|---|---|
name | String | 安全组名称。 |
请求示例
请求URL示例
1 | POST https://{endpoint}/v2.1/servers |
示例:通过block_device_mapping_v2使用镜像创建弹性云服务器:
1 | { |
响应示例
1 | { |
返回值
请参考通用请求返回值。