查询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 | 否 | 分页查询时每页行数。
| 10 |
| OUPath | string | 否 | 指定的 AD 域组织单元。 | example.com/Domain Controllers |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
"Users": [
{
"EndUser": "aduser",
"DisplayName": "aduser",
"AssignedDesktopNumber": 0,
"Email": "",
"Phone": "",
"UserPrincipalName": "",
"DisplayNameNew": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-04-09 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |