API 中心

数字工厂底座

地市云

查询可授权用户列表

最近更新时间：11/9/2023, 4:17:00 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名：http://instance-console-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeUser

接口是否需要携带Token：是

本接口用于查询可授权用户列表。

输入参数

无

输出参数

Response

参数名称 类型 描述
Action String openapi公共参数，本接口取值：DescribeUser
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId
Data Data 返回数据

Data

参数名称 类型 描述
GroupTotal Integer 组总数
UserTotal Integer 用户总数
GroupList GroupList 组列表
UserList UserList 用户列表

UserList

参数名称 类型 描述
UserId String 用户id
Name String 用户名
IsAdmin bool 是否管理员
Mobile String 用户手机号码
Email String 用户邮箱

GroupList

参数名称 类型 描述
GroupId String 组ID
Name String 组名

示例

示例1 请求例子

输入示例

无

输出示例

{
  "Response": {
    "RequestId": "string",
    "Data": {
      "GroupList": [
        {
          "GroupId": "string",
          "Name": "string"
        }
      ],
      "GroupTotal": 3,
      "UserList": [
        {
          "UserId": "string",
          "Name": "string",
          "IsAdmin": true,
          "Mobile": "string",
          "Email": "string"
        }
      ],
      "UserTotal": 3
    }
  }
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述