文档

ListUsers - 获取用户列表

更新时间:

获取用户列表。服务地址(Region)请选择为杭州(cn-hangzhou)。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JsonStrstring

完整 JSON 字符串信息,具体内容参见以下详细信息。

{"pageNumber":1,"pageSize":10}
BaseMeAgentIdlong

业务空间 Id

入参说明

属性值类型是否必须说明
userNameString登录名。
displayNameString显示名。
roleIdInteger角色 ID。
pageSizeLong每页大小。
pageNumberString页数。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

106C6CA0-282D-4AF7-85F0-D2D24F4CE647
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。

true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful。

successful
PageNumberinteger

当前页数。

1
PageSizeinteger

每页显示条数。

10
Countinteger

总条数。

12
Dataobject []

详细返回数据。

DisplayNamestring

显示名。

xxx
UpdateTimestring

最后更新时间。

2020-03-11T16:54Z
Descriptionstring

备注。

XXX
CreateTimestring

创建时间。

2020-03-11T16:54Z
LoginUserTypeinteger

账号类型,可能值:1 主账号;2 子账号。

2
AliUidstring

用户 ID。

2951869706989****
RoleNamestring

角色,可能值:ADMIN 管理员;QUALITY_INSPECTOR 质检员;AGENT 客服。

AGENT
UserNamestring

登录名。

xxx
Idlong

弃用字段,请忽略。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "106C6CA0-282D-4AF7-85F0-D2D24F4CE647",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "Count": 12,
  "Data": {
    "User": [
      {
        "DisplayName": "xxx",
        "UpdateTime": "2020-03-11T16:54Z",
        "Description": "XXX",
        "CreateTime": "2020-03-11T16:54Z",
        "LoginUserType": 2,
        "AliUid": "2951869706989****",
        "RoleName": "AGENT",
        "UserName": "xxx",
        "Id": 1
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈