按用戶屬性篩選查詢便捷賬號信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecd:FilterUsers | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | long | 否 | 分頁查詢時每頁行數（大于 100 時會自動重置為 100）。 | 10 |
| NextToken | string | 否 | 下一次查詢的 Token。首次調用接口時無需設置該參數。如果一次查詢結果并沒有完整返回所有的結果，則返回的 NextToken 不為空。您可以在查詢中上傳返回的 NextToken 繼續查詢。 | caeba0bbb2be03f84eb48b699f0a**** |
| Filter | string | 否 | 模糊搜索字符串，支持匹配用戶名（EndUserId）和郵箱（Email）。該字段支持使用通配符（*），例如將該字段設為 a*m，則返回用戶名或郵箱以 a 開頭、以 m 結尾的所有結果。 | a*m |
| PropertyFilterParam | array<object> | 否 | 要模糊查詢的用戶屬性列表。 | |
| object | 否 | 要模糊查詢的用戶屬性。 | ||
| PropertyId | long | 否 | 屬性 ID。 | 328 |
| PropertyValueIds | string | 否 | 屬性值 ID。 | 1255 |
| PropertyKeyValueFilterParam | array<object> | 否 | 屬性名和屬性值信息列表。 | |
| object | 否 | 屬性名和屬性值信息。 | ||
| PropertyKey | string | 否 | 屬性名。 | job |
| PropertyValues | string | 否 | 屬性值。 | dev |
| IncludeDesktopCount | boolean | 否 | 是否返回已分配給該用戶的云電腦數量。 枚舉值：
| true |
| IncludeDesktopGroupCount | boolean | 否 | 是否返回已分配給該用戶的云電腦池數量。 枚舉值：
| false |
| OrgId | string | 否 | 企業組織 ID。 | org-aliyun-wy-org-id |
| OwnerType | string | 否 | 賬號激活類型。 枚舉值：
| Normal |
| ExcludeEndUserIds | array | 否 | 需精確排除的用戶名（EndUserId）列表。 | |
| string | 否 | 按用戶名（EndUserId）精確排除，查詢不包含該用戶名的用戶列表。 | tony | |
| OrderParam | object | 否 | 支持的排序參數。 | |
| OrderField | string | 否 | 按此參數排序。 枚舉值：
| id |
| OrderType | string | 否 | 升序或降序。 枚舉值：
| DESC |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"Users": [
{
"Id": 0,
"EndUserId": "alice",
"Email": "username@example.com",
"Phone": "1381111****",
"Status": 0,
"UserSetPropertiesModels": [
{
"UserId": 0,
"UserName": "alice",
"PropertyId": 12,
"PropertyKey": "department",
"PropertyType": 2,
"PropertyValues": [
{
"PropertyValueId": 42,
"PropertyValue": "dev"
}
]
}
],
"DesktopCount": 1,
"ExternalInfo": {
"ExternalName": "account",
"JobNumber": "030801"
},
"DesktopGroupCount": 2,
"OwnerType": "Normal",
"Remark": "測試專用",
"IsTenantManager": true,
"EnableAdminAccess": true,
"RealNickName": "小明",
"AutoLockTime": "2023-03-03",
"PasswordExpireDays": 30,
"PasswordExpireRestDays": 10
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-15 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-04-09 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-10-25 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-08-10 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-08-10 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-08-10 | OpenAPI 入參發生變更 | 查看變更詳情 |