响应参数
4.3 批量操作
4.3.1 批量启动云服务器
功能介绍
根据给定的云服务器ID列表，批量启动云服务器，一次最多可以启动1000台。
URI
POST /v1/{project_id}/cloudservers/action 参数说明请参见表4-67。
表4-67 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
请求消息
表4-68 请求参数
参数 是否必选 参数类型 描述
os-start 是 Object 标记为启动云服务器操作，详情请 参见表4-69。
表4-69 os-start 字段数据结构说明
参数 是否必选 参数类型 描述
servers 是 Array of objects 云服务器ID列表，详情请参见表 4-70。
表4-70 servers 字段数据结构说明
参数 是否必选 参数类型 描述
id 是 String 云服务器ID。
响应消息
请参考响应（任务类）。
请求示例
启动云服务器请求参数中，必须以“os-start”字段下发启动云服务器请求，请参见下 面的请求示例。
POST https://{endpoint}/v1/{project_id}/cloudservers/action { "os-start": {
"servers": [ {
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
}, {
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
} ] } }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.3.2 批量重启云服务器
功能介绍
根据给定的云服务器ID列表，批量重启云服务器，一次最多可以重启1000台。
URI
POST /v1/{project_id}/cloudservers/action 参数说明请参见表4-71。
表4-71 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
请求消息
请求参数如表4-72所示。
表4-72 请求参数
参数 是否必选 参数类型 描述
reboot 是 Object 标记为重启云服务器操作，详情请参 见表4-73。
表4-73 reboot 字段数据结构说明
参数 是否必选 参数类型 描述
type 是 String 重启类型：
● SOFT：普通重启。
● HARD：强制重启。
servers 是 Array of objects 云服务器ID列表，详情请参见表 4-74。
表4-74 servers 字段数据结构说明
参数 是否必选 参数类型 描述
id 是 String 云服务器ID。
响应消息
请参考响应（任务类）。
请求示例
重启云服务器请求参数中，必须以”reboot”字段下发重启云服务器请求，详见请求 示例。POST https://{endpoint}/v1/{project_id}/cloudservers/action
{ "reboot": { "type":"SOFT",
"servers": [ {
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
}, {
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
} ] } }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.3.3 批量关闭云服务器
功能介绍
根据给定的云服务器ID列表，批量关闭云服务器，一次最多可以关闭1000台。
URI
POST /v1/{project_id}/cloudservers/action 参数说明请参见表4-75。
表4-75 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
请求消息
表4-76 请求参数
参数 是否必选 参数类型 描述
os-stop 是 Object 标记为关闭云服务器操作，详
情请参见表4-77。
表4-77 os-stop 字段数据结构说明
参数 是否必选 参数类型 描述
servers 是 Array of objects 云服务器ID列表，详情请参见 表4-78。
type 否 String 关机类型，默认为SOFT：
SOFT：普通关机（默认）。
HARD：强制关机。
表4-78 servers 字段数据结构说明
参数 是否必选 参数类型 描述
id 是 String 云服务器ID。
响应消息
请参考响应（任务类）。
请求示例
关闭云服务器请求参数，必须如请求示例中，以”os-stop”字段下发关闭云服务器请 求。POST https://{endpoint}/v1/{project_id}/cloudservers/action
{ "os-stop": { "type":"HARD", "servers": [ {
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
}, {
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
} ] } }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.3.4 批量修改弹性云服务器
功能介绍
批量修改弹性云服务器信息。
当前仅支持批量修改云服务器名称，一次最多可以修改1000台。
URI
PUT /v1/{project_id}/cloudservers/server-name 参数说明请参见表4-79。
表4-79 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
请求消息
请求参数如表4-80所示。
表4-80 请求参数
参数 参数类型 是否必选 描述
name String 是 弹性云服务器修改后的名称。
规则如下：
只能允许包含中文汉字、大小写字母、
数字及 "-" 、 "_" 、"." 字符，长度限 制在64个字符以内。
批量修改弹性云服务器名称时，名不会 自动按序增加数字尾缀。例如： 三个 ECS的名称为test_0001，test_0002，
test_0003，批量修改弹性云服务器名 称为develop，则修改后3个弹性云服务 器名称为develop，develop，
develop。
参数 参数类型 是否必选 描述
dry_run Boolean 否 是否只预检此次请求。
true：发送检查请求，不会修改云服务 器名称。检查项包括是否填写了必需参 数、请求格式、业务限制。如果检查不 通过，则返回对应错误。如果检查通 过，则返回正常响应信息。
响应结构请参见 7.5.1 响应 所示。
false：发送正常请求，通过检查后并且 执行修改云服务器名称的请求。
默认值：false servers Array of
objects 是 待修改的弹性云服务器ID信息，详情请 参见 表4-81。
表4-81 servers 字段数据结构说明
参数 参数类型 是否必
选
描述
id String 是 弹性云服务器ID。
响应消息
响应参数请参见 响应（批量操作类） 所示。
请求示例
PUT https://{endpoint}/v1/{project_id}/cloudservers/server-name { "name": "new-server-name",
"dry_run": false, "servers": [ {
"id":"260a0917-f7df-4b25-93ac-950da6c6b5d6"
}, {
"id":"f6d8df1a-e257-48e2-b617-1dd92ced8c20"
} ] }
响应示例
响应示例请参见 响应（批量操作类）所示。
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.3.5 批量重置弹性云服务器密码
功能介绍
批量重置弹性云服务器管理帐号（root用户或Administrator用户）的密码。
接口约束
● 使用此API，需预先安装重置密码插件。一键式重置密码插件的下载与安装，请参 见《弹性云服务器用户指南》的“安装一键式重置密码插件”章节。
● 弹性云服务器的重置密码请求下发后，脚本执行失败，该API不会报错。
● 弹性云服务器开机或重启后，新密码生效。
● 该接口支持虚拟机状态为开机或者关机状态下执行。
URI
PUT /v1/{project_id}/cloudservers/os-reset-passwords 参数说明请参见表4-82。
表4-82 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目ID。
请求消息
请求参数如表4-83所示。
表4-83 请求参数
参数 参数类型 是否必选 描述
new_password String 是 新密码。
当dry_run字段为true时，该字段为非 必填字段，否则为必填字段。
新密码的校验规则：
● 密码长度范围为8到26位。
● 允许输入的字符包括：!@%-_=+
[]:./?
● 禁止输入的字符包括：汉字及
【】：；“”‘’、，。《》？￥
…（）—— ·！~`#&^,{}*();"'<>|\ $
● 复杂度上必须包含大写字母（A-Z）、小写字母（a-z）、数字
（0-9）、以及允许的特殊字符中的 3种以上搭配
● 不能包含用户名 "Administrator" 和
“root”及逆序字符
● 不能包含用户名 "Administrator" 中 连续3个字符
dry_run Boolean 否 是否只预检此次请求。
● true：发送检查请求，不会重置密 码。检查项包括是否填写了必需参 数、请求格式、业务限制。如果检 查不通过，则返回对应错误。如果 检查通过，则返回响应结果。
● false：发送正常请求，通过检查后 并且进行重置密码请求。
默认值：false servers Array of
objects 是 待批量重置密码的弹性云服务器ID信 息，详情参见 表4-84。
表4-84 servers 字段数据结构说明
参数 参数类型 是否必
选
描述
id String 是 弹性云服务器ID。
响应消息
响应参数请参见 响应（批量操作类） 所示。
请求示例
说明
请求中的密码仅为示例，请勿复制使用该示例密码。
PUT https://{endpoint}/v1/{project_id}/cloudservers/os-reset-passwords { "new_password": "YNbUwp!dUc9MClnv",
"dry_run": true, "servers": [ {
"id":"1bd0eb17-4466-4c15-a9ce-87727ad311b5"
}, {
"id":"fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2"
} ] }
响应示例
响应示例请参见响应（批量操作类）所示。
返回值
请参考通用请求返回值。
错误码
请参考错误码。
4.3.6 批量挂载指定共享盘
功能介绍
将指定的共享磁盘一次性挂载到多个弹性云服务器，实现批量挂载。
接口约束
每台弹性云服务器上已挂载的磁盘总量不超过23张。
URI
POST /v1/{project_id}/batchaction/attachvolumes/{volume_id}
参数说明请参见表4-85。
表4-85 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方法请参见获取项目 ID。
参数 是否必选 描述
volume_id 是 共享磁盘ID。
请求消息
请求参数如表4-86所示。
表4-86 请求参数
参数 是否必选 参数类型 描述
serverinfo 是 Array of
objects 共享磁盘需要挂载的弹性云服务器列 表。详细请参见表4-87。
表4-87 serverinfo 列表数据结构说明
参数 是否必选 参数类型 描述
server_id 是 String 共享磁盘需要挂载的弹性云服务器ID。
device 否 String 磁盘挂载点。
说明
● 新增加的磁盘挂载点不能和已有的磁盘 挂载点相同。
● 对于采用XEN虚拟化类型的弹性云服务 器，device为必选参数；系统盘挂载点 请指定/dev/sda；数据盘挂载点请按英 文字母顺序依次指定，如/dev/
sdb，/dev/sdc，如果指定了以
“/dev/vd”开头的挂载点，系统默认改 为“/dev/sd”。
● 对于采用KVM虚拟化类型的弹性云服务 器，系统盘挂载点请指定/dev/vda；数 据盘挂载点可不用指定，也可按英文字 母顺序依次指定，如/dev/vdb，/dev/
vdc，如果指定了以“/dev/sd”开头的 挂载点，系统默认改为“/dev/vd”。
响应消息
请参考响应（任务类）。
请求示例
POST https://{endpoint}/v1/{project_id}/batchaction/attachvolumes/{volume_id}
{ "serverinfo": [ {
"server_id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "device": "/dev/sdb"
}, {
"server_id": "a26887c6-c47b-4654-abb5-dfadf7d3fa05", "device": "/dev/sdb"
} ] }
响应示例
无
返回值
请参考通用请求返回值。
错误码
请参考错误码。