QueryWorkspaceUserList接口用于获取指定工作空间下的成员列表信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryWorkspaceUserList

要执行的操作。取值:QueryWorkspaceUserList。

WorkspaceId String 95296e95-ca89-4c7d-8af9-dedf0ad0****

工作空间ID。

Keyword String 分析

工作空间成员用户名的关键字。

PageNum Integer 1

工作空间成员列表的当前页码:

  • 起始值:1
  • 默认值:1
PageSize Integer 10

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Struct

返回成员列表的分页结果,成员的详细信息列表存放在返回参数Data中。

Data Array of Data

空间成员信息。

AccountId String 16020915****8429

阿里云账号ID。

AccountName String pop****@aliyunid.test

阿里云账号名称。

NickName String 我就是那个分析师大神

昵称。

Role Struct

空间成员的角色信息。

RoleCode String role_workspace_admin

空间成员角色对应的编码。

RoleId Long 25

空间成员角色的ID。

  • 25:管理员
  • 26:开发者
  • 27:分析者
  • 30:阅览者
RoleName String 管理员

空间成员角色的名称。

UserId String de4bc5f9429141cc8091cdd1c15b****

Quick BI用户ID。

PageNum Integer 1

页码。

PageSize Integer 10

请求接口时设置的每页行数。

TotalNum Integer 1

总行数。

TotalPages Integer 1

总页数。

Success Boolean true

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryWorkspaceUserList
&WorkspaceId=95296e95-ca89-4c7d-8af9-dedf0ad0****
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <TotalNum>1</TotalNum>
    <PageNum>1</PageNum>
    <PageSize>10</PageSize>
    <TotalPages>1</TotalPages>
    <Data>
        <AccountId>16020915****8429</AccountId>
        <NickName>我就是那个分析师大神</NickName>
        <UserId>de4bc5f9429141cc8091cdd1c15b****</UserId>
        <AccountName>pop****@aliyunid.test</AccountName>
    </Data>
    <Data>
        <Role>
            <RoleName>管理员</RoleName>
            <RoleCode>role_workspace_admin</RoleCode>
            <RoleId>25</RoleId>
        </Role>
    </Data>
</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"TotalNum":"1","PageNum":"1","PageSize":"10","TotalPages":"1","Data":[{"AccountId":"16020915****8429","NickName":"我就是那个分析师大神","UserId":"de4bc5f9429141cc8091cdd1c15b****","AccountName":"pop****@aliyunid.test"},{"Role":{"RoleName":"管理员","RoleCode":"role_workspace_admin","RoleId":"25"}}]}}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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