调用ListDirectoryUsers查询AD目录对应的用户信息_无影云电脑企业版(EDS)-阿里云帮助中心

如果您使用AD目录来对接企业自有AD，调用该接口可以获取企业AD中的用户信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
Filter	string	否	模糊查询字符串。包含该字符串的结果都将被匹配出来。	alice
DirectoryId	string	是	AD 目录 ID。	cn-hangzhou+dir-jedbpr4sl9l37****
NextToken	string	否	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
OUPath	string	否	指定用户所属的 AD 域组织单元（OU）。可通过 ListUserAdOrganizationUnits 接口获取。	example.com/Domain Controllers

返回参数

名称	类型	描述	示例值
	object	返回对象。
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Users	array<object>	AD 目录对应的用户名称组成的数组。如果 AD 目录对应的用户只有 Administrator 和 Guest，而没有其他用户，将返回空的 Users 数组。
User	object	AD 目录对应的用户名称对象。
EndUser	string	用户名称。	Alice
DisplayName	string	显示名称。	Alice

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Users": [
    {
      "EndUser": "Alice",
      "DisplayName": "Alice",
      "AssignedDesktopNumber": 0
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-06	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	OpenAPI 入参发生变更	查看变更详情
2021-08-19	OpenAPI 返回结构发生变更	查看变更详情