创建DevServer
功能介绍
创建LiteServer 弹性云服务器、裸金属服务器及超节点服务器。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/dev-servers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID。 约束限制:必填。 取值范围:1 - 64字符,字母、数字和中划线。 默认取值:不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
admin_pass |
否 |
String |
参数解释:用于登录服务器的密码。admin_pass和key_pair_name必须二选一。密码规则:
约束限制:admin_pass和key_pair_name不能同时存在。 取值范围:长度为8至26个字符,满足上述密码规则。 默认取值:不涉及。 |
arch |
否 |
String |
参数解释:服务器规格架构类型。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
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 |
参数解释:服务器类型。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
userdata |
否 |
String |
参数解释:创建服务器时,用户自己定义的数据。 约束限制:不涉及。 取值范围:长度为0至2147483647个字符。 默认取值:不涉及。 |
hps_cluster_id |
否 |
String |
参数解释:超节点集群网络信息。仅在创建超节点时需要该参数。 约束限制:仅用于创建HPS类型的服务器。 取值范围:长度为36个字符,符合UUID格式。 默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
charging_mode |
是 |
String |
参数解释:付费类型。表示服务器的计费模式。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
is_auto_pay |
否 |
Boolean |
参数解释:是否自动支付。表示是否开启自动支付功能。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
is_auto_renew |
否 |
Boolean |
参数解释:是否自动续订。表示是否开启自动续订功能。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
period_num |
是 |
Integer |
参数解释:订购周期数量。表示订购周期的数量。 约束限制:不涉及。 取值范围:1 - 11 默认取值:不涉及。 |
period_type |
是 |
String |
参数解释:订购周期类型。表示订购周期的时间单位。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ipv6_enable |
否 |
Boolean |
参数解释:创建服务器是否启用IPv6。表示在创建服务器时是否启用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格式的字符串。 默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
否 |
Integer |
参数解释:系统盘大小。表示分配给系统盘的存储空间大小。 约束限制:不涉及。 取值范围:100 - 1024 GB 默认取值:不涉及。 |
type |
否 |
String |
参数解释:系统盘类型。表示系统盘的存储类型。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
size |
是 |
Integer |
参数解释:数据盘大小。表示分配给数据盘的存储空间大小。 约束限制:不涉及。 取值范围:100 - 32768 GB 默认取值:不涉及。 |
type |
是 |
String |
参数解释:系统盘类型。表示数据盘的存储类型。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
count |
是 |
Integer |
参数解释:数据盘个数。表示为实例分配的数据盘数量。 约束限制:不涉及。 取值范围:1 - 8 默认取值:不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
create_at |
Long |
参数解释:创建时间。 取值范围:不涉及。 |
update_at |
Long |
参数解释:更新时间。 取值范围:不涉及。 |
charging_mode |
String |
参数解释:计费模式。 取值范围:
|
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 |
参数解释:实例状态。表示实例的当前运行状态,用于监控实例的生命周期和健康状况。 取值范围:
|
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 |
参数解释:服务器归属类型。 取值范围:
|
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}$。 |
参数 |
参数类型 |
描述 |
---|---|---|
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服务器类型。 取值范围:
|
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}$。 |
参数 |
参数类型 |
描述 |
---|---|---|
allowed_access_ips |
Array of strings |
参数解释:允许通过SSH协议访问Notebook的公网IP地址白名单列表。默认情况下,所有IP都可以访问。配置指定IP后,则仅允许指定IP所在的客户端访问。 约束限制:不涉及。 取值范围:0 - 1024个IP地址 默认取值:不涉及。 |
dev_service |
String |
参数解释:支持的服务。 取值范围:
|
extensions |
Map<String,String> |
参数解释:通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
ssh_keys |
Array of strings |
参数解释:SSH密钥对名称列表。允许设置多个密钥对实现同时对SSH实例的访问。 约束限制:不涉及。 取值范围:0 - 1024个密钥对 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
allowed_access_ips |
Array of strings |
参数解释:允许通过SSH协议访问Notebook的公网IP地址白名单列表,默认都可以访问。当配置指定IP后,则仅允许IP所在的客户端实现对Notebook的访问。 |
dev_service |
String |
参数解释:访问Notebook的途径。 取值范围:枚举类型,取值如下:
|
ssh_keys |
Array of strings |
参数解释:SSH密钥对名称列表,允许设置多个密钥对实现同时对SSH实例的访问。 |
service |
String |
参数解释:访问Notebook的途径。 取值范围:枚举类型,取值如下:
|
uri |
String |
参数解释:实例私有IP地址。 取值范围:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
arch |
String |
参数解释:服务器镜像架构类型。 取值范围:
|
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 |
参数解释:服务器类型。 取值范围:
|
status |
String |
参数解释:服务器镜像状态。 取值范围:
|
请求示例
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 |
错误码
请参见错误码。