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

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeUsersInGroup

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

DesktopGroupId

string

共享型云电脑 ID。

dg-8ttn55ujj8nj8****

MaxResults

integer

分页查询时每页行数。

  • 最大值:100。

  • 默认值:10。

10

NextToken

string

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

caeba0bbb2be03f84eb48b699f0a4883

EndUserId

string

授权用户 ID。

alice

ConnectState

integer

用户连接状态。

枚举值:

  • 0 :

    未连接

  • 1 :

    已连接

1

QueryUserDetail

boolean

是否查询用户详情。

枚举值:

  • true :

    查询用户详情 [默认值]

  • false :

    不查询用户详情

true

Filter

string

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

alice

OrgId

string

用户所属的组织 ID。

org-d0fua2oyukw8j****

EndUserIds

array

授权用户 ID 列表。

string

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

alice

返回参数

名称

类型

描述

示例值

object

返回信息集合。

NextToken

string

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883

RequestId

string

请求 ID。

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

UsersCount

integer

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

1

OnlineUsersCount

integer

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

0

UserOuPath

string

用户组织单元路径。

example.com

UserGroupName

string

用户组名称。

研发组

EndUsers

array<object>

授权用户信息列表。

array<object>

授权用户信息。

EndUserId

string

授权用户 ID。

alice

EndUserEmail

string

授权用户的邮箱地址。

alice@example.com

DesktopName

string

云电脑名称。

testName

ConnectionStatus

string

连接状态。

枚举值:

  • 0 :

    未连接

  • 1 :

    连接中

1

DesktopId

string

云电脑 ID。

ecd-gx2x1dhsmucyy****

EndUserType

string

用户账号体系类型。

枚举值:

  • SIMPLE :

    便捷账号

  • AD_CONNECTOR :

    企业 AD 账号

SIMPLE

EndUserPhone

string

授权用户的手机号。

1381111****

EndUserName

string

授权用户的用户名。

alice

ExternalInfo

object

附加信息。

ExternalName

string

外部名称。

nameDemo

JobNumber

string

工号。

123

UserSetPropertiesModels

array<object>

用户座位信息列表。

array<object>

用户座位信息。

UserId

integer

用户 ID。

123

UserName

string

用户名称。

nameDemo

PropertyId

integer

属性 ID。

123

PropertyKey

string

属性名称。

key

PropertyType

integer

属性类型。

枚举值:

  • 1 :

    系统属性

  • 2 :

    用户自定义属性

1

PropertyValues

array<object>

属性值数组。

object

属性值对象。

PropertyValueId

integer

属性值 ID。

123

PropertyValue

string

属性值。

value

UserDesktopId

string

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

ud-i896ze8hazpvl****

EndUserRemark

string

用户备注。

Note

DisplayName

string

企业 AD 账号的显示名称。

alice

UserPrincipalName

string

用户主体名称(UPN)。

alice@example.com

DisplayNameNew

string

用户的新显示名称。

张三

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "UsersCount": 1,
  "OnlineUsersCount": 0,
  "UserOuPath": "example.com",
  "UserGroupName": "研发组",
  "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": "alice@example.com",
      "DisplayNameNew": "张三"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情