调用本接口导出的共享型云电脑列表将保存为XLSX文件。每条共享型云电脑数据包括共享型云电脑ID和名称、办公网络ID和名称、共享型云电脑模板、安全策略名称等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:ExportDesktopGroupInfo | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
OfficeSiteId | string | 否 | 共享型云电脑所属的办公网络 ID。 | cn-hangzhou+dir-467671**** |
DesktopGroupName | string | 否 | 共享型云电脑名称。 | CloudComputerPool01 |
MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
NextToken | string | 否 | 下一个查询开始的 Token,NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
PolicyGroupId | string | 否 | 共享型云电脑关联的策略 ID。 | pg-53iyi2aar0nd6**** |
ChargeType | string | 否 | 共享型云电脑的计费方式。 枚举值:
| PrePaid |
ExpiredTime | string | 否 | 包年包月共享型云电脑的到期时间。 | 2022-12-31T15:59Z |
DesktopGroupId | array | 否 | 共享型云电脑 ID 列表。 | |
string | 否 | 共享型云电脑 ID。可设置 1~100 个。 | dg-2i8qxpv6t1a03**** | |
EndUserId | array | 否 | 共享型云电脑的授权用户 ID 列表。 | |
string | 否 | 共享型云电脑的授权用户 ID。可设置 1~100 个。 | alice | |
LangType | string | 否 | 语言类型。 枚举值:
| zh-CN |
Tag | array<object> | 否 | 标签列表,最多包含 20 个子项。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 | TestKey |
Value | string | 否 | 标签值。可以为空字符串。最多支持 128 个字符,不能以 | TestValue |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ExportDesktopGroup.UnknowError | Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket. | 导出桌面组列表失败,请重试,如果依然失败请提交工单反馈; 可能原因:依赖的OSS服务权限被意外关停等 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |