调用ListUsers接口获取用户详情列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListUsers |
系统规定参数。取值:ListUsers。 |
Tid | Long | 是 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
Role | String | 否 | DBA |
角色,取值为参考RegisterUser接口。 |
UserState | String | 否 | NORMAL |
用户状态,取值和说明如下:
|
SearchKey | String | 否 | test |
搜索关键字。 |
PageNumber | Integer | 否 | 1 |
第几页。 |
PageSize | Integer | 否 | 50 |
每页记录数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
RequestId | String | 98D35416-2B92-4CE5-8FD2-B1E61E165536 |
API请求ID。 |
Success | Boolean | true |
请求是否成功。 |
TotalCount | Long | 1 |
满足条件的记录总数。 |
UserList | Array of User |
用户详情列表。 |
|
User | |||
CurExecuteCount | Long | 0 |
当天查询次数。 |
CurResultCount | Long | 0 |
当天查询行数。 |
LastLoginTime | String | 2020-02-02 00:00:00 |
最后登录时间。 |
MaxExecuteCount | Long | 1000 |
当天查询次数上限。 |
MaxResultCount | Long | 1000 |
当天查询行数上限。 |
Mobile | String | 188xxxxx |
钉钉号(手机号)。 |
NickName | String | test |
昵称。 |
ParentUid | Long | 143214352 |
父账号Uid。 |
RoleIdList | List | 1 |
角色ID列表。 |
RoleNameList | List | ADMIN |
角色列表。 |
State | String | NORMAL |
用户状态。 |
Uid | Long | 14324321533 |
用户阿里云Uid。 |
UserId | String | 1 |
用户ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListUsers
&Role=DBA
&Tid=-1
&UserState=NORMAL
&<公共请求参数>
正常返回示例
XML
格式
<UserList>
<User>
<RoleIdList>
<RoleIds>3</RoleIds>
<RoleIds>1</RoleIds>
</RoleIdList>
<State>NORMAL</State>
<RoleNameList>
<RoleNames>ADMIN</RoleNames>
<RoleNames>USER</RoleNames>
</RoleNameList>
<NickName>xxx</NickName>
<UserId>2</UserId>
<Uid>111</Uid>
</User>
<User>
<RoleIdList>
<RoleIds>1</RoleIds>
<RoleIds>3</RoleIds>
</RoleIdList>
<State>NORMAL</State>
<RoleNameList>
<RoleNames>USER</RoleNames>
<RoleNames>ADMIN</RoleNames>
</RoleNameList>
<NickName>xxx[子账号]</NickName>
<ParentUid>111</ParentUid>
<UserId>1</UserId>
<Uid>111</Uid>
</User>
</UserList>
<TotalCount>2</TotalCount>
<RequestId>2D346B20-BF4A-4C96-8295-DE8EB9BF5B90</RequestId>
<Success>true</Success>
JSON
格式
{
"UserList": {
"User": [
{
"RoleIdList": {
"RoleIds": [
3,
1
]
},
"State": "NORMAL",
"RoleNameList": {
"RoleNames": [
"ADMIN",
"USER"
]
},
"NickName": "xxx",
"UserId": 2,
"Uid": "111"
},
{
"RoleIdList": {
"RoleIds": [
1,
3
]
},
"State": "NORMAL",
"RoleNameList": {
"RoleNames": [
"USER",
"ADMIN"
]
},
"NickName": "xxx[子账号]",
"ParentUid": "111",
"UserId": 1,
"Uid": "111"
}
]
},
"TotalCount": 2,
"RequestId": "2D346B20-BF4A-4C96-8295-DE8EB9BF5B90",
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交