文档首页/魔坊（ModelArts）模型训推平台/API参考/Lite Server管理/停止Lite Server实例 - StopDevServer
更新时间：2026-01-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

停止Lite Server实例 - StopDevServer

功能介绍

停止Lite Server实例接口用于停止正在运行的Lite Server实例。该接口适用于以下场景：当用户需要停止Lite Server实例，以节省资源或进行维护时，可以通过此接口停止指定的Lite Server实例。使用该接口的前提条件是Lite Server实例已创建且处于运行状态，用户具有停止实例的权限。若Lite Server实例不存在、已处于停止状态或用户无权限操作，接口将返回相应的错误信息。

接口约束

暂无约束

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:devserver:stop

    Write

    devserver *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

PUT /v1/{project_id}/dev-servers/{id}/stop

表1 路径参数

参数

是否必选

参数类型

描述

id

是

String

参数解释：Lite Server实例ID。

约束限制：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

取值范围：不涉及。

默认取值：不涉及。

project_id

是

String

参数解释：用户项目ID。

约束限制：获取方法请参见获取项目ID和名称。

取值范围：不涉及。

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应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信息。

volumes

Array of ServerVolume objects

参数解释：挂载硬盘信息。

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}$。

表3 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

参数解释：Lite Server服务器类型。

取值范围：

  • 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}$。

表4 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个密钥对

默认取值：不涉及。

表5 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地址。

取值范围：不涉及。

表6 ServerVolume

参数

参数类型

描述

size

Integer

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

约束限制：不涉及。

取值范围：100 - 1024 GB

默认取值：不涉及。

type

String

参数解释：存储类型。表示系统盘或数据盘。

约束限制：不涉及。

取值范围：

  • ROOT：系统盘

  • DATA：数据盘

默认取值：不涉及。

evs_type

String

参数解释：EVS盘类型。表示EVS盘的存储类型。

约束限制：不涉及。

取值范围：

  • ESSD：极速型SSD云硬盘

  • GPSSD：通用型SSD云硬盘

  • SAS：高IO云硬盘

  • SATA：普通IO云硬盘

  • SSD：超高IO云硬盘

默认取值：不涉及。

evs_id

String

参数解释：EVS盘的ID。

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

表7 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

表8 ServerHpsInfo

参数

参数类型

描述

id

String

参数解释：Lite Server超节点实例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

参数解释：Lite Server超节点名称。

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

请求示例

PUT https://{endpoint}/v1/{project_id}/dev-servers/{id}/stop

响应示例

状态码：200

OK

{
  "charging_mode" : "POST_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" : "STOPPING",
  "update_at" : 1699348285077
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：Lite Server管理