# 创建Lite Server - CreateDevServer #### 功能介绍 创建Lite Server接口用于创建LiteServer弹性云服务器、裸金属服务器及超节点服务器。该接口适用于以下场景：用户需要根据业务需求快速部署和配置不同类型的服务器资源。使用该接口的前提条件是用户已登录且具有创建Lite Server的权限，并且需要提供服务器类型、规格、网络配置等必要参数。创建操作完成后，系统将返回新创建的Lite Server实例信息，包括实例ID、状态等。若用户无权限、参数配置错误或资源不足，接口将返回相应的错误信息。 #### 接口约束 暂无约束 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=CreateDevServer)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:devserver:create | Write | devserver \* | - | - | - | | modelarts:devserver:create | Write | - | g:EnterpriseProjectId | - | - | #### 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至10。 **默认取值**：不涉及。 | | enterprise_project_id | 否 | String | **参数解释**：企业ID。 **约束限制**：不涉及。 **取值范围**：长度为1至36个字符，只能包含字母、数字、中划线、下划线和点。 **默认取值**：不涉及。 | | flavor | 否 | String | **参数解释**：服务器规格名称。 **约束限制**：flavor和resource_flavor二选一。 **取值范围**：长度为1至128个字符。 **默认取值**：不涉及。 | | resource_flavor | 否 | String | **参数解释**：服务器资源规格名称。 **约束限制**：flavor和resource_flavor二选一。 **取值范围**：长度为1至256个字符，只能包含字母、数字、中划线、下划线和点。 **默认取值**：不涉及。 | | 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 | **参数解释**：服务器系统盘信息。 **约束限制**：ECS、HPS全部规格该参数为必填项；BMS中Ant8、Ant1、Snt9b等部分规格该参数为必填项。 **取值范围**：见 #/definitions/EvsVolume。 **默认取值**：不涉及。 | | data_volume | 否 | [ServerDataVolume] object | **参数解释**：服务器数据盘信息。 **约束限制**：不涉及。 **取值范围**：见 #/definitions/ServerDataVolume。 **默认取值**：不涉及。 | | server_type | 否 | String | **参数解释**：服务器类型。 **约束限制**：不涉及。 **取值范围**： - BMS：裸金属服务器 - ECS：弹性云服务器 - HPS：超节点服务器 **默认取值**：不涉及。 | | user_data | 否 | String | **参数解释**： 创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。 示例： base64编码前： - Linux服务器： ``` #!/bin/bash echo user_test > /home/user.txt ``` base64编码后： - Linux服务器： ``` IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA== ``` 了解更多实例自定义数据注入请参考[用户数据注入](https://support.huaweicloud.com/usermanual-ecs/zh-cn_topic_0032380449.html)。 用户需明确user_data的使用效果，可能产生的影响和风险由用户自行承担。 **约束限制**： - user_data的值为base64编码之后的内容。 - 注入内容（编码之前的内容）最大长度为32K。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | hps_cluster_id | 否 | String | **参数解释**：超节点集群网络信息。仅在创建超节点时需要该参数。 **约束限制**：仅用于创建HPS类型的服务器。 **取值范围**：长度为36个字符，符合UUID格式。 **默认取值**：不涉及。 | 表3ChargingInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | charging_mode | 是 | String | **参数解释**：付费类型。表示服务器的计费模式。 **约束限制**：不涉及。 **取值范围**： - 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：年 **默认取值**：不涉及。 | 表4ServerNetwork | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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格式的字符串。 **默认取值**：不涉及。 | | hyper_cluster | 否 | [hyper_cluster] object | **参数解释**：创建服务器的参数面网络信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | allowed_address_pairs | 否 | Array of [AllowedAddressPairs] objects | **参数解释：** IP/Mac对列表。 **约束限制：** - 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"。 **取值范围：** 不涉及 **默认取值：** 不涉及" | 表5hyper_cluster | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 参数解释：HyperCluster的id。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 | | hyper_cluster_subnet_id | 否 | String | 参数解释：HyperCluster的子网id。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 | 表6AllowedAddressPairs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ip_address | 否 | String | **参数解释：** IP地址。 **约束限制：** - 不支持0.0.0.0/0。 - 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | mac_address | 否 | String | **参数解释：** MAC地址。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表7EvsVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | size | 否 | Integer | **参数解释**：系统盘大小。表示分配给系统盘的存储空间大小。 **约束限制**：不涉及。 **取值范围**：100 - 1024 GB **默认取值**：不涉及。 | | type | 否 | String | **参数解释**：系统盘类型。表示系统盘的存储类型。 **约束限制**：不涉及。 **取值范围**： - ESSD：极速型SSD云硬盘 - GPSSD：通用型SSD云硬盘 - SAS：高IO云硬盘 - SATA：普通IO云硬盘 - SSD：超高IO云硬盘 **默认取值**：不涉及。 | 表8ServerDataVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | size | 是 | Integer | **参数解释**：数据盘大小。表示分配给数据盘的存储空间大小。 **约束限制**：不涉及。 **取值范围**：100 - 32768 GB **默认取值**：不涉及。 | | type | 是 | String | **参数解释**：系统盘类型。表示数据盘的存储类型。 **约束限制**：不涉及。 **取值范围**： - ESSD：极速型SSD云硬盘 - GPSSD：通用型SSD云硬盘 - SAS：高IO云硬盘 - SATA：普通IO云硬盘 - SSD：超高IO云硬盘 **默认取值**：不涉及。 | | count | 是 | Integer | **参数解释**：数据盘个数。表示为实例分配的数据盘数量。 **约束限制**：不涉及。 **取值范围**：1 - 8 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_at | Long | **参数解释**：创建时间，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | update_at | Long | **参数解释**：更新时间，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | charging_mode | String | **参数解释**：计费模式。 **取值范围**： - POST_PAID：按需（后付费） - PRE_PAID：包周期（预付费） | | cloud_server | [CloudServer] object | **参数解释**：云服务信息。 | | endpoints_response | Array of [Endpoints] objects | **参数解释**：实例私有IP信息，列表中的每个元素为一个Endpoints对象，包含支持的服务类型和访问方式等信息。 | | flavor | String | **参数解释**：实例规格名称。 **取值范围**：1\~128个字符。 | | id | String | **参数解释**：实例ID。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | key_pair_name | String | **参数解释**：密钥对名称。 **取值范围**：由字母、数字、中划线、下划线和点号组成，长度1\~64个字符。 | | name | String | **参数解释**：实例名称。 **取值范围**：由字母、数字、中划线、下划线和点号组成，长度1\~64个字符。 | | order_id | String | **参数解释**：订单ID，创建包周期的LiteServer服务器时返回该参数。 **取值范围**：由字母和数字组成，长度1\~64个字符。 | | 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。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | endpoints | Array of [EndpointsRes] objects | **参数解释**：服务器私有IP信息，列表中的每个元素为一个EndpointsRes对象，包含访问途径和私有IP地址等信息。 | | volumes | Array of [ServerVolume] objects | **参数解释**：挂载硬盘信息，列表中的每个元素为一个ServerVolume对象，包含硬盘大小、类型和EVS盘信息等。 | | image | [ServerImageResponse] object | **参数解释**：服务器镜像信息。 | | category | String | **参数解释**：服务器归属类型。 **取值范围**： - HPS：超节点服务器 - SPOD：整柜服务器 - SERVER：单台服务器 | | server_hps | [ServerHpsInfo] object | **参数解释**：服务器归属超节点信息。 | | subnet_id | String | **参数解释**：实例所在子网的ID。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | 表10CloudServer | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：服务器资源id，或超节点子节点id。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | type | String | **参数解释**：Lite Server服务器类型。 **取值范围**： - BMS：裸金属服务器 - ECS：弹性云服务器 - HPS：超节点服务器 | | hps_id | String | **参数解释**：服务器所属的超节点资源id。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | hps_ecs_id | String | **参数解释**：超节点子节点对应服务器资源id。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | 表11Endpoints | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dev_service | String | **参数解释**：支持的服务。与EndpointsRes中dev_service的区别：此处dev_service用于请求中指定服务类型，EndpointsRes中dev_service用于响应中标识访问方式。 **取值范围**： - NOTEBOOK：可以通过https协议访问Notebook - SSH：可以通过SSH协议远程连接Notebook | | extensions | Map\ | **参数解释**：通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。key表示扩展配置名称，value表示扩展配置值。 | | ssh_keys | Array of strings | **参数解释**：SSH密钥对名称列表，最多可包含1024个密钥对。允许设置多个密钥对实现同时对SSH实例的访问。 | 表12EndpointsRes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dev_service | String | **参数解释**：访问Notebook的途径。 **取值范围**：枚举类型，取值如下： - NOTEBOOK：可以通过https协议访问Notebook。 - SSH：可以通过SSH协议远程连接Notebook。 | | service | String | **参数解释**：访问Notebook的途径。与dev_service的区别：service用于响应中标识访问方式，dev_service用于请求中指定服务类型。 **取值范围**：枚举类型，取值如下： - NOTEBOOK：可以通过https协议访问Notebook。 - SSH：可以通过SSH协议远程连接Notebook。 | | uri | String | **参数解释**：实例的访问URI，格式为私有IP地址。 **取值范围**：不涉及。 | | key_pair_names | Array of strings | **参数解释**：SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。 **取值范围**：不涉及。 | 表13ServerVolume | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | **参数解释**：EVS盘大小，单位GB。表示分配给系统盘的存储空间大小。 **取值范围**：100 - 1024 | | type | String | **参数解释**：存储类型。表示系统盘或数据盘。 **取值范围**： - ROOT：系统盘 - DATA：数据盘 | | evs_type | String | **参数解释**：EVS盘类型。表示EVS盘的存储类型。 **取值范围**： - ESSD：极速型SSD云硬盘 - GPSSD：通用型SSD云硬盘 - SAS：高IO云硬盘 - SATA：普通IO云硬盘 - SSD：超高IO云硬盘 | | evs_id | String | **参数解释**：EVS盘的ID。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | 表14ServerImageResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | arch | String | **参数解释**：服务器镜像架构类型。 **取值范围**： - ARM：ARM架构，适用于移动端和嵌入式场景 - X86：X86架构，适用于通用计算场景 | | image_id | String | **参数解释**：服务器镜像ID。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | name | String | **参数解释**：服务器镜像名称。表示服务器镜像的名称。 **取值范围**：1 - 256字符 | | server_type | String | **参数解释**：服务器类型。 **取值范围**： - BMS：裸金属服务器 - ECS：弹性云服务器 - HPS：超节点服务器 | | status | String | **参数解释**：服务器镜像状态。 **取值范围**： - ACTIVE：镜像可用 - INACTIVE：镜像不可用 | 表15ServerHpsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：Lite Server超节点实例id。 **取值范围**：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。 | | name | String | **参数解释**：Lite Server超节点名称。 **取值范围**：由字母、数字、中划线、下划线和点号组成，长度1\~64个字符。 | #### 请求示例 - 创建按需资源请求体示例 ``` POST https://{endpoint}/v1/{project_id}/dev-servers { "name" : "liteserver-b9a0", "resource_flavor" : "modelarts.vm.cpu.rc3", "image_id" : "3e183512-096d-4711-928e-004e0cc961f3", "network" : { "security_group_id" : "0ae21fee-5cee-496d-a971-6802b80267e2", "subnet_id" : "38cf274a-98f9-4f6f-b622-5ed0e4a3db54", "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" }, "count" : 1, "admin_pass" : "xxxxx", "root_volume" : { "size" : 100, "type" : "ESSD" } } ``` - 创建包周期资源请求体示例 ``` POST https://{endpoint}/v1/{project_id}/dev-servers { "name" : "liteserver-6542", "resource_flavor" : "modelarts.vm.cpu.rc3", "image_id" : "3e183512-096d-4711-928e-004e0cc961f3", "network" : { "security_group_id" : "0ae21fee-5cee-496d-a971-6802b80267e2", "subnet_id" : "38cf274a-98f9-4f6f-b622-5ed0e4a3db54", "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" }, "count" : 1, "admin_pass" : "xxxxx", "root_volume" : { "size" : 100, "type" : "ESSD" }, "charging_info" : { "charging_mode" : "PRE_PAID", "period_type" : "MONTH", "period_num" : 1 } } ``` #### 响应示例 **状态码：200** OK，示例1：创建按需资源响应体。示例2：创建包周期资源响应体。 - 示例 1 ``` { "charging_mode" : "POST_PAID", "cloud_server" : { "type" : "ECS" }, "create_at" : 1786590006021, "flavor" : "rc3.large.4", "id" : "fc7e387e-91da-4754-969e-7af57794907e", "image" : { "arch" : "ARM", "image_id" : "3e183512-096d-4711-928e-004e0cc961f3", "name" : "Ubuntu 22.04 server 64bit with ARM", "server_type" : "ECS", "status" : "ACTIVE" }, "name" : "liteserver-5f58", "status" : "CREATING", "update_at" : 1786590006032, "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" } ``` - 示例 2 ``` { "order_id" : "CS260813060531ZX5" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，示例1：创建按需资源响应体。示例2：创建包周期资源响应体。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。