QueryOrganizationWorkspaceList接口用于获取当前组织下的工作空间列表信息。

请求参数

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

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

Keyword String 程序

空间名称的关键字。

PageNum Integer 1

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

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

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000
UserId String fe67f61a35a94b7da1a34ba174a7****

用户在Quick BI的ID。

返回数据

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

请求ID。

Result Struct

返回工作空间列表的分页结果,工作空间的详细信息列表存放在返回参数Data中。

Data Array of Data

工作空间列表。

AllowPublishOperation Boolean true

作品是否可公开。取值范围:

  • true:公开
  • false:不公开
AllowShareOperation Boolean true

作品是否可授权分享。取值范围:

  • true:授权
  • false:不授权
CreateTime String 2020-11-10 17:51:07

工作空间创建时间。

CreateUser String de4bc5f9429141cc8091cdd1c15b****

创建者的Quick BI用户ID。

CreateUserAccountName String pop****@aliyun.com

创建者的阿里云账号名称。

ModifiedTime String 2020-11-10 17:51:07

工作空间最新修改时间。

ModifyUser String de4bc5f9429141cc8091cdd1c15b****

修改者的Quick BI用户ID。

ModifyUserAccountName String pop****@aliyun.com

修改者的阿里云账号名。

OrganizationId String 2fe4fbd8-588f-489a-b3e1-e92c7af0****

工作空间的所属组织ID。

Owner String de4bc5f9429141cc8091cdd1c15b****

工作空间所有者的Quick BI用户ID。

OwnerAccountName String pop****@aliyun.com

工作空间所有者阿里云账号名称。

WorkspaceDescription String 测试备注

工作空间备注。

WorkspaceId String 7350a155-0e94-4c6c-8620-57bbec38****

工作空间ID。

WorkspaceName String 测试空间

工作空间名称。

PageNum Integer 1

页码。

PageSize Integer 10

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

TotalNum Integer 1

总行数。

TotalPages Integer 1

总页数。

Success Boolean true

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

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

示例

请求示例

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

正常返回示例

XML格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <TotalNum>1</TotalNum>
    <PageSize>10</PageSize>
    <PageNum>1</PageNum>
    <TotalPages>1</TotalPages>
    <Data>
        <WorkspaceDescription>测试备足</WorkspaceDescription>
        <Owner>1365162623238860</Owner>
        <ModifyUser>1365162623238860</ModifyUser>
        <CreateTime>2020-11-10 17:51:07</CreateTime>
        <OwnerAccountName>poptest@aliyun.com</OwnerAccountName>
        <WorkspaceId>7350a155-0e94-4c6c-8620-57bbec38****</WorkspaceId>
        <CreateUser>1365162623238860</CreateUser>
        <OrganizationId>2fe4fbd8-588f-489a-b3e1-e92c7af0****</OrganizationId>
        <ModifyUserAccountName>poptest@aliyun.com</ModifyUserAccountName>
        <ModifiedTime>2020-11-10 17:51:07</ModifiedTime>
        <AllowShareOperation>true</AllowShareOperation>
        <WorkspaceName>测试空间</WorkspaceName>
        <AllowPublishOperation>true</AllowPublishOperation>
        <CreateUserAccountName>poptest@aliyun.com</CreateUserAccountName>
    </Data>
</Result>

JSON格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"TotalNum":"1","PageSize":"10","PageNum":"1","TotalPages":"1","Data":[{"WorkspaceDescription":"测试备足","Owner":"1365162623238860","ModifyUser":"1365162623238860","CreateTime":"2020-11-10 17:51:07","OwnerAccountName":"poptest@aliyun.com","WorkspaceId":"7350a155-0e94-4c6c-8620-57bbec38****","CreateUser":"1365162623238860","OrganizationId":"2fe4fbd8-588f-489a-b3e1-e92c7af0****","ModifyUserAccountName":"poptest@aliyun.com","ModifiedTime":"2020-11-10 17:51:07","AllowShareOperation":"true","WorkspaceName":"测试空间","AllowPublishOperation":"true","CreateUserAccountName":"poptest@aliyun.com"}]}}

错误码

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 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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