文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 导出桌面列表
更新时间：2025-11-05 GMT+08:00
查看PDF
分享

导出桌面列表

功能介绍

导出桌面列表的excel文件。

调试

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

URI

GET /v3/{project_id}/desktops/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

computer_name

否

String

桌面名。

desktop_ip

否

String

桌面IP地址。

desktop_id

否

String

桌面ID。

tag

否

String

桌面的标签。标签的键和标签的值用“=”连接。

language

是

String

语言。

  • zh_CN：中文

  • en_US：英文

enterprise_project_id

否

String

企业项目ID。

desktop_type

否

String

桌面类型，为空时查所有桌面。

  • DEDICATED：普通桌面，包括专享桌面、专属桌面等

  • POOLED：池桌面，即桌面池里的桌面

status

否

String

桌面状态。

  • ACTIVE：运行中。

  • SHUTOFF：关机。

  • ERROR：异常。

  • HIBERNATED：休眠。

user_names

否

Array of strings

桌面所属用户，批量筛选，最多不超过100个用户。

sort_field

否

String

排序字段名称，需要结合sort_type字段一起使用。

  • created 创建时间。

  • computer_name 桌面名称。

sort_type

否

String

排序类型，默认升序，需要结合sort_field字段一起使用。

  • ASC 升序。

  • DESC 降序。

pool_id

否

String

桌面池ID,多个桌面池ID用逗号隔开。

user_attached

否

Boolean

是否分配了用户。

image_id

否

String

镜像ID。

charge_mode

否

String

计费模式，0：包周期，1：按需。

in_maintenance_mode

否

Boolean

按照维护模式过滤。

subnet_id

否

String

桌面的子网ID。

connection_status_version

否

String

连接状态版本，默认值为OLD。

  • NEW：新版本

  • OLD：老版本

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

task_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接口进行解密。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

无

响应示例

状态码：200

返回task_id。

{
  "task_id" : "string"
}

状态码

状态码

描述

200

返回task_id。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题： 桌面

相关文档