如果您使用AD目錄來對接企業自有AD，調用該介面可以擷取企業AD中的使用者資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
| SortType |
string |
否 |
排序方法。 枚舉值：
|
asc |
| IncludeAssignedUser |
boolean |
否 |
是否只返回分配雲電腦的使用者。 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回對象。 |
||
| NextToken |
string |
下一個查詢開始的 Token，NextToken 為空白表示沒有下一個。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| RequestId |
string |
請求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| Users |
array<object> |
AD 目錄對應的使用者名稱稱組成的數組。如果 AD 目錄對應的使用者只有 Administrator 和 Guest，而沒有其他使用者，將返回空的 Users 數組。 |
|
|
object |
AD 目錄對應的使用者名稱稱對象。 |
||
| EndUser |
string |
使用者名稱稱。 |
Alice |
| DisplayName |
string |
顯示名稱。 |
Alice |
| AssignedDesktopNumber |
integer |
分配的雲電腦數量。 |
2 |
|
string |
郵箱。 |
user@example.com |
|
| Phone |
string |
手機號碼。 |
130******** |
| DisplayNameNew |
string |
||
| UserPrincipalName |
string |
樣本
正常返回樣本
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Users": [
{
"EndUser": "Alice",
"DisplayName": "Alice",
"AssignedDesktopNumber": 2,
"Email": "user@example.com",
"Phone": "130********",
"DisplayNameNew": "",
"UserPrincipalName": ""
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。