获取用户列表。服务地址(Region)请选择为杭州(cn-hangzhou)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sca:ListUsers |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JsonStr |
string |
是 |
完整 JSON 字符串信息,具体内容参见以下详细信息。 |
{"pageNumber":1,"pageSize":10} |
| BaseMeAgentId |
integer |
否 |
业务空间 Id |
123456 |
入参说明
| 属性 | 值类型 | 是否必须 | 说明 |
| userName | String | 否 | 登录名。 |
| displayName | String | 否 | 显示名。 |
| roleId | Integer | 否 | 角色 ID。 |
| pageSize | Long | 是 | 每页大小。 |
| pageNumber | String | 是 | 页数。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
106C6CA0-282D-4AF7-85F0-D2D24F4CE647 |
| Success |
boolean |
请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。 |
true |
| Code |
string |
结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。 |
200 |
| Message |
string |
出错时表示出错详情,成功时为 successful。 |
successful |
| PageNumber |
integer |
当前页数。 |
1 |
| PageSize |
integer |
每页显示条数。 |
10 |
| Count |
integer |
总条数。 |
12 |
| Data |
object |
||
| User |
array<object> |
详细返回数据。 |
|
|
object |
|||
| DisplayName |
string |
显示名。 |
张三 |
| UpdateTime |
string |
最后更新时间。 |
2020-03-11T16:54Z |
| Description |
string |
备注。 |
上传数据专用账号 |
| CreateTime |
string |
创建时间。 |
2020-03-11T16:54Z |
| LoginUserType |
integer |
账号类型,可能值:1 主账号;2 子账号。 |
2 |
| AliUid |
string |
用户 ID。 |
2951869706989**** |
| RoleName |
string |
角色,可能值:ADMIN 管理员;QUALITY_INSPECTOR 质检员;AGENT 客服。 |
AGENT |
| UserName |
string |
登录名。 |
张三 |
| Id |
integer |
弃用字段,请忽略。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "106C6CA0-282D-4AF7-85F0-D2D24F4CE647",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"Count": 12,
"Data": {
"User": [
{
"DisplayName": "张三",
"UpdateTime": "2020-03-11T16:54Z",
"Description": "上传数据专用账号",
"CreateTime": "2020-03-11T16:54Z",
"LoginUserType": 2,
"AliUid": "2951869706989****",
"RoleName": "AGENT",
"UserName": "张三",
"Id": 1
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。