文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 操作桌面
更新时间：2023-10-09 GMT+08:00
查看PDF
分享

操作桌面

功能介绍

批量操作桌面，用于批量开机、关机和重启。

调试

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

URI

POST /v2/{project_id}/desktops/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

否

String

发送的实体的MIME类型。
表3 请求Body参数

参数

是否必选

参数类型

描述

desktop_ids

是

Array of strings

操作的桌面ID列表。

op_type

是

String

操作类型。 -os-start 启动。 -reboot 重启。 -os-stop 关机。 -os-hibernate 休眠。

type

否

String

SOFT：普通操作；HARD：强制操作。例如type为HARD，op_type为os-stop代表强制关机。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

failed_operation_list

Array of VmOperateResult objects

操作失败桌面列表。

job_id

String

任务ID，冷迁移启动时返回。
表5 VmOperateResult

参数

参数类型

描述

desktop_id

String

桌面ID。

desktop_name

String

桌面名称。

error_code

String

操作失败的错误码。

error_msg

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

错误描述。

状态码： 409

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

{
  "desktop_ids" : [ "f77db5cd-c020-47d4-bbbe-9b979a38d18c", "f77db5cd-c020-47d4-bbbe-9b979a38d18b" ],
  "op_type" : "os-stop",
  "type" : "SOFT"
}

响应示例

状态码： 200

正常

{
  "job_id" : "abc85365-0b2e-4b4f-a091-f7db72072d4b"
}

状态码

状态码

描述

200

正常

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

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

错误码

请参见错误码。

父主题： 桌面