跳到主要内容

user_list 用户列表

POST /api/v1/users/user_list​

描述​

获取用户列表接口，用于获取用户列表信息, 查询条件为用户角色。 根据用户角色查询用户列表，如果角色为All，则查询所有用户列表，如果角色为Root，则查询所有Root用户列表，如果角色为Admin，则查询所有Admin用户列表，如果角色为Guest，则查询所有Guest用户列表。

由于是设备管理系统，所以用户总数控制在20y以内，不会有大量用户。不分页返回结果。

访问权限​

需要登录，具备以下权限：

users:user_list

JSON参数​

请求参数如下：

{
  "role": "All"|"Root"|"Admin"|"Guest",
}
提示
  • role: 用户角色，All表示查询所有用户列表，Root表示查询所有Root用户列表，Admin表示查询所有Admin用户列表，Guest表示查询所有Guest用户列表

请求示例：

{
  "role": "Root"
}

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: [
    {
      "username": "string",
      "role": "Root" | "Admin" | "Guest",
      "avatar": "string",
      "introduction": "string"
    },
    {
      "username": "string",
      "role": "Root" | "Admin" | "Guest",
      "avatar": "string",
      "introduction": "string"
    },
    ...
  ],
  "errorCode": "option string",
  "errorMessage": "option string",
  "showType": 0|1|2|4|9,
  "traceId": "option string"
}
提示
  • username: 用户名
  • role: 用户角色
  • avatar: 用户头像
  • introduction: 用户简介

由于系统限制用户总数为20个以内，所以 返回多个用户时候不分页，返回所有用户信息。

正确结果示例：

{
  "success": true,
  "data": [
    {
      "username": "wuhulala",
      "role": "Root",
      "avatar": "/images/avatar1.png",
      "introduction": "I am a super administrator"
    },
    {
      "username": "andyWang",
      "role": "Admin",
      "avatar": "/images/avatar2.png",
      "introduction": "I am an administrator"
    },
    {
      "username": "lucy",
      "role": "Guest",
      "avatar": "/images/avatar3.png",
      "introduction": "I am a guest"
    }
  ]
}

错误结果示例, 当role参数不在All, Root, Admin, Guest范围内时：

{
  "success": false,
  "errorCode": "40004",
  "errorMessage": "invalid.role",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
50000服务器错误server.error2
40006配置文件加载失败protocol.json.invalid0