赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 无影云电脑企业版
  4. 开发参考
  5. API参考(云电脑管控)
  6. API目录
  7. 云电脑
  8. 云电脑资源
  9. ExportDesktopListInfo - 导出云电脑列表

ExportDesktopListInfo - 导出云电脑列表

  • 云电脑资源
  • 发布于 2025-04-17
  • 0 次阅读
文档编辑
文档编辑

将云电脑列表导出为CSV文件。

接口说明

调用本接口导出的云电脑列表将保存为 CSV 文件,每条云电脑数据包括以下字段:

  • 云电脑 ID/云电脑名称
  • 办公网络 ID/办公网络名称
  • 规格/系统/协议
  • 系统盘/数据盘
  • 状态
  • 购买方式
  • 过期时间
  • 剩余时长/总时长
  • 分配用户数/当前使用用户
  • 办公网络类型
  • 创建时间
  • 标签
  • 是否加密
  • IP
  • 主机名

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:ExportDesktopListInfo
*全部资源
*
    无
无

请求参数

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

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
GroupIdstring否

云电脑所属的云电脑池 ID。

dg-boyczi8enfyc5***
DesktopStatusstring否

云电脑状态。

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

分页查询时每页行数。

最大值:100。

默认值:10。

10
NextTokenstring否

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

caeba0bbb2be03f84eb48b699f0a4883
UserNamestring否

当前正在使用云电脑的用户名。

alice
DesktopNamestring否

云电脑名称。

DemoComputer01
OfficeSiteIdstring否

办公网络 ID。

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

云电脑关联的策略 ID。

system-all-enabled-policy
ChargeTypestring否

云电脑的计费方式。

枚举值:
  • PostPaid:按量付费 [默认值]。
  • PrePaid:包年包月。
PostPaid
ExpiredTimestring否

包年包月云电脑的到期时间。

2022-12-31T15:59Z
DesktopIdarray否

云电脑 ID。可设置 1~100 个。

string否

云电脑 ID。

ecd-gx2x1dhsmucyy****
EndUserIdarray否

云电脑的授权用户名列表。可设置 1~100 个。

说明 在同一时段内,只有一个用户可以连接和使用该云电脑。
string否

云电脑的授权用户名。

alice
LangTypestring否

前端页面显示的语言类型,后端根据该语言类型设置导出文件的语言类型。

枚举值:
  • zh-CN:简体中文 [默认值]。
  • en-GB:英语(英国)。
`zh-CN`
Tagarray<object>否

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

object否

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

Keystring否

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

TestKey
Valuestring否

标签值。不可超过 128 个字符,不能以aliyun或acs:开头,不能包含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 status code错误码错误信息描述
400ExportDesktop.UnknowErrorFailed to export desktop list. Please try again. If the problem still exists, submit a ticket.导出桌面列表失败,请重试,如果依然失败请提交工单反馈; 可能原因:依赖的OSS服务权限被意外关停等

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

变更历史

变更时间变更内容概要操作
2022-10-14OpenAPI 错误码发生变更查看变更详情
2022-07-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
相关文章

CreateDesktops - 创建一台或多台云电脑 2025-04-17 11:22

创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配。

CreateDiskEncryptionService - 开启磁盘加密功能 2025-04-17 11:22

开启磁盘加密功能,在用户RAM下添加企业网盘加密的服务关联角色(SLR)。

DescribeKmsKeys - 查询用户KMS密钥列表 2025-04-17 11:22

查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。

DescribeDesktopInfo - 查询云电脑基础信息 2025-04-17 11:22

查询云电脑的基础信息。

DescribeDesktops - 查询云电脑详细信息 2025-04-17 11:22

查询云电脑的详细信息。

DescribeDesktopTypes - 查询云电脑规格详细信息 2025-04-17 11:22

查询云电脑规格的详细信息。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号