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

DescribeUsersInGroup - 查询共享型云电脑授权用户详情

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

查询共享型云电脑所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等。

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
DesktopGroupIdstring是

共享型云电脑 ID。

dg-8ttn55ujj8nj8****
MaxResultsinteger否

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10
NextTokenstring否

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

caeba0bbb2be03f84eb48b699f0a4883
EndUserIdstring否

授权用户 ID。

alice
ConnectStateinteger否

用户连接状态。

枚举值:
  • 0:未连接。
  • 1:已连接。
1
QueryUserDetailboolean否

是否查询用户详情。

枚举值:
  • true:查询用户详情 [默认值]。
  • false:不查询用户详情。
true
Filterstring否

模糊查询字符串。包含该字符串的结果都将被匹配出来。

alice
OrgIdstring否

用户所属的组织 ID。

org-d0fua2oyukw8j****
EndUserIdsarray否

授权用户 ID 列表。

string否

授权用户 ID。只支持精确匹配。

alice

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

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

符合查询条件的共享型云电脑授权用户总数。

1
OnlineUsersCountinteger

符合查询条件且目前已连接云电脑的共享型云电脑授权用户总数。

0
EndUsersarray<object>

授权用户信息列表。

EndUserobject

授权用户信息。

EndUserIdstring

授权用户 ID。

alice
EndUserEmailstring

授权用户的邮箱地址。

alice@example.com
DesktopNamestring

云电脑名称。

testName
ConnectionStatusstring

连接状态。

枚举值:
  • 0:未连接。
  • 1:连接中。
1
DesktopIdstring

云电脑 ID。

ecd-gx2x1dhsmucyy****
EndUserTypestring

用户账号体系类型。

枚举值:
  • SIMPLE:便捷账号。
  • AD_CONNECTOR:企业AD账号。
SIMPLE
EndUserPhonestring

授权用户的手机号。

1381111****
EndUserNamestring

授权用户的用户名。

alice
ExternalInfoobject

附加信息。

ExternalNamestring

外部名称。

nameDemo
JobNumberstring

工号。

123
UserSetPropertiesModelsarray<object>

用户座位信息列表。

userSetPropertiesModelsobject

用户座位信息。

UserIdlong

用户 ID。

123
UserNamestring

用户名称。

nameDemo
PropertyIdlong

属性 ID。

123
PropertyKeystring

属性名称。

key
PropertyTypeinteger

属性类型。

枚举值:
  • 1:系统属性。
  • 2:用户自定义属性。
1
PropertyValuesarray<object>

属性值数组。

propertyValuesobject

属性值对象。

PropertyValueIdlong

属性值 ID。

123
PropertyValuestring

属性值。

value
UserDesktopIdstring

用户对应的虚拟云电脑 ID。

ud-i896ze8hazpvl****
EndUserRemarkstring

用户备注。

Note
DisplayNamestring

企业 AD 账号的显示名称。

alice

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "UsersCount": 1,
  "OnlineUsersCount": 0,
  "UserOuPath": "",
  "EndUsers": [
    {
      "EndUserId": "alice",
      "EndUserEmail": "alice@example.com",
      "DesktopName": "testName",
      "ConnectionStatus": "1",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "EndUserType": "SIMPLE",
      "EndUserPhone": "1381111****",
      "EndUserName": "alice",
      "ExternalInfo": {
        "ExternalName": "nameDemo",
        "JobNumber": "123"
      },
      "UserSetPropertiesModels": [
        {
          "UserId": 123,
          "UserName": "nameDemo",
          "PropertyId": 123,
          "PropertyKey": "key",
          "PropertyType": 1,
          "PropertyValues": [
            {
              "PropertyValueId": 123,
              "PropertyValue": "value"
            }
          ]
        }
      ],
      "UserDesktopId": "ud-i896ze8hazpvl****",
      "EndUserRemark": "Note",
      "DisplayName": "alice",
      "UserPrincipalName": "",
      "DisplayNameNew": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-03-24OpenAPI 返回结构发生变更查看变更详情
2022-04-13OpenAPI 入参发生变更查看变更详情
相关文章

AddUserToDesktopGroup - 为共享型云电脑添加授权用户 2025-04-17 11:22

为共享型云电脑添加授权用户。共享型云电脑内的云电脑会按照管理员设置的规则自动分配给授权用户使用。

DescribeUsersInGroup - 查询共享型云电脑授权用户详情 2025-04-17 11:22

查询共享型云电脑所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等。

DescribeUserConnectionRecords - 查询共享型云电脑的用户连接记录 2025-04-17 11:22

查询云电脑池的授权用户连接池化云电脑的具体记录。

ModifyUserToDesktopGroup - 为共享型云电脑替换授权用户 2025-04-17 11:22

将共享型云电脑的指定授权用户替换为其他指定授权用户。

RemoveUserFromDesktopGroup - 为共享型云电脑移除授权用户 2025-04-17 11:22

将共享型云电脑的指定授权用户移除出去。被移除的用户将无法再连接共享型云电脑内的云电脑。

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