文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 导出该版本的桌面列表 - ExportDesktopVersionList
更新时间：2026-07-24 GMT+08:00
查看PDF
分享

导出该版本的桌面列表 - ExportDesktopVersionList

功能介绍

根据agent版本号、操作系统类型、桌面名称、用户名等条件导出桌面版本列表的Excel文件。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:desktops:exportListByVersion

    List

    desktop *

    -

    -

    -

URI

GET /v2/{project_id}/desktops/list-by-version/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

agent_version

是

String

桌面agent版本号（精确匹配）。

os_type

是

String

桌面操作系统类型。

desktop_id

否

String

桌面ID。

desktop_name

否

String

桌面名称（支持模糊匹配）。

username

否

String

用户名（支持模糊匹配）。

language

是

String

语言。

  • zh_CN：中文

  • en_US：英文

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

task_id

String

任务id。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

无

响应示例

状态码：200

返回task_id。

{
  "task_id" : "task-id"
}

状态码

状态码

描述

200

返回task_id。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题： 桌面