Queries the organizational units (OUs) of an Active Directory (AD) domain connected to an enterprise AD office network (formerly workspace).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. You can call the DescribeRegions operation to query the most recent region list. |
cn-hangzhou |
| OfficeSiteId |
string |
Yes |
The enterprise AD office network ID. |
cn-hangzhou+dir-485361**** |
| Filter |
string |
No |
The string for fuzzy search. |
develop |
| NextToken |
string |
No |
The pagination token for retrieving the next page of results. You do not need to specify this parameter for the first request or if no next request exists. Set this to the NextToken value returned by the previous call. |
caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults |
integer |
No |
The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 500. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| OUNames |
array<object> |
The OUs of the AD domain. |
|
|
object |
The name of the OU in the AD domain. |
||
| OfficeSiteId |
string |
The enterprise AD office network ID. |
cn-hangzhou+dir-485361**** |
| OUName |
string |
The canonical name (CNAME) of the OU in the AD domain controller. |
example.com/wuying_computers |
| DisplayOUName |
string |
The name of the OU. |
wuying_computers |
| NextToken |
string |
A pagination token. |
caeba0bbb2be03f84eb48b699f0a4883 |
Examples
Success response
JSON format
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"OUNames": [
{
"OfficeSiteId": "cn-hangzhou+dir-485361****",
"OUName": "example.com/wuying_computers",
"DisplayOUName": "wuying_computers"
}
],
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.