查詢便捷賬號信息，例如用戶名、郵箱地址、備注名稱等。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecd:DescribeUsers | list | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | long | 否 | 分頁查詢時每頁行數。
| 10 |
| NextToken | string | 否 | 下一次查詢的 Token。首次調用接口時無需設置該參數。 | caeba0bbb2be03f84eb48b699f0a**** |
| Filter | string | 否 | 模糊搜索字符串，支持匹配用戶名（EndUserId）和郵箱（Email）。該字段支持使用通配符（*），例如將該字段設為 | a*m |
| EndUserIds | array | 否 | 需精確匹配的用戶名（EndUserId）列表。 | |
| string | 否 | 按用戶名（EndUserId）精確匹配，查詢用戶名一致的賬號信息。 | alice | |
| ExcludeEndUserIds | array | 否 | 需精確排除的用戶名（EndUserId）列表。 | |
| string | 否 | 按用戶名（EndUserId）精確排除，查詢不包含該用戶名的賬號列表。 | tony | |
| OrgId | string | 否 | 按組織 ID 精確匹配，查詢歸屬該組織的賬號列表。 | org-4mdgc1cocc59z**** |
| GroupId | string | 否 | 按用戶組 ID 精確匹配，查詢歸屬該用戶組的賬號列表。 | ug-12341234**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Users": [
{
"Id": 0,
"EndUserId": "alice",
"Email": "username@example.com",
"Phone": "1381111****",
"Status": 0,
"OwnerType": "Normal",
"Remark": "Test user.",
"OrgId": "org-4mdgc1cocc59z****",
"WyId": "41fd1254d8f7****",
"IsTenantManager": true,
"Groups": [
{
"GroupId": "ug-12341234****",
"GroupName": "用戶組1"
}
],
"Orgs": [
{
"OrgId": "org-4mdgc1cocc59z****",
"OrgName": "部門1"
}
],
"Avatar": "https://cdn.*****",
"Address": "杭州市***",
"NickName": "李**",
"RealNickName": "李**",
"JobNumber": "A10000**",
"Extras": {
"AssignedResourceCount": {
"key": ""
}
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-24 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-07-19 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-01-24 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-12-11 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-09-24 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-08-06 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-04-02 | 新增 OpenAPI | 查看變更詳情 |