调用DescribeDesktopsInGroup查询桌面组的桌面_无影云电脑企业版(EDS)-阿里云帮助中心

按付费类型查询云电脑池包含的云电脑列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
DesktopGroupId	string	是	云电脑池 ID。	dg-2i8qxpv6t1a03****
PayType	string	否	付费类型。枚举值： PostPaid：按量付费。 PrePaid：包年包月。	PrePaid
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
NextToken	string	否	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
IgnoreDeleted	boolean	否	是否忽略删除标志位。枚举值： true：忽略删除标志位，意味着展示删除的云电脑 [默认值]。 false：不忽略删除标志位，意味着不展示删除的云电脑。	true

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
PostPaidDesktopsCount	integer	按量付费云电脑总数。	10
NextToken	string	下一个查询开始的 Token。	caeba0bbb2be03f84eb48b699f0a4883
PaidDesktopsCount	integer	包年包月云电脑总数。	10
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
PostPaidDesktopsTotalAmount	integer	按量付费云电脑的账单总额。	10000
PaidDesktops	array<object>	包年包月云电脑列表。
PaidDesktop	object	包年包月云电脑对象。
EndUserId	string	授权用户。	alice
DesktopStatus	string	云电脑状态。枚举值： Stopped：已关机。 Starting：启动中。 Rebuilding：重建中。 Running：运行中。 Stopping：停止中。 Expired：已过期。 Deleted：已删除。 Pending：等待中。	Running
DesktopName	string	云电脑名称。	DemoComputer
ConnectionStatus	string	连接状态。枚举值： Unknown：未知。 Connected：已连接。 Disconnected：断开连接。	Connected
DesktopId	string	云电脑 ID。	ud-7ftf5b6yu77b0****
EndUserName	string	授权用户名。	alice
ManagementFlag	string	管理标识。枚举值： Updating：变配中。 NoFlag：无标识。	NoFlag
EndUserIds	array	当前连接用户 ID 列表，如果未连接状态则为空。
endUserIds	string	用户 ID。	alice
EndUserNames	array	当前用户名列表，如果未连接状态则为空。
endUserNames	string	用户名称。	alice
ResetTime	string	云电脑的重置时间。	2021-03-03 08:48:08
ImageId	string	镜像 ID。	m-hn5v2mmk0****
ImageName	string	镜像名称。	Win10_ZC
SystemDiskSize	integer	系统盘大小，单位：GiB。	80
OsType	string	操作系统类型。枚举值： Linux：Linux。 Windows：Windows。	Windows
GpuDriverVersion	string	GPU 驱动版本。	1.0
DiskType	string	磁盘类型。枚举值： SYSTEM：系统盘。 DATA：数据盘。	SYSTEM
ManagementFlags	array	管理标识列表。
managementFlags	string	管理标识。枚举值： Updating：变配中。 NoFlag：无标识。	NoFlag
MemberEniIp	string	实例的成员网卡 IP。	192.168.XX.XX
PrimaryEniIp	string	实例的主网卡 IP。	192.168.XX.XX
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研ASP协议。	ASP
FotaVersion	string	镜像版本信息。	0.1.0-R-20220914.17****
PostPaidDesktops	array<object>	按量付费云电脑列表。
PostPaidDesktop	object	按量付费云电脑对象。
CreateDuration	string	保留时长。单位：毫秒。	4153958447
EndUserId	string	授权用户。	alice
DesktopStatus	string	云电脑状态。枚举值： Stopped：已关机。 Starting：启动中。 Rebuilding：重建中。 Running：运行中。 Stopping：停止中。 Expired：已过期。 Deleted：已删除。 Pending：等待中。	Stopped
CreateTime	string	创建时间。	2022-01-21T06:34:57Z
ReleaseTime	string	释放时间。	2022-01-21T16:34:57Z
DesktopName	string	云电脑名称。	DemoComputer
ConnectionStatus	string	连接状态。枚举值： Unknown：未知。 Connected：已连接。 Disconnected：已断开连接。	Connected
DesktopId	string	云电脑 ID。	ud-2i8qxpv6t1a07****
EndUserName	string	授权用户名。	alice
ManagementFlag	string	管理标识。枚举值： Updating：变配中。 NoFlag：无标识。	NoFlag
EndUserIds	array	当前连接用户 ID 列表，如果未连接状态则为空。
endUserIds	string	用户 ID。	alice
EndUserNames	array	当前用户名列表，如果未连接状态则为空。
endUserNames	string	用户名称。	alice
ResetTime	string	云电脑的重置时间。	2021-03-03 08:48:08
ImageId	string	镜像 ID。	m-hn5v2mmk0****
ImageName	string	镜像名称。	Win10_ZC
SystemDiskSize	integer	系统盘大小，单位：GiB。	80
OsType	string	操作系统类型。枚举值： Linux：Linux。 Windows：Windows。	Windows
GpuDriverVersion	string	GPU 驱动版本。	1.0
DiskType	string	磁盘类型。枚举值： SYSTEM：系统盘。 DATA：数据盘。	SYSTEM
ManagementFlags	array	管理标识集合。
managementFlags	string	管理标识。枚举值： Updating：变配中。 NoFlag：无标识。	NoFlag
MemberEniIp	string	实例的成员网卡 IP。	192.168.XX.XX
PrimaryEniIp	string	实例的主网卡 IP。	192.168.XX.XX
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研ASP协议。	HDX
FotaVersion	string	镜像版本信息。	0.1.0-R-20220914.17****
OnlinePrePaidDesktopsCount	integer	已连接的包年包月云电脑的数量。	100
RunningPrePaidDesktopsCount	integer	运行中的包年包月云电脑的数量。	100
StopedPrePaidDesktopsCount	integer	已停止的包年包月云电脑的数量。	100
StoppedPrePaidDesktopsCount	integer	已停止的包年包月云电脑的数量。	100

示例

正常返回示例

JSON格式

{
  "PostPaidDesktopsCount": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PaidDesktopsCount": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "PostPaidDesktopsTotalAmount": 10000,
  "PaidDesktops": [
    {
      "EndUserId": "alice",
      "DesktopStatus": "Running",
      "DesktopName": "DemoComputer",
      "ConnectionStatus": "Connected",
      "DesktopId": "ud-7ftf5b6yu77b0****",
      "EndUserName": "alice",
      "ManagementFlag": "NoFlag",
      "EndUserIds": [
        "alice"
      ],
      "EndUserNames": [
        "alice"
      ],
      "ResetTime": "2021-03-03 08:48:08",
      "ImageId": "m-hn5v2mmk0****",
      "ImageName": "Win10_ZC",
      "SystemDiskSize": 80,
      "OsType": "Windows",
      "GpuDriverVersion": "1.0",
      "DiskType": "SYSTEM",
      "ManagementFlags": [
        "NoFlag"
      ],
      "MemberEniIp": "192.168.XX.XX",
      "PrimaryEniIp": "192.168.XX.XX",
      "ProtocolType": "ASP",
      "FotaVersion": "0.1.0-R-20220914.17****"
    }
  ],
  "PostPaidDesktops": [
    {
      "CreateDuration": "4153958447",
      "EndUserId": "alice",
      "DesktopStatus": "Stopped",
      "CreateTime": "2022-01-21T06:34:57Z",
      "ReleaseTime": "2022-01-21T16:34:57Z",
      "DesktopName": "DemoComputer",
      "ConnectionStatus": "Connected",
      "DesktopId": "ud-2i8qxpv6t1a07****",
      "EndUserName": "alice",
      "ManagementFlag": "NoFlag",
      "EndUserIds": [
        "alice"
      ],
      "EndUserNames": [
        "alice"
      ],
      "ResetTime": "2021-03-03 08:48:08",
      "ImageId": "m-hn5v2mmk0****",
      "ImageName": "Win10_ZC",
      "SystemDiskSize": 80,
      "OsType": "Windows",
      "GpuDriverVersion": "1.0",
      "DiskType": "SYSTEM",
      "ManagementFlags": [
        "NoFlag"
      ],
      "MemberEniIp": "192.168.XX.XX",
      "PrimaryEniIp": "192.168.XX.XX",
      "ProtocolType": "HDX",
      "FotaVersion": "0.1.0-R-20220914.17****"
    }
  ],
  "OnlinePrePaidDesktopsCount": 100,
  "RunningPrePaidDesktopsCount": 100,
  "StopedPrePaidDesktopsCount": 100,
  "StoppedPrePaidDesktopsCount": 100
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-06-19	OpenAPI 返回结构发生变更	查看变更详情
2022-10-14	API 内部配置变更，不影响调用	查看变更详情