文档

DescribeDesktopsInGroup - 查询云电脑池内的云电脑

更新时间:

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

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
DesktopGroupIdstring

云电脑池 ID。

dg-2i8qxpv6t1a03****
PayTypestring

付费类型。

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

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

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
IgnoreDeletedboolean

是否忽略删除标志位。

枚举值:
  • true忽略删除标志位,意味着展示删除的云电脑 [默认值]
  • false不忽略删除标志位,意味着不展示删除的云电脑
true

返回参数

名称类型描述示例值
object

返回信息集合。

PostPaidDesktopsCountinteger

按量付费云电脑总数。

10
NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
PaidDesktopsCountinteger

包年包月云电脑总数。

10
RequestIdstring

请求 ID。

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

按量付费云电脑的账单总额。

10000
PaidDesktopsobject []

包年包月云电脑列表。

EndUserIdstring

授权用户。

alice
DesktopStatusstring

云电脑状态。

枚举值:
  • Stopped已关机
  • Starting启动中
  • Rebuilding重建中
  • Running运行中
  • Stopping停止中
  • Expired已过期
  • Deleted已删除
  • Pending等待中
Running
DesktopNamestring

云电脑名称。

DemoComputer
ConnectionStatusstring

连接状态。

枚举值:
  • Unknown未知
  • Connected已连接
  • Disconnected断开连接
Connected
DesktopIdstring

云电脑 ID。

ud-7ftf5b6yu77b0****
EndUserNamestring

授权用户名。

alice
ManagementFlagstring

管理标识。

枚举值:
  • Updating变配中
  • NoFlag无标识
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

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
GpuDriverVersionstring

GPU 驱动版本。

1.0
DiskTypestring

磁盘类型。

枚举值:
  • SYSTEM系统盘
  • DATA数据盘
SYSTEM
ManagementFlagsarray

管理标识列表。

string

管理标识。

枚举值:
  • Updating变配中
  • NoFlag无标识
NoFlag
MemberEniIpstring

实例的成员网卡 IP。

192.168.XX.XX
PrimaryEniIpstring

实例的主网卡 IP。

192.168.XX.XX
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
FotaVersionstring

镜像版本信息。

0.1.0-R-20220914.17****
PostPaidDesktopsobject []

按量付费云电脑列表。

CreateDurationstring

保留时长。单位:毫秒。

4153958447
EndUserIdstring

授权用户。

alice
DesktopStatusstring

云电脑状态。

枚举值:
  • Stopped已关机
  • Starting启动中
  • Rebuilding重建中
  • Running运行中
  • Stopping停止中
  • Expired已过期
  • Deleted已删除
  • Pending等待中
Stopped
CreateTimestring

创建时间。

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

释放时间。

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

云电脑名称。

DemoComputer
ConnectionStatusstring

连接状态。

枚举值:
  • Unknown未知
  • Connected已连接
  • Disconnected已断开连接
Connected
DesktopIdstring

云电脑 ID。

ud-2i8qxpv6t1a07****
EndUserNamestring

授权用户名。

alice
ManagementFlagstring

管理标识。

枚举值:
  • Updating变配中
  • NoFlag无标识
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

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
GpuDriverVersionstring

GPU 驱动版本。

1.0
DiskTypestring

磁盘类型。

枚举值:
  • SYSTEM系统盘
  • DATA数据盘
SYSTEM
ManagementFlagsarray

管理标识集合。

string

管理标识。

枚举值:
  • Updating变配中
  • NoFlag无标识
NoFlag
MemberEniIpstring

实例的成员网卡 IP。

192.168.XX.XX
PrimaryEniIpstring

实例的主网卡 IP。

192.168.XX.XX
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
HDX
FotaVersionstring

镜像版本信息。

0.1.0-R-20220914.17****
OnlinePrePaidDesktopsCountinteger

已连接的包年包月云电脑的数量。

100
RunningPrePaidDesktopsCountinteger

运行中的包年包月云电脑的数量。

100
StopedPrePaidDesktopsCountinteger

已停止的包年包月云电脑的数量。

100
StoppedPrePaidDesktopsCountinteger

已停止的包年包月云电脑的数量。

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-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-10-14API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈