QueryUserList接口用于获取组织成员列表信息。

请求参数

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

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

Keyword String 测试pop用户

组织成员用户名或昵称的关键字。

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 135562959848

阿里云账号ID。

AccountName String 测试pop添加用户01

阿里云账号名称。

AdminUser Boolean true

是否是管理员。取值范围:

  • true:是
  • false:否
AuthAdminUser Boolean true

是否是权限管理员。取值范围:

  • true:是
  • false:否
NickName String 测试pop添加用户01

组织成员的昵称。

UserId String fe67f61a35a94b7da1a34ba174a7****

Quick BI中的UserID。

UserType Integer 1

组织成员的角色类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
PageNum Integer 1

页码。

PageSize Integer 10

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

TotalNum Integer 1

总行数。

TotalPages Integer 1

总页数。

Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryUserList
&<公共请求参数>

正常返回示例

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>135562959848</AccountId>
        <UserId>fe67f61a35a94b7da1a34ba174a7****</UserId>
        <AdminUser>true</AdminUser>
        <NickName>测试pop添加用户01</NickName>
        <UserType>1</UserType>
        <AuthAdminUser>true</AuthAdminUser>
        <AccountName>测试pop添加用户01</AccountName>
    </Data>
</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"TotalNum":"1","PageNum":"1","PageSize":"10","TotalPages":"1","Data":[{"AccountId":"135562959848","UserId":"fe67f61a35a94b7da1a34ba174a7****","AdminUser":"true","NickName":"测试pop添加用户01","UserType":"1","AuthAdminUser":"true","AccountName":"测试pop添加用户01"}]}}

错误码

HttpCode 错误码 错误信息 描述
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
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 Internal.System.Error An internal system error occurred. 系统内部异常。

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