ExportDesktopGroupInfo - 导出云电脑池列表

调用本接口导出的云电脑池列表将保存为XLSX文件。每条云电脑池数据包括云电脑池ID和名称、办公网络ID和名称、云电脑池模板、安全策略名称等。

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
OfficeSiteIdstring

云电脑池所属的办公网络 ID。

cn-hangzhou+dir-467671****
DesktopGroupNamestring

云电脑池名称。

CloudComputerPool01
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdstring

云电脑池关联的策略 ID。

pg-53iyi2aar0nd6****
ChargeTypestring

云电脑池的计费方式。

枚举值:
  • PostPaid按量付费
  • PrePaid包年包月
PrePaid
ExpiredTimestring

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

2022-12-31T15:59Z
DesktopGroupIdarray

云电脑池 ID 列表。

string

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

dg-2i8qxpv6t1a03****
EndUserIdarray

云电脑池的授权用户 ID 列表。

string

云电脑池的授权用户 ID。可设置 1~100 个。

alice
LangTypestring

语言类型。

枚举值:
  • zh-CN简体中文
  • en-GB英文(英国)
zh-CN
Tagarray<object>

标签列表,最多包含 20 个子项。

object

标签。

Keystring

标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestKey
Valuestring

标签值。可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

TestValue

返回参数

名称类型描述示例值
object

返回信息集合。

Urlstring

云电脑池列表导出文件的下载地址。导出文件包含的云电脑池详细信息包括:

  • 云电脑池 ID/名称
  • 办公网络 ID/名称
  • 云电脑池模板
  • CPU/内存
  • 系统盘/数据盘
  • 安全策略名称
  • 当前授权用户数量
  • 付费类型
  • 创建时间
  • 到期时间
https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********
RequestIdstring

请求 ID。

24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC

示例

正常返回示例

JSON格式

{
  "Url": "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********",
  "RequestId": "24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-06-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情