文档首页/云桌面 Workspace/API参考/云桌面API/桌面/桌面转镜像 - ChangeDesktopToImage
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

桌面转镜像 - ChangeDesktopToImage

功能介绍

桌面转镜像。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/desktops/desktop-to-image

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

image_name

是

String

镜像名称。

image_description

否

String

镜像描述信息。

desktop_id

是

String

用于制作镜像的云桌面的InstanceID。

execute_sysprep

否

Boolean

是否执行系统封装步骤。

image_tags

否

Array of TagKeyValue objects

镜像标签列表。

enterprise_project_id

否

String

表示当前镜像所属的企业项目。取值为0或无该值，表示属于default企业项目。取值为UUID，表示属于该UUID对应的企业项目。

is_clear_data

否

Boolean

当不封装镜像时,用此字段来区分是否删除用户信息，默认为false。不删除用户信息：false，删除用户信息：true。

max_ram

否

String

表示镜像支持的最大内存，单位为MB。

min_ram

否

String

表示镜像支持的最小内存，单位为MB，默认为0，表示不受限制。

表3 TagKeyValue

参数

是否必选

参数类型

描述

key

否

String

标签的键。

value

否

String

标签的值。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_id

String

桌面转镜像任务id。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：409

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

{
  "image_name" : "string",
  "image_description" : "string",
  "desktop_id" : "string",
  "execute_sysprep" : "true",
  "image_tags" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "enterprise_project_id" : "string",
  "max_ram" : "string",
  "min_ram" : "string"
}

响应示例

状态码：200

桌面转镜像响应。

{
  "job_id" : "string"
}

状态码

状态码

描述

200

桌面转镜像响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题：桌面