首页 无影云桌面 API参考(云桌面管控) API目录 桌面组 DescribeUsersInGroup - 列举桌面组授权用户

DescribeUsersInGroup - 列举桌面组授权用户

获取桌面组的授权用户列表。

调试

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

调试

授权信息

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

请求参数

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

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

cn-hangzhou
DesktopGroupIdstring

桌面组ID。

dg-8ttn55ujj8nj8****
MaxResultsinteger

分页查询时每页行数。

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

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

caeba0bbb2be03f84eb48b699f0a4883
EndUserIdstring

授权用户。

alice
ConnectStateinteger

用户连接状态。

1
QueryUserDetailboolean

是否查询用户详情。

false
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

用户信息对象。

EndUserIdstring

用户名。

alice
EndUserEmailstring

用户邮箱。

alice@example.com
DesktopNamestring

桌面名称。

testName
ConnectionStatusstring

连接状态。

1
DesktopIdstring

桌面ID。

ecd-gx2x1dhsmucyy****
EndUserTypestring

用户账号类型。

SIMPLE
EndUserPhonestring

用户手机号。

1381111****
EndUserNamestring

用户名。

alice
ExternalInfoobject

附加信息。

ExternalNamestring

外部名称。

nameDemo
JobNumberstring

工号。

123
UserSetPropertiesModelsarray

用户座位信息列表。

object

用户座位信息。

UserIdlong

用户ID。

123
UserNamestring

用户名称。

nameDemo
PropertyIdlong

属性ID。

123
PropertyKeystring

属性名称。

key
PropertyTypeinteger

属性类型。

1
PropertyValuesarray

属性值数组。

object

属性值对象。

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,
  "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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-04-13OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:QueryUserDetail
阿里云首页 无影云桌面 相关技术圈