赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 无影云电脑企业版
  4. 开发参考
  5. API参考(云电脑管控)
  6. API目录
  7. 共享型云电脑
  8. 共享型云电脑资源
  9. DescribeDesktopsInGroup - 查询共享型云电脑内的云电脑

DescribeDesktopsInGroup - 查询共享型云电脑内的云电脑

  • 共享型云电脑资源
  • 发布于 2025-04-17
  • 0 次阅读
文档编辑
文档编辑

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribeDesktopsInGroupget
*全部资源
*
    无
无

请求参数

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

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

cn-hangzhou
DesktopGroupIdstring是

共享型云电脑 ID。

dg-2i8qxpv6t1a03****
PayTypestring否

付费类型。

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

分页查询时每页行数。

  • 默认值:10。
  • 最大值:100。
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
PaidDesktopsarray<object>

包年包月云电脑列表。

PaidDesktopobject

包年包月云电脑对象。

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 列表,如果未连接状态则为空。

endUserIdsstring

用户 ID。

alice
EndUserNamesarray

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

endUserNamesstring

用户名称。

alice
ResetTimestring

云电脑的重置时间。

2021-03-03 08:48:08
ImageIdstring

镜像 ID。

m-hn5v2mmk0****
ImageNamestring

镜像名称。

Win10_ZC
SystemDiskSizeinteger

系统盘大小,单位:GiB。

80
OsTypestring

操作系统类型。

枚举值:
  • Linux:Linux。
  • Windows:Windows。
Windows
GpuDriverVersionstring

GPU 驱动版本。

1.0
DiskTypestring

磁盘类型。

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

管理标识列表。

managementFlagsstring

管理标识。

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

实例的成员网卡 IP。

192.168.XX.XX
PrimaryEniIpstring

实例的主网卡 IP。

192.168.XX.XX
ProtocolTypestring

协议类型。

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

镜像版本信息。

0.1.0-R-20220914.17****
PostPaidDesktopsarray<object>

按量付费云电脑列表。

PostPaidDesktopobject

按量付费云电脑对象。

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 列表,如果未连接状态则为空。

endUserIdsstring

用户 ID。

alice
EndUserNamesarray

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

endUserNamesstring

用户名称。

alice
ResetTimestring

云电脑的重置时间。

2021-03-03 08:48:08
ImageIdstring

镜像 ID。

m-hn5v2mmk0****
ImageNamestring

镜像名称。

Win10_ZC
SystemDiskSizeinteger

系统盘大小,单位:GiB。

80
OsTypestring

操作系统类型。

枚举值:
  • Linux:Linux。
  • Windows:Windows。
Windows
GpuDriverVersionstring

GPU 驱动版本。

1.0
DiskTypestring

磁盘类型。

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

管理标识集合。

managementFlagsstring

管理标识。

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

实例的成员网卡 IP。

192.168.XX.XX
PrimaryEniIpstring

实例的主网卡 IP。

192.168.XX.XX
ProtocolTypestring

协议类型。

枚举值:
  • HDX:HDX协议。
  • 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
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-02-27OpenAPI 入参发生变更查看变更详情
2023-06-19OpenAPI 返回结构发生变更查看变更详情
2022-10-14API 内部配置变更,不影响调用查看变更详情
相关文章

CreateDesktopGroup - 创建共享型云电脑 2025-04-17 11:22

创建共享型云电脑。 接口说明

GetDesktopGroupDetail - 获取共享型云电脑详情 2025-04-17 11:22

获取一个共享型云电脑的详细信息。

DescribeDesktopGroups - 查询共享型云电脑列表及详情 2025-04-17 11:22

查询共享型云电脑列表及详情。

ExportDesktopGroupInfo - 导出共享型云电脑列表 2025-04-17 11:22

调用本接口导出的共享型云电脑列表将保存为XLSX文件。每条共享型云电脑数据包括共享型云电脑ID和名称、办公网络ID和名称、共享型云电脑模板、安全策略名称等。

DescribeDesktopsInGroup - 查询共享型云电脑内的云电脑 2025-04-17 11:22

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

DisableDesktopsInGroup - 禁用共享型云电脑中的云电脑 2025-04-17 11:22

禁用共享型云电脑中的云电脑。禁用后,云电脑的状态变为unavailable。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号