ListUsers - 获取用户列表

更新时间:
复制为 MD 格式

获取租户下的所有用户列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

odps:ListUsers

list

*全部资源

*

请求语法

GET /api/v1/users HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

pageNumber

integer

页码

1

pageSize

integer

每页返回数目

10

返回参数

名称

类型

描述

示例值

object

PopResult<ListResultDTO<UserAccount, DefaultPageInfo>>

requestId

string

请求 id

0a06dd4816687424611405643e3730

data

object

返回数据

users

array<object>

用户列表

object

用户列表

accountId

string

账号 ID

16783562****

accountName

string

账号名称

Bob@

displayName

string

显示名称

Bob

accountType

string

账号类型

ALIYUN

tenantId

string

租户 ID

1567253789

totalCount

integer

返回结果的总数量。

64

pageNumber

integer

当前页码。

2

pageSize

integer

每页显示条数。

10

示例

正常返回示例

JSON格式

{
  "requestId": "0a06dd4816687424611405643e3730",
  "data": {
    "users": [
      {
        "accountId": "16783562****",
        "accountName": "Bob@",
        "displayName": "Bob",
        "accountType": "ALIYUN",
        "tenantId": "1567253789"
      }
    ],
    "totalCount": 64,
    "pageNumber": 2,
    "pageSize": 10
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情