使用ListOfficeSiteUsers查询AD办公网络对接的AD账号信息-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

查询AD办公网络（原工作区）对接AD域后获取的AD账号信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ListOfficeSiteUsers

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
Filter	string	否	模糊查询字符串。	jin
OfficeSiteId	string	是	办公网络 ID。仅支持基于企业 AD 账号的办公网络。	cn-hangzhou+dir-363353****
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
OUPath	string	否	指定的 AD 域组织单元。	example.com/Domain Controllers
AssignedInfo	string	否	说明该字段未开放使用。只能传入`1`或者不传入任何值。	1
SortType	string	否	排序方法。	asc
IncludeAssignedUser	boolean	否	是否只返回分配云电脑的用户。

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	269BDB16-2CD8-4865-84BD-11C40BC21DB0
Users	array<object>	AD 账号用户名组成的数组。如果企业 AD 中的用户只有 Administrator 和 Guest，没有其他用户，则将返回空的 Users 数组。
	object	AD 账号的用户名。
EndUser	string	AD 账号的用户名。	aduser
DisplayName	string	AD 账号的显示名称。	aduser
AssignedDesktopNumber	integer	分配的云电脑数量。	2
Email	string	邮箱。	user@example.com
Phone	string	手机号码。	130********
UserPrincipalName	string	用户主体名称（UPN）。	alice@example.com
DisplayNameNew	string	用户的新显示名称。	张三

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "Users": [
    {
      "EndUser": "aduser",
      "DisplayName": "aduser",
      "AssignedDesktopNumber": 2,
      "Email": "user@example.com",
      "Phone": "130********",
      "UserPrincipalName": "alice@example.com",
      "DisplayNameNew": "张三"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。