首页 无影云桌面 API参考(云桌面管控) API目录 目录 ListDirectoryUsers - 查询AD目录对应的用户信息

ListDirectoryUsers - 查询AD目录对应的用户信息

调用ListDirectoryUsers查询AD目录对应的用户信息。

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
Filterstring

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

alice
DirectoryIdstring

AD目录ID。

cn-hangzhou+dir-jedbpr4sl9l37****
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。

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

指定用户所属的AD域组织单元(OU)。可通过ListUserAdOrganizationUnits接口获取。

example.com/Domain Controllers

返回参数

名称类型描述示例值
object

返回对象。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

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

AD目录对应的用户名称组成的数组。如果AD目录对应的用户只有Administrator和Guest,没有其它用户,将返回空的Users数组。

object

AD目录对应的用户名称对象。

EndUserstring

用户名称。

Alice
DisplayNamestring

显示名称。

Alice

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2021-08-19OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OUPath
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈