批量修改服务器的镜像 - BatchChangeServerImage

功能介绍

批量修改服务器的镜像。

服务器的镜像和服务器组的镜像不一样时，支持服务器的镜像切换为服务器组的镜像，并且仅允许同等镜像进行切换，例如：同操作系统，免费镜像切换，同源同价的付费镜像切换。如果服务器组的镜像和服务器的镜像为非同等镜像，建议您直接购买新的服务器，删除或者退订老的服务器。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:server:batchChangeImage	Write	server *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	ims:images:list vpc:ports:get vpc:subnets:get

URI

POST /v1/{project_id}/app-servers/actions/batch-change-image

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
server_ids	否	Array of strings	应用服务器id集合。
image_id	是	String	镜像id，要求与服务器原有镜像id不相同。
image_type	是	String	镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他
os_type	是	String	系统类型，当前仅支持Windows。 Linux - Windows - Other -
image_product_id	否	String	镜像的产品id，当镜像是市场镜像时候，该字段必传。
update_access_agent	否	Boolean	是否自动升级hda版本。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
items	Array of ServerJobInfo objects	服务器任务信息。

表5 ServerJobInfo
参数	参数类型	描述
server_id	String	服务器ID。
job_id	String	任务ID。
error_code	String	失败时的错误码。
error_message	String	失败原因。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-change-image

{
  "server_ids" : [ "25b1dd14-0c84-4558-aa57-03a6c54b8e75" ],
  "image_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8",
  "image_type" : "private",
  "os_type" : "Windows",
  "image_product_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8",
  "update_access_agent" : true
}

响应示例

状态码：200

成功响应。

{
  "items" : [ {
    "server_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b",
    "job_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b",
    "error_code" : "",
    "error_message" : ""
  }, {
    "server_id" : "84d5dd05-2977-4e37-8409-cf0b027f6a5b",
    "job_id" : "",
    "error_code" : "WKS.00129901",
    "error_message" : "The service is now unavailable to process the request."
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。