文档首页/ AI开发平台ModelArts/ API参考/ DevServer管理/ 切换DevServer服务器操作系统镜像
更新时间：2025-08-18 GMT+08:00
查看PDF
分享

切换DevServer服务器操作系统镜像

功能介绍

切换DevServer服务器操作系统镜像。

调试

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

URI

POST /v1/{project_id}/dev-servers/{id}/changeos

表1 路径参数

参数

是否必选

参数类型

描述

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

取值范围：不涉及。

默认取值：不涉及。

project_id

是

String

参数解释：用户项目ID。

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

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

admin_pass

否

String

参数解释：用于登录服务器密码。注意弹性云服务器和裸金属服务器admin_pass和key_pair_name必须二选一，超节点不支持admin_pass。

约束限制：密码规则：

  • 长度为8至26个

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

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

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

取值范围：不涉及

默认取值：不涉及

key_pair_name

否

String

参数解释：服务器登录密钥对名称。注意admin_pass和key_pair_name必须二选一。

约束限制：不涉及。

取值范围：不涉及

默认取值：不涉及

image_id

否

String

参数解释：镜像ID，切换操作系统场景，该参数必填。

约束限制：不涉及。

取值范围：不涉及

默认取值：不涉及

user_data

否

String

参数解释：创建服务器时，用户自己定义数据。

约束限制：不涉及。

取值范围：不涉及

默认取值：不涉及

响应参数

状态码：200

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号
表4 响应Body参数

参数

参数类型

描述

create_at

Long

参数解释：创建时间。

取值范围：不涉及。

update_at

Long

参数解释：更新时间。

取值范围：不涉及。

charging_mode

String

参数解释：计费模式。 取值范围：

  • POST_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

参数解释：服务器归属类型。 取值范围：

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}$。
表5 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}$。
表6 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个密钥对

默认取值：不涉及。
表7 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地址。

取值范围：不涉及。
表8 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
表9 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}$。

状态码：400

表10 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号
表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：401

表12 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号
表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：403

表14 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号
表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：500

表16 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号
表17 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

请求示例

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

{
  "admin_pass" : "@Admin_pass",
  "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7"
}

响应示例

状态码：200

{
  "charging_mode" : "PRE_PAID",
  "cloud_server" : {
    "id" : "2c5261a0-b55b-4677-9c92-6927dd3e000d",
    "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" : "devserver-name",
  "status" : "CHANGINGOS",
  "update_at" : 1699348285077
}

状态码

状态码

描述

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Internal Error

错误码

请参见错误码。

父主题： DevServer管理

相关文档