首页 无影云桌面 API参考(云桌面管控) API目录 桌面 ExportDesktopListInfo - 导出桌面列表

ExportDesktopListInfo - 导出桌面列表

导出桌面列表。

接口说明

调用本接口导出的云桌面列表将保存为CSV文件,每条云桌面数据包括云桌面ID和名称、工作区ID和名称、所属桌面组ID和名称、vCPU、内存、协议、系统盘容量、数据盘容量、操作系统、当前运行状态、当前使用用户、标签、IP、付费类型、创建时间。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
GroupIdstring

云桌面所属的桌面组ID。

dg-boyczi8enfyc5***
DesktopStatusstring

云桌面状态。取值范围:

  • Pending:等待中
  • Starting:启动中
  • Running:运行中
  • Stopping:停止中
  • Rebuilding:重建中
  • Stopped:已关机
  • Expired:已过期
  • Deleted:已删除
Running
MaxResultsinteger

分页查询时每页行数。

最大值:100。

默认值:10。

10
NextTokenstring

下一个查询开始的Token,NextToken为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
UserNamestring

当前正在使用云桌面的用户名。

alice
DesktopNamestring

云桌面名称。

testName
OfficeSiteIdstring

工作区ID。

cn-hangzhou+dir-363353****
PolicyGroupIdstring

云桌面关联的策略ID。

system-all-enabled-policy
ChargeTypestring

云桌面的计费方式。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid。

PostPaid
ExpiredTimestring

包年包月付费类型桌面的到期时间。

2022-12-31T15:59Z
DesktopIdarray

云桌面ID。可设置一个或多个,N的取值范围:1~100。

string

云桌面ID。可设置一个或多个,N的取值范围:1~100。

ecd-gx2x1dhsmucyy****
EndUserIdarray

已分配云桌面的用户名列表。可设置一个或多个,N的取值范围:1~100。

说明在同一时段内,只有一个用户可以使用该桌面。
string

已分配云桌面的用户名列表。可设置一个或多个,N的取值范围:1~100。

说明在同一时段内,只有一个用户可以使用该桌面。
alice
LangTypestring

前端页面显示的语言类型,后端根据该语言类型设置导出文件的语言类型。可选值及其含义:

  • zh-CN:简体中文
  • en-GB:英语(英国)

默认值:zh-CN

`zh-CN`
Tagarray

标签列表。一个标签由一对键值对组成,用于标记资源。您可以使用标签来分组管理云桌面,便于搜索和批量操作,详情参见使用标签管理云桌面

object

标签键值对。可为每台云桌面设置1~20个键值对,一个标签键只能对应一个标签值。

Keystring

标签键。如果传入Tag,则Key是必填的。不可超过128个字符,不能以aliyunacs:开头,不能包含http://或者https://,也不能仅包含空格。

TestKey
Valuestring

标签值。不可超过128个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestValue

返回参数

名称类型描述示例值
object

返回信息集合。

Urlstring

桌面导出列表的下载地址。

https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "Url": "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

Http code错误码错误信息描述
400ExportDesktop.UnknowErrorFailed to export desktop list. Please try again. If the problem still exists, submit a ticket.导出桌面列表失败,请重试,如果依然失败请提交工单反馈; 可能原因:依赖的OSS服务权限被意外关停等

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-10-14OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-07-07OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Tag
阿里云首页 无影云桌面 相关技术圈