如果您使用AD目录来对接企业自有AD，调用该接口可以获取企业AD中的用户信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:ListDirectoryUsers | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| Filter | string | 否 | 模糊查询字符串。包含该字符串的结果都将被匹配出来。 | alice |
| DirectoryId | string | 是 | AD 目录 ID。 | cn-hangzhou+dir-jedbpr4sl9l37**** |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
| OUPath | string | 否 | 指定用户所属的 AD 域组织单元（OU）。可通过 ListUserAdOrganizationUnits 接口获取。 | example.com/Domain Controllers |
| AssignedInfo | string | 否 | 说明
该字段未开放使用。只能传入 1或者不传入任何值。
| 1 |
| SortType | string | 否 | 排序方法。 枚举值：
| asc |
| IncludeAssignedUser | boolean | 否 | 是否只返回分配云电脑的用户。 | true |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Users": [
{
"EndUser": "Alice",
"DisplayName": "Alice",
"AssignedDesktopNumber": 2,
"Email": "user@example.com",
"Phone": "130********",
"DisplayNameNew": "",
"UserPrincipalName": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-06 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |