文档中心 > ListUsers
ListUsers

最近更新时间:2021-08-27

接口名

ListUsers

描述

查看用户的全部IAM子账号信息

请求参数

名称数据类型示例描述是否必填
ActionStringListUsers系统规定参数,取值:ListUsersY

name

StringtestUser用户名(支持模糊查询)N
fullNameStringtestUser显示名(支持模糊查询)
N
keywordStringtestUser子用户名或显示名(支持模糊查询)
N
phoneString1868888****手机号(支持模糊查询)N

email

Stringalice@example.com子账号的电子邮箱(支持模糊查询)N
pageInteger1页码,从第一页开始N
sizeInteger1每页数量(取值范围:1-200)N

返回参数

名称数据类型示例说明
PageInteger1页码
size
Integer10每页数量
totalCountInteger10总数量
totalPages
Integer1总页数
listArray


子账号信息集合

list详情:

名称数据类型示例说明
id
String48b1cb3a-8c31-46a7-aa31-***子账号id
nameStringtestUser用户名,子账号的登录名称
fullName
String测试用户显示名
phoneString1868888****手机号
email
Stringalice@example.com子账号的电子邮箱
parentIdStringd3fbd550-f4ba-4edf-a5f8-********主账号id
enabled
Integer0子账号可否登录控制台
childEnabledInteger1子账号启用/禁用状态


请求示例


  http://api.unicloud.com/user/user?Action=ListUsers&page=1&size=8


正常返回示例

    {

      "page": 1,

      "size": 8,

      "totalCount": 1,

      "totalPages": 1,

      "list": [

        {

          "id": "48b1cb3a-8c31-46a7-aa31-***********",

          "name": "testUser",

          "fullName": null,

          "phone": null,

          "email": null,

          "enabled": 0,

          "parentId": "d3fbd550-f4ba-4edf-a5f8-********"

           "childEnabled": 1

        }

      ]

    }

错误码

错误码错误信息状态码错误描述
OverMaxPageSizeMax available page size is 200, please check your param.400页面最多展示200条数据
OverMinPageSizeMin available page size is 1, please check your param.400页面展示数量的取值最小为1
InvalidParameterPageError400页码取值错误