DescribeDesktopGroups分页
查询共享型云电脑列表及详情
服务地址：
华东1 金融云
输入参数
只看必填
RegionId地域ID
OfficeSiteId共享型云电脑所属的办公网络ID
DesktopGroupName要查询的共享型云电脑名称
DesktopGroupId共享型云电脑ID
Period包年包月共享型云电脑的购买时长
PeriodUnit包年包月计费方式的时长单位
PolicyGroupId共享型云电脑关联的策略ID
Status共享型云电脑的状态
OwnType共享型云电脑类型
EndUserIds共享型云电脑的授权用户ID列表
0共享型云电脑的授权用户ID
添加
ExcludedEndUserIds要排除的已授权用户列表
0要排除的已授权用户
添加
ProtocolType协议类型
ImageId镜像ID列表
0镜像ID
添加
BundleId云电脑模板ID列表
0云电脑模板ID
添加
Tag标签列表
0标签
Key标签键
Value标签值
添加
MultiResource是否为多台共享类型的共享型云电脑
请选择布尔值
DesktopGroupIds共享型云电脑ID列表
0共享型云电脑ID
添加
分页参数
MaxResults分页查询时每页行数
NextToken下一个查询开始的Token
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou
OfficeSiteIdstring

共享型云电脑所属的办公网络 ID。

示例值:cn-hangzhou+dir-467671****参考取值来源:
    DescribeOfficeSites
    ListOfficeSiteOverview
    CreateSimpleOfficeSite
DesktopGroupNamestring

要查询的共享型云电脑名称，支持模糊查询。

示例值:CloudComputerPool01参考取值来源:
    GetDesktopGroupDetail
    DescribeDesktopGroupSessions
DesktopGroupIdstring

共享型云电脑 ID。

示例值:dg-2i8qxpv6t1a03****参考取值来源:
    CreateDesktopGroup
    AddUserToDesktopGroup
    DescribeDesktopInfo
Periodinteger<int32>

包年包月共享型云电脑的购买时长。单位由PeriodUnit指定。展开详情

示例值:1
PeriodUnitstring

包年包月计费方式的时长单位。

示例值:Month枚举值:MonthYear
MaxResultsinteger<int32>

分页查询时每页行数。展开详情

示例值:10
NextTokenstring

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

示例值:caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdstring

共享型云电脑关联的策略 ID。

示例值:pg-53iyi2aar0nd6****参考取值来源:
    ClonePolicyGroup
    CreatePolicyGroup
    DescribePolicyGroups
    GetDesktopGroupDetail
Statusinteger<int32>

共享型云电脑的状态。

示例值:1枚举值:012
OwnTypeinteger<int64>

共享型云电脑类型。展开详情

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:0枚举值:01
EndUserIdsarray<string>

共享型云电脑的授权用户 ID 列表。

子级条数 <= 1000
ExcludedEndUserIdsarray<string>

要排除的已授权用户列表。

子级条数 <= 1000
ProtocolTypestring

协议类型。

示例值:ASP枚举值:HDXASP
ImageIdarray<string>

镜像 ID 列表。

子级条数 <= 100
BundleIdarray<string>

云电脑模板 ID 列表。

子级条数 <= 100
Tagarray<object>

标签列表。可包含 1~20 个。

子级条数 <= 100
MultiResourceboolean

是否为多台共享类型的共享型云电脑。

示例值:true枚举值:truefalse
DesktopGroupIdsarray<string>

共享型云电脑 ID 列表。

子级条数 <= 100

返回参数

字段名称字段详情
NextTokenstring

下一个查询开始的 Token。

示例值:caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

示例值:1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopGroupsarray<object>

共享型云电脑列表。

变更历史
变更时间变更内容概要操作
2025-04-09
变更返回参数
2025-03-24
变更返回参数
2025-01-24
新增请求参数MultiResource
新增请求参数DesktopGroupIds
2024-06-14
新增请求参数Tag
变更返回参数
2023-08-01
删除返回参数
2023-03-17
新增请求参数ImageId
新增请求参数BundleId
2023-01-04
新增请求参数ProtocolType
变更返回参数
2022-08-19
变更返回参数
  • 1
  • 2
  • 10 条/页