首页 无影云桌面 API参考(云桌面管控) API目录 桌面组 DescribeDesktopsInGroup - 查询桌面组的桌面

DescribeDesktopsInGroup - 查询桌面组的桌面

按付费类型查询桌面组包含的桌面列表。

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
DesktopGroupIdstring

桌面组ID。

dg-2i8qxpv6t1a03****
PayTypestring

付费类型。

PrePaid
MaxResultsinteger

分页查询时每页行数。 最大值:100。 默认值:10。

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
IgnoreDeletedboolean

是否忽略删除标志。

true

返回参数

名称类型描述示例值
object

返回对象。

PostPaidDesktopsCountinteger

按量付费桌面总数。

10
NextTokenstring

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
PaidDesktopsCountinteger

包年包月桌面总数。

10
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
PostPaidDesktopsTotalAmountinteger

按量付费桌面的账单总额。

10000
PaidDesktopsarray

包年包月桌面列表。

object

包年包月桌面对象。

EndUserIdstring

授权用户。

alice
DesktopStatusstring

桌面状态。

Running
DesktopNamestring

桌面名称。

testName
ConnectionStatusstring

连接状态。

Connected
DesktopIdstring

桌面ID。

ud-7ftf5b6yu77b0****
EndUserNamestring

授权用户名。

alice
ManagementFlagstring

管理标识。

NoFlag
EndUserIdsarray

当前连接用户ID列表,如果未连接状态则为空。

string

用户ID。

alice
EndUserNamesarray

当前用户名列表,如果未连接状态则为空。

string

用户名称。

alice
ResetTimestring

云桌面的重置时间。

2021-03-03 08:48:08
ImageIdstring

镜像ID。

m-hn5v2mmk0****
ImageNamestring

镜像名称。

Win10_ZC
SystemDiskSizeinteger

系统盘大小,单位:GiB。

80
OsTypestring

操作系统类型。

Windows
GpuDriverVersionstring

GPU驱动版本。

1.0
DiskTypestring

磁盘类型。

SYSTEM
ManagementFlagsarray
string
MemberEniIpstring
PrimaryEniIpstring
PostPaidDesktopsarray

按量付费桌面列表。

object

按量付费桌面对象。

CreateDurationstring

保留时长。

4153958447
EndUserIdstring

授权用户。

alice
DesktopStatusstring

桌面状态。

Stopped
CreateTimestring

创建时间。

2022-01-21T06:34:57Z
ReleaseTimestring

释放时间。

2022-01-21T16:34:57Z
DesktopNamestring

桌面名称。

testName
ConnectionStatusstring

连接状态。

Connected
DesktopIdstring

桌面ID。

ud-2i8qxpv6t1a07****
EndUserNamestring

授权用户名。

alice
ManagementFlagstring

管理标识。

NoFlag
EndUserIdsarray

当前连接用户ID列表,如果未连接状态则为空。

string

用户ID。

alice
EndUserNamesarray

当前用户名列表,如果未连接状态则为空。

string

用户名称。

alice
ResetTimestring

云桌面的重置时间。

2021-03-03 08:48:08
ImageIdstring

镜像ID。

m-hn5v2mmk0****
ImageNamestring

镜像名称。

Win10_ZC
SystemDiskSizeinteger

系统盘大小,单位:GiB。

80
OsTypestring

操作系统类型。

Windows
GpuDriverVersionstring

GPU驱动版本。

1.0
DiskTypestring

磁盘类型。

SYSTEM
ManagementFlagsarray
string
MemberEniIpstring
PrimaryEniIpstring
OnlinePrePaidDesktopsCountinteger

已连接的包年包月付费桌面的数量。

100
RunningPrePaidDesktopsCountinteger

运行中的包年包月付费桌面的数量。

100
StopedPrePaidDesktopsCountinteger

已停止的包年包月付费桌面的数量。

100

示例

正常返回示例

JSON格式

{
  "PostPaidDesktopsCount": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PaidDesktopsCount": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "PostPaidDesktopsTotalAmount": 10000,
  "PaidDesktops": [
    {
      "EndUserId": "alice",
      "DesktopStatus": "Running",
      "DesktopName": "testName",
      "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": [
        ""
      ],
      "MemberEniIp": "",
      "PrimaryEniIp": ""
    }
  ],
  "PostPaidDesktops": [
    {
      "CreateDuration": "4153958447",
      "EndUserId": "alice",
      "DesktopStatus": "Stopped",
      "CreateTime": "2022-01-21T06:34:57Z",
      "ReleaseTime": "2022-01-21T16:34:57Z",
      "DesktopName": "testName",
      "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": [
        ""
      ],
      "MemberEniIp": "",
      "PrimaryEniIp": ""
    }
  ],
  "OnlinePrePaidDesktopsCount": 100,
  "RunningPrePaidDesktopsCount": 100,
  "StopedPrePaidDesktopsCount": 100
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-10-14API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
阿里云首页 无影云桌面 相关技术圈