DescribeDesktops_无影云电脑_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecd:DescribeDesktops	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。示例值:cn-hangzhou
GroupIdstring	云电脑池 ID。示例值:dg-boyczi8enfyc5****参考取值来源: BindConfigGroup ModifyTimerGroup UnbindConfigGroup ClonePolicyGroup AddUserToDesktopGroup CreateConfigGroup
DesktopStatusstring	云电脑状态。示例值:Running枚举值:StoppedStartingRebuildingRunningStoppingExpiredDeletedPending
MaxResultsinteger<int32>	分页查询时每页行数。展开详情示例值:10取值 <= 1000
NextTokenstring	下一个查询开始的 Token，NextToken 为空表示没有下一个。示例值:caeba0bbb2be03f84eb48b699f0a4883
UserNamestring	用户名称。示例值:Alice
DesktopNamestring	云电脑名称。示例值:DemoComputer01参考取值来源: DescribeFotaPendingDesktops
DirectoryIdstring	目录 ID。同办公网络 ID。示例值:cn-hangzhou+dir-363353****参考取值来源: CreateRAMDirectory
OfficeSiteIdstring	办公网络 ID。示例值:cn-hangzhou+dir-363353****参考取值来源: DescribeOfficeSites CreateSimpleOfficeSite ListOfficeSiteOverview
OfficeSiteNamestring	办公网络名称。示例值:default参考取值来源: ListOfficeSiteOverview
PolicyGroupIdstring	云电脑策略 ID。示例值:system-all-enabled-policy参考取值来源: ClonePolicyGroup CreatePolicyGroup DescribePolicyGroups GetDesktopGroupDetail
ChargeTypestring	云电脑的计费方式。示例值:PostPaid枚举值:PostPaidPrePaid
ExpiredTimestring	包年包月云电脑的到期时间。示例值:2022-12-31T15:59:59Z
ProtocolTypestring	协议类型。示例值:ASP枚举值:HDXASP
DesktopIdarray<string>	云电脑 ID。可设置 1~100 个。示例值:ecd-gx2x1dhsmucyy****子级条数 <= 100
EndUserIdarray<string>	云电脑的授权用户列表。可设置 1~100 个。展开详情示例值:alice子级条数 <= 100
ExcludedEndUserIdarray<string>	要排除的云电脑授权用户列表。可设置 1~100 个。示例值:andy子级条数 <= 50
FilterDesktopGroupboolean	是否排除池化云电脑（云电脑池中的云电脑）。示例值:false枚举值:truefalse
ManagementFlagstring	管理标识。示例值:NoFlag枚举值:MigratingUpdatingNoFlag
QueryFotaUpdateboolean	是否查询云电脑镜像版本信息。示例值:false枚举值:truefalse
Tagarray<object>	标签列表。一个标签由一对键值对组成，用于标记资源。您可以使用标签来分组管理云电脑，便于搜索和批量操作，详情参见使用标签管理云电脑。子级条数 <= 20
SnapshotPolicyIdstring	快照策略 ID。示例值:sp-hb12mclyne09xw***
OnlyDesktopGroupboolean	是否只查询池化云电脑（云电脑池中的云电脑）。示例值:true
DesktopGroupIdstring	云电脑池 ID。如果传入了`DesktopId`，则忽略该`DesktopGroupId`；如果`DesktopId`为空，则会根据`DesktopGroupId`去获取该云电脑池内所有云电脑的`DesktopId`。示例值:dg-2i8qxpv6t1a03****参考取值来源: CreateDesktopGroup AddUserToDesktopGroup DescribeDesktopGroups
OsTypesarray<string>	操作系统类型。子级条数 <= 10
DesktopTypestring	云电脑规格。您可以调用 DescribeDesktopTypes 查询云电脑支持的规格 ID。示例值:eds.general.2c8g参考取值来源: DescribeDesktopTypes
ImageIdarray<string>	镜像 ID 列表。子级条数 <= 100
DesktopStatusListarray<string>	云电脑状态列表。子级条数 <= 10
GpuInstanceGroupIdstring	弹性显卡池 ID。示例值:gp-0bm2iz1v6m6nx****
QosRuleIdstring	公网限速规则 ID。示例值:qos-5605u0gelk200****
SubPayTypestring	云电脑购买方式。示例值:monthPackage枚举值:durationpostPaidmonthPackageprePaid
ResourceGroupIdstring	企业资源组 ID。示例值:rg-4hsvzbbmqdzu3s****参考取值来源: DescribeResourceByCenterPolicyId
FillResourceGroupboolean	是否查询企业资源组信息。示例值:true
PageNumberinteger<int32>	分页查询时，当前页的页码。示例值:1
PageSizeinteger<int32>	分页查询时，每页最大行数。示例值:10
MultiResourceboolean	是否有多个资源。示例值:false

返回参数

字段名称	字段详情
NextTokenstring	下一个查询开始的 Token，NextToken 为空表示没有下一个。示例值:caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring	请求 ID。示例值:484256DA-D816-44D2-9D86-B6EE4D5BA78C
TotalCountinteger<int32>	云电脑总数量。示例值:1
Desktopsarray<object>	云电脑详细信息。
PageNumberinteger<int32>	分页查询时，当前页的页码。示例值:1
PageSizeinteger<int32>	分页查询时，每页最大行数。示例值:10

返回示例

变更历史

	变更时间	变更内容概要	操作
	2025-03-18	变更返回参数
	2025-02-17	变更返回参数
	2025-01-24	新增请求参数MultiResource
	2024-10-29	新增请求参数PageNumber 新增请求参数PageSize 变更返回参数
	2024-07-04	新增请求参数ResourceGroupId 新增请求参数FillResourceGroup 变更返回参数
	2024-06-17	新增请求参数GpuInstanceGroupId 新增请求参数QosRuleId 新增请求参数SubPayType

1
2
3
4
10 条/页

DescribeDesktops_无影云电脑_API文档

流控信息

授权信息

请求参数

返回参数

返回示例

变更历史

相关示例