将云电脑列表导出为CSV文件。
接口说明
调用本接口导出的云电脑列表将保存为 CSV 文件，每条云电脑数据包括以下字段：
- 云电脑 ID/云电脑名称
- 办公网络 ID/办公网络名称
- 规格/系统/协议
- 系统盘/数据盘
- 状态
- 购买方式
- 过期时间
- 剩余时长/总时长
- 分配用户数/当前使用用户
- 办公网络类型
- 创建时间
- 标签
- 是否加密
- IP
- 主机名
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:ExportDesktopListInfo | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| GroupId | string | 否 | 云电脑所属的云电脑池 ID。 | dg-boyczi8enfyc5*** |
| DesktopStatus | string | 否 | 云电脑状态。 枚举值：
| Running |
| MaxResults | integer | 否 | 分页查询时每页行数。 最大值：100。 默认值：10。 | 10 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| UserName | string | 否 | 当前正在使用云电脑的用户名。 | alice |
| DesktopName | string | 否 | 云电脑名称。 | DemoComputer01 |
| OfficeSiteId | string | 否 | 办公网络 ID。 | cn-hangzhou+dir-363353**** |
| PolicyGroupId | string | 否 | 云电脑关联的策略 ID。 | system-all-enabled-policy |
| ChargeType | string | 否 | 云电脑的计费方式。 枚举值：
| PostPaid |
| ExpiredTime | string | 否 | 包年包月云电脑的到期时间。 | 2022-12-31T15:59Z |
| DesktopId | array | 否 | 云电脑 ID。可设置 1~100 个。 | |
| string | 否 | 云电脑 ID。 | ecd-gx2x1dhsmucyy**** | |
| EndUserId | array | 否 | 云电脑的授权用户名列表。可设置 1~100 个。 说明
在同一时段内，只有一个用户可以连接和使用该云电脑。
| |
| string | 否 | 云电脑的授权用户名。 | alice | |
| LangType | string | 否 | 前端页面显示的语言类型，后端根据该语言类型设置导出文件的语言类型。 枚举值：
| `zh-CN` |
| Tag | array<object> | 否 | 标签列表。一个标签由一对键值对组成，用于标记资源。您可以使用标签来分组管理云电脑，便于搜索和批量操作，详情参见使用标签管理云电脑。 | |
| object | 否 | 标签键值对。可为每台云电脑设置 1~20 个键值对，一个标签键只能对应一个标签值。 | ||
| Key | string | 否 | 标签键。如果传入 | TestKey |
| Value | string | 否 | 标签值。不可超过 128 个字符，不能以 | TestValue |
返回参数
示例
正常返回示例
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 status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ExportDesktop.UnknowError | Failed to export desktop list. Please try again. If the problem still exists, submit a ticket. | 导出桌面列表失败，请重试，如果依然失败请提交工单反馈； 可能原因：依赖的OSS服务权限被意外关停等 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-10-14 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-07-07 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |