查询指定工作空间下的成员列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:QueryWorkspaceUserList |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
工作空间 ID。 |
95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| Keyword |
string |
否 |
工作空间成员用户名的关键字。 |
分析 |
| PageNum |
integer |
否 |
工作空间成员列表的当前页码:
|
1 |
| PageSize |
integer |
否 |
分页查询时的每页行数:
|
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Success |
boolean |
是否请求成功。取值范围:
|
true |
| RequestId |
string |
请求 ID。 |
D787E1A3-A93C-424A-B626-C2B05DF8D885 |
| Result |
object |
返回成员列表的分页结果,成员的详细信息列表存放在返回参数 Data 中。 |
|
| Data |
array<object> |
空间成员信息。 |
|
|
array<object> |
|||
| AccountId |
string |
阿里云账号 ID。 |
16020915****8429 |
| AccountName |
string |
阿里云账号名称。 |
pop****@aliyunid.test |
| NickName |
string |
昵称。 |
我就是那个分析师大神 |
| Role |
object |
空间成员的预置空间角色信息。 |
|
| RoleCode |
string |
预置角色对应的编码。 |
role_workspace_admin |
| RoleId |
integer |
预置角色 ID。取值范围:
|
25 |
| RoleName |
string |
预置角色的名称。 |
管理员 |
| UserId |
string |
Quick BI 用户 ID。 |
de4bc5f9429141cc8091cdd1c15b**** |
| PageNum |
integer |
页码。 |
1 |
| PageSize |
integer |
请求接口时设置的每页行数。 |
10 |
| TotalNum |
integer |
总行数。 |
1 |
| TotalPages |
integer |
总页数。 |
1 |
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"Data": [
{
"AccountId": "16020915****8429",
"AccountName": "pop****@aliyunid.test",
"NickName": "我就是那个分析师大神",
"Role": {
"RoleCode": "role_workspace_admin",
"RoleId": 25,
"RoleName": "管理员"
},
"UserId": "de4bc5f9429141cc8091cdd1c15b****"
}
],
"PageNum": 1,
"PageSize": 10,
"TotalNum": 1,
"TotalPages": 1
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | |
| 400 | Workspace.Not.Exist | The group workspace does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。