用户列表。

调试

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

请求语法

POST /user/list HTTP/1.1
Content-Type:application/json

{
  "username" : "String",
  "phone" : "String",
  "ramId" : "String",
  "scene" : Long,
  "clientToken" : "String",
  "pageNumber" : Long,
  "pageSize" : Long,
  "synergyChannel" : "String"
}

请求参数

表 1. 请求Body参数
参数名称 类型 是否必选 示例 说明
username String 否 张三

人员名称
phone String 否 1887879****

人员手机号
ramId String 否 1344383

Ram账号ID
scene Long 否 USER_LIST

下拉场景 ALL_USERS 用户列表场景USER_LIST
clientToken String 否 c26f36de-1ec8-496a-a828-880676c5ef81

clientToken
pageNumber Long 否 1

分页参数
pageSize Long 否 10

分页参数
synergyChannel String 否 DINGDING

移动应用渠道

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "String",
  "data" : [ {
    "userId" : Long,
    "ramId" : Long,
    "username" : "String",
    "phone" : "String",
    "email" : "String",
    "isEditableUser" : Long,
    "accountType" : Long,
    "appAccount" : "String",
    "synergyChannel" : "String",
    "isRelated" : "String"
  } ],
  "totalCount" : Long,
  "pageNumber" : Long,
  "pageSize" : Long
}

响应参数

表 2. 响应Body参数
参数名称 类型 示例 说明
requestId String c26f36de-1ec8-496a-a828-880676c5ef81

id of the request
data Array of data

data
userId Long 1234

用户id
ramId Long 53624523

子账号ramId
username String 张珊

用户名
phone String 1390000****

手机
email String 2345****@qq.com

邮箱
isEditableUser Long true

是否可编辑
accountType Long SUB

账户类型
appAccount String 23456tre

移动应用账户
synergyChannel String DINGDING

移动应用协同渠道
isRelated String RELATED关联 NOT_RELATED 未关联

是否关联
totalCount Long 100

总条数
pageNumber Long 1

分页
pageSize Long 10

分页

示例1

POST /user/list HTTP/1.1
Host:gemp.cn-shanghai.aliyuncs.com
Content-Type:application/json

{
  "username" : "张三",
  "phone" : "1887879****",
  "ramId" : "1344383",
  "clientToken" : "c26f36de-1ec8-496a-a828-880676c5ef81",
  "pageNumber" : 1,
  "pageSize" : 10,
  "synergyChannel" : "DINGDING"
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListUsersResponse>
    <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>
    <data>
        <userId>1234</userId>
        <ramId>53624523</ramId>
        <username>张珊</username>
        <phone>1390000****</phone>
        <email>2345****@qq.com</email>
        <appAccount>23456tre</appAccount>
        <synergyChannel>DINGDING</synergyChannel>
        <isRelated>RELATED关联  NOT_RELATED 未关联</isRelated>
    </data>
    <totalCount>100</totalCount>
    <pageNumber>1</pageNumber>
    <pageSize>10</pageSize>
</ListUsersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "c26f36de-1ec8-496a-a828-880676c5ef81",
  "data" : [ {
    "userId" : 1234,
    "ramId" : 53624523,
    "username" : "张珊",
    "phone" : "1390000****",
    "email" : "2345****@qq.com",
    "appAccount" : "23456tre",
    "synergyChannel" : "DINGDING",
    "isRelated" : "RELATED关联  NOT_RELATED 未关联"
  } ],
  "totalCount" : 100,
  "pageNumber" : 1,
  "pageSize" : 10
}

错误码

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

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK，帮助您快速通过API集成阿里云的产品和服务，推荐您使用SDK调用API，已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索，可视化调试API，在线命令行工具，同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具，可通过命令方式同时管理多个阿里云产品和服务，简单快捷，是您上云好帮手。