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

批量操作DevServer实例

功能介绍

批量操作DevServer实例。

接口约束

暂无约束

调试

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

URI

POST /v1/{project_id}/dev-servers/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

String

参数解释:批量操作类型。

约束限制:不涉及。

取值范围

  • START:批量启动DevServer实例

  • STOP:批量停止DevServer实例

  • REBOOT:批量重启DevServer实例

  • CHANGEOS:批量切换DevServer服务器操作系统镜像

  • REINSTALLOS:批量重装DevServer服务器操作系统镜像

  • DELETE:批量删除DevServer实例

默认取值:不涉及。

servers

Array of BatchActionDevServerIds objects

参数解释:批量操作DevServer ID列表。

extend_param

ServerOsRequest object

参数解释:批量切换和重置DevServer服务器操作系统镜像配置参数。

表3 BatchActionDevServerIds

参数

是否必选

参数类型

描述

id

String

参数解释:DevServer实例ID。

约束限制:不涉及。

取值范围:不涉及

默认取值:不涉及

表4 ServerOsRequest

参数

是否必选

参数类型

描述

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

参数解释

创建云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。

示例:

base64编码前:

  • Linux服务器:

#!/bin/bash
echo user_test > /home/user.txt

base64编码后:

  • Linux服务器:

IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==

了解更多实例自定义数据注入请参考用户数据注入

用户需明确user_data的使用效果,可能产生的影响和风险由用户自行承担。

约束限制

  • user_data的值为base64编码之后的内容。

  • 注入内容(编码之前的内容)最大长度为32K。

取值范围:不涉及。

默认取值:不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

current

Integer

参数解释:当前页数。

取值范围:1 - 2097152

data

Array of ServerResponse objects

参数解释:DevServer实例列表。

pages

Integer

参数解释:总的页数。

取值范围:1 - 2097152

size

Integer

参数解释:每一页的数量。设置查询时每页返回的最大实例数量,此值将直接影响到返回数据的量。调整此值可以优化查询性能或提高单次请求的信息量。

取值范围:1 - 1024

total

Long

参数解释:总的记录数量。表示当前查询条件下,满足条件的实例总数。此字段用于用户了解数据的整体规模。

取值范围:1 - 2147483647

表6 ServerResponse

参数

参数类型

描述

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

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

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

默认取值:不涉及。

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

取值范围:不涉及。

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

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

状态码:400

表13 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

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

取值范围:不涉及。

状态码:401

表15 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

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

取值范围:不涉及。

状态码:403

表17 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号

表18 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

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

取值范围:不涉及。

状态码:500

表19 响应Header参数

参数

参数类型

描述

X-Request-Id

String

链路追踪编号

表20 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

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

取值范围:不涉及。

请求示例

post https://{endpoint}/v1/{project_id}/dev-servers/action

{
  "type" : "START",
  "servers" : [ {
    "id" : "b6dfd2ba-ac27-49cc-9fa5-750a1ad6342e"
  }, {
    "id" : "75751015-8929-434f-a346-c0c4c3afa547"
  } ]
}

响应示例

状态码:200

OK

{
  "current" : 0,
  "data" : [ {
    "charging_mode" : "POST_PAID",
    "cloud_server" : {
      "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28",
      "type" : "ECS"
    },
    "create_at" : 1699352013484,
    "endpoints" : [ {
      "service" : "SSH",
      "uri" : "192.168.0.23"
    } ],
    "flavor" : "Si2.large.4",
    "id" : "c65c4f27-f791-452b-9098-a2726fa2e922",
    "image" : {
      "arch" : "X86",
      "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7",
      "name" : "Ubuntu18.04_x86_64_CPU",
      "server_type" : "ECS"
    },
    "name" : "EI-evs-01",
    "status" : "RUNNING",
    "update_at" : 1699352058465,
    "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172"
  }, {
    "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" : "CREATING",
    "update_at" : 1699348285077
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Internal Error

错误码

请参见错误码