更新时间:2025-08-19 GMT+08:00

创建DevServer

功能介绍

创建LiteServer 弹性云服务器、裸金属服务器及超节点服务器。

接口约束

暂无约束

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/dev-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。

约束限制:必填。

取值范围:1 - 64字符,字母、数字和中划线。

默认取值:不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

admin_pass

String

参数解释:用于登录服务器的密码。admin_pass和key_pair_name必须二选一。密码规则:

  • 长度为8至26个字符

  • 至少包含大写字母、小写字母、数字及特殊符号(!@%-_=+[{}]:,./?)中的3种

  • 不能与用户名或倒序的用户名相同

  • 不能包含root或administrator及其逆序

约束限制:admin_pass和key_pair_name不能同时存在。

取值范围:长度为8至26个字符,满足上述密码规则。

默认取值:不涉及。

arch

String

参数解释:服务器规格架构类型。

约束限制:不涉及。

取值范围

  • X86:CPU架构为X86

  • ARM:CPU架构为ARM

默认取值:不涉及。

availability_zone

String

参数解释:服务器所在的可用区。

约束限制:不涉及。

取值范围:长度为1至256个字符,只能包含字母、数字、中划线、下划线和点。

默认取值:不涉及。

charging_info

ChargingInfo object

参数解释:服务器的计费模式信息。

count

Integer

参数解释:单次购买的服务器数量。

约束限制:不涉及。

取值范围:1至100。

默认取值:不涉及。

enterprise_project_id

String

参数解释:企业ID。

约束限制:不涉及。

取值范围:长度为1至36个字符,只能包含字母、数字、中划线、下划线和点。

默认取值:不涉及。

flavor

String

参数解释:服务器规格名称。

约束限制:不涉及。

取值范围:长度为1至128个字符,只能包含字母和数字及点。

默认取值:不涉及。

image_id

String

参数解释:服务器镜像ID。

约束限制:不涉及。

取值范围:长度为36个字符,符合UUID格式。

默认取值:不涉及。

key_pair_name

String

参数解释:服务器登录密钥对名称。admin_pass和key_pair_name必须二选一。注意超节点仅支持使用密钥对创建。

约束限制:admin_pass和key_pair_name不能同时存在。

取值范围:长度为1至64个字符,只能包含字母、数字、中划线、下划线和点。

默认取值:不涉及。

name

String

参数解释:服务器名称。

约束限制:不涉及。

取值范围:长度为1至64个字符,只能包含字母、数字、中划线、下划线和点。

默认取值:不涉及。

network

ServerNetwork object

参数解释:服务器的网络信息。

约束限制:不涉及。

取值范围:见 #/definitions/ServerNetwork。

默认取值:不涉及。

root_volume

EvsVolume object

参数解释:服务器系统盘信息。

约束限制:不涉及。

取值范围:见 #/definitions/EvsVolume。

默认取值:不涉及。

data_volume

ServerDataVolume object

参数解释:服务器数据盘信息。

约束限制:不涉及。

取值范围:见 #/definitions/ServerDataVolume。

默认取值:不涉及。

server_type

String

参数解释:服务器类型。

约束限制:不涉及。

取值范围

  • BMS:裸金属服务

  • ECS:弹性云服务

  • HPS:超节点服务

默认取值:不涉及。

userdata

String

参数解释:创建服务器时,用户自己定义的数据。

约束限制:不涉及。

取值范围:长度为0至2147483647个字符。

默认取值:不涉及。

hps_cluster_id

String

参数解释:超节点集群网络信息。仅在创建超节点时需要该参数。

约束限制:仅用于创建HPS类型的服务器。

取值范围:长度为36个字符,符合UUID格式。

默认取值:不涉及。

表3 ChargingInfo

参数

是否必选

参数类型

描述

charging_mode

String

参数解释:付费类型。表示服务器的计费模式。

约束限制:不涉及。

取值范围

  • COMMON:同时支持包周期和按需

  • POST_PAID:后付费

  • PRE_PAID:预付费

默认取值:不涉及。

is_auto_pay

Boolean

参数解释:是否自动支付。表示是否开启自动支付功能。

约束限制:不涉及。

取值范围

  • true:自动支付

  • false:不自动支付

默认取值:不涉及。

is_auto_renew

Boolean

参数解释:是否自动续订。表示是否开启自动续订功能。

约束限制:不涉及。

取值范围

  • true:自动续订

  • false:不自动续订

默认取值:不涉及。

period_num

Integer

参数解释:订购周期数量。表示订购周期的数量。

约束限制:不涉及。

取值范围:1 - 11

默认取值:不涉及。

period_type

String

参数解释:订购周期类型。表示订购周期的时间单位。

约束限制:不涉及。

取值范围

  • ABSOLUTE

  • DAY:天

  • HOUR:小时

  • MONTH:月

  • WEEK:周

  • YEAR:年

默认取值:不涉及。

表4 ServerNetwork

参数

是否必选

参数类型

描述

ipv6_enable

Boolean

参数解释:创建服务器是否启用IPv6。表示在创建服务器时是否启用IPv6支持。

约束限制:不涉及。

取值范围

  • true:启用IPv6

  • false:不启用IPv6

默认取值:不涉及。

roce_id

String

参数解释:服务器RoCE网络ID。表示服务器的RoCE网络ID。

约束限制:不涉及。

取值范围:必须是UUID格式的字符串。

默认取值:不涉及。

security_group_id

String

参数解释:服务器所在的安全组ID。表示服务器所属的安全组ID。

约束限制:不涉及。

取值范围:必须是UUID格式的字符串。

默认取值:不涉及。

subnet_id

String

参数解释:服务器所在子网ID。表示服务器所属的子网ID。

约束限制:不涉及。

取值范围:必须是UUID格式的字符串。

默认取值:不涉及。

vpc_id

String

参数解释:服务器所在虚拟私有云ID。表示服务器所属的虚拟私有云ID。

约束限制:不涉及。

取值范围:必须是UUID格式的字符串。

默认取值:不涉及。

表5 EvsVolume

参数

是否必选

参数类型

描述

size

Integer

参数解释:系统盘大小。表示分配给系统盘的存储空间大小。

约束限制:不涉及。

取值范围:100 - 1024 GB

默认取值:不涉及。

type

String

参数解释:系统盘类型。表示系统盘的存储类型。

约束限制:不涉及。

取值范围

  • ESSD:极速型SSD云硬盘

  • GPSSD:通用型SSD云硬盘

  • SAS:高IO云硬盘

  • SATA:普通IO云硬盘

  • SSD:超高IO云硬盘

默认取值:不涉及。

表6 ServerDataVolume

参数

是否必选

参数类型

描述

size

Integer

参数解释:数据盘大小。表示分配给数据盘的存储空间大小。

约束限制:不涉及。

取值范围:100 - 32768 GB

默认取值:不涉及。

type

String

参数解释:系统盘类型。表示数据盘的存储类型。

约束限制:不涉及。

取值范围

  • ESSD:极速型SSD云硬盘

  • GPSSD:通用型SSD云硬盘

  • SAS:高IO云硬盘

  • SATA:普通IO云硬盘

  • SSD:超高IO云硬盘

默认取值:不涉及。

count

Integer

参数解释:数据盘个数。表示为实例分配的数据盘数量。

约束限制:不涉及。

取值范围:1 - 8

默认取值:不涉及。

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

create_at

Long

参数解释:创建时间。

取值范围:不涉及。

update_at

Long

参数解释:更新时间。

取值范围:不涉及。

charging_mode

String

参数解释:计费模式。

取值范围

  • COMMON:同时支持包周期和按需

  • POST_PAID:按需模式

  • PRE_PAID:包周期

cloud_server

CloudServer object

参数解释:云服务信息。

endpoints_response

Array of Endpoints objects

参数解释:实例私有IP信息。

flavor

String

参数解释:实例规格名称。

取值范围:^.{1,128}$。

id

String

参数解释:实例ID。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

key_pair_name

String

参数解释:密钥对名称。

取值范围:^[-_.a-zA-Z0-9]{1,64}$。

name

String

参数解释:实例名称。

取值范围:^[-_.a-zA-Z0-9]{1,64}$。

order_id

String

参数解释:订单ID。

取值范围:^[a-zA-Z0-9]{1,64}$。

server_image_response

ServerImageResponse object

参数解释:实例镜像信息。

取值范围:不涉及。

status

String

参数解释:实例状态。表示实例的当前运行状态,用于监控实例的生命周期和健康状况。

取值范围

  • CREATE_FAILED: 创建失败

  • CREATING: 创建中

  • DELETED: 已删除

  • DELETE_FAILED: 删除失败

  • DELETING: 删除中

  • ERROR: 错误

  • RUNNING: 运行中

  • STARTING: 启动中

  • START_FAILED: 启动失败

  • STOPPED: 已停止

  • STOPPING: 停止中

  • STOP_FAILED: 停止失败

  • REBOOTING: 重启中

  • REBOOT_FAILED: 重启失败

  • CHANGINGOS: 切换操作系统中

  • CHANGINGOS_FAILED: 切换操作系统失败

  • REINSTALLINGOS: 重装操作系统中

  • REINSTALLINGOS_FAILED: 重装操作系统失败

vpc_id

String

参数解释:实例所在虚拟私有云ID。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

endpoints

Array of EndpointsRes objects

参数解释:服务器私有IP信息。

image

ServerImageResponse object

参数解释:服务器镜像信息。

category

String

参数解释:服务器归属类型。

取值范围

  • HPS:超节点服务器

  • SPOD:整柜服务器

  • SERVER:单台服务器

server_hps

ServerHpsInfo object

参数解释:服务器归属超节点信息。

subnet_id

String

参数解释:实例所在子网的ID。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

表8 CloudServer

参数

参数类型

描述

id

String

参数解释:服务器资源id,或超节点子节点id。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

type

String

参数解释:DevServer服务器类型。

取值范围

  • BMS:裸金属服务器

  • ECS:弹性云服务器

  • HPS:超节点服务器

hps_id

String

参数解释:服务器所属的超节点资源id。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

hps_ecs_id

String

参数解释:超节点子节点对应服务器资源id。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

表9 Endpoints

参数

参数类型

描述

allowed_access_ips

Array of strings

参数解释:允许通过SSH协议访问Notebook的公网IP地址白名单列表。默认情况下,所有IP都可以访问。配置指定IP后,则仅允许指定IP所在的客户端访问。

约束限制:不涉及。

取值范围:0 - 1024个IP地址

默认取值:不涉及。

dev_service

String

参数解释:支持的服务。

取值范围

  • NOTEBOOK:可以通过https协议访问Notebook

  • SSH:可以通过SSH协议远程连接Notebook

extensions

Map<String,String>

参数解释:通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

ssh_keys

Array of strings

参数解释:SSH密钥对名称列表。允许设置多个密钥对实现同时对SSH实例的访问。

约束限制:不涉及。

取值范围:0 - 1024个密钥对

默认取值:不涉及。

表10 EndpointsRes

参数

参数类型

描述

allowed_access_ips

Array of strings

参数解释:允许通过SSH协议访问Notebook的公网IP地址白名单列表,默认都可以访问。当配置指定IP后,则仅允许IP所在的客户端实现对Notebook的访问。

dev_service

String

参数解释:访问Notebook的途径。

取值范围:枚举类型,取值如下:

  • NOTEBOOK:可以通过https协议访问Notebook。

  • SSH:可以通过SSH协议远程连接Notebook。

ssh_keys

Array of strings

参数解释:SSH密钥对名称列表,允许设置多个密钥对实现同时对SSH实例的访问。

service

String

参数解释:访问Notebook的途径。

取值范围:枚举类型,取值如下:

  • NOTEBOOK:可以通过https协议访问Notebook。

  • SSH:可以通过SSH协议远程连接Notebook。

uri

String

参数解释:实例私有IP地址。

取值范围:不涉及。

表11 ServerImageResponse

参数

参数类型

描述

arch

String

参数解释:服务器镜像架构类型。

取值范围

  • ARM

  • X86

image_id

String

参数解释:服务器镜像ID。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

name

String

参数解释:服务器镜像名称。表示服务器镜像的名称。

约束限制:不涉及。

取值范围:1 - 256字符

默认取值:不涉及。

server_type

String

参数解释:服务器类型。

取值范围

  • BMS:裸金属服务器

  • ECS:弹性云服务器

  • HPS:超节点服务器

status

String

参数解释:服务器镜像状态。

取值范围

  • ACTIVE

  • INACTIVE

表12 ServerHpsInfo

参数

参数类型

描述

id

String

参数解释:DevServer超节点实例id。

取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

name

String

参数解释:DevServer超节点名称。

取值范围:^[-_.a-zA-Z0-9]{1,64}$。

请求示例

POST https://{endpoint}/v1/{project_id}/dev-servers

{
  "name" : "EI-evs-1107",
  "flavor" : "Si2.large.4",
  "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
  "network" : {
    "security_group_id" : "150a2c76-1334-45f6-b28f-419f9b1d1742",
    "subnet_id" : "38cf274a-98f9-4f6f-b622-5ed0e4a3db54",
    "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172"
  },
  "admin_pass" : "@DevServer"
}

响应示例

状态码:200

OK

{
  "charging_mode" : "PRE_PAID",
  "cloud_server" : {
    "type" : "ECS"
  },
  "create_at" : 1699348284990,
  "flavor" : "Si2.large.4",
  "id" : "62383738-e52a-450a-9f84-f9e705402be8",
  "image" : {
    "arch" : "X86",
    "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
    "name" : "Ubuntu18.04_x86_64_CPU",
    "server_type" : "ECS"
  },
  "name" : "EI-evs-1107",
  "status" : "CREATING",
  "update_at" : 1699348285077
}

状态码

状态码

描述

200

OK

错误码

请参见错误码