调用ListUsers获取用户列表。服务地址(Region)请选择为杭州(cn-hangzhou)。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListUsers |
系统规定参数。取值：ListUsers。 |
| JsonStr | String | 是 | {"pageNumber":1,"pageSize":10} |
完整Json字符串信息，具体内容参见以下详细信息。 |
入参说明
|
属性 |
值类型 |
是否必须 |
说明 |
|---|---|---|---|
|
userName |
String |
否 |
登录名。 |
|
displayName |
String |
否 |
显示名。 |
|
roleId |
Integer |
否 |
角色ID。 |
|
pageSize |
Long |
是 |
每页大小。 |
|
pageNumber |
String |
是 |
页数。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | 200 |
结果代码，200 表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。 |
| Count | Integer | 12 |
总条数。 |
| Data | Array of User |
详细返回数据。 |
|
| User | |||
| AliUid | String | 2951869706989**** |
用户ID。 |
| CreateTime | String | 2020-03-11T16:54Z |
创建时间。 |
| Description | String | XXX |
备注。 |
| DisplayName | String | xxx |
显示名。 |
| Id | Long | 1 |
弃用字段，请忽略。 |
| LoginUserType | Integer | 2 |
账号类型，可能值：1(主账号)；2(子账号)。 |
| RoleName | String | AGENT |
角色，可能值：ADMIN(管理员)；QUALITY_INSPECTOR(质检员)；AGENT(客服)。 |
| UpdateTime | String | 2020-03-11T16:54Z |
最后更新时间。 |
| UserName | String | xxx |
登录名。 |
| Message | String | successful |
出错时表示出错详情，成功时为successful。 |
| PageNumber | Integer | 1 |
当前页数。 |
| PageSize | Integer | 10 |
每页显示条数。 |
| RequestId | String | 106C6CA0-282D-4AF7-85F0-D2D24F4CE647 |
请求id。 |
| Success | Boolean | true |
请求是否成功，调用方可根据此字段来判断请求是否成功：true表示成功；false/null表示失败。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListUsers
&<公共请求参数>正常返回示例
XML格式
<ListUsersResponse>
<Message>successful</Message>
<PageSize>2</PageSize>
<RequestId>7372059E-C5D1-442D-AFB4-86F0A4D751C2</RequestId>
<PageNumber>1</PageNumber>
<Data>
<User>
<RoleName>QUALITY_INSPECTOR</RoleName>
<UserName>pursuing</UserName>
<Description></Description>
<CreateTime>2020-03-11T16:54Z</CreateTime>
<DisplayName>pursuing</DisplayName>
<UpdateTime>2020-03-11T16:54Z</UpdateTime>
<Id>2777</Id>
<LoginUserType>2</LoginUserType>
<AliUid>2951869706989***</AliUid>
</User>
<User>
<RoleName>QUALITY_INSPECTOR</RoleName>
<UserName>0917reviewer</UserName>
<Description></Description>
<CreateTime>2020-01-08T21:22Z</CreateTime>
<DisplayName>0917质检员</DisplayName>
<UpdateTime>2020-01-08T21:22Z</UpdateTime>
<Id>957</Id>
<LoginUserType>2</LoginUserType>
<AliUid>25574616870489****</AliUid>
</User>
</Data>
<Count>7</Count>
<Code>200</Code>
<Success>true</Success>
</ListUsersResponse>JSON格式
{
"Message":"successful",
"PageSize":2,
"RequestId":"7372059E-C5D1-442D-AFB4-86F0A4D751C2",
"PageNumber":1,
"Data":{
"User":[
{
"RoleName":"QUALITY_INSPECTOR",
"UserName":"pursuing",
"Description":"",
"CreateTime":"2020-03-11T16:54Z",
"DisplayName":"pursuing",
"UpdateTime":"2020-03-11T16:54Z",
"Id":2777,
"LoginUserType":2,
"AliUid":"2951869706989***"
},
{
"RoleName":"QUALITY_INSPECTOR",
"UserName":"0917reviewer",
"Description":"",
"CreateTime":"2020-01-08T21:22Z",
"DisplayName":"0917质检员",
"UpdateTime":"2020-01-08T21:22Z",
"Id":957,
"LoginUserType":2,
"AliUid":"2557461687048***"
}
]
},
"Count":7,
"Code":"200",
"Success":true
}错误码
访问错误中心查看更多错误码。
