QueryOrganizationWorkspaceList - 获取组织下的工作空间列表

更新时间:
复制为 MD 格式

获取当前组织下的工作空间列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:QueryOrganizationWorkspaceList

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Keyword

string

空间名称的关键字。

程序

PageNum

integer

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

  • 起始值:1

  • 默认值:1

1

PageSize

integer

分页查询时的每页行数:

  • 默认值:10

  • 最大值:1000

10

UserId

string

用户在 Quick BI 的 ID。

fe67f61a35a94b7da1a34ba174a7****

返回参数

名称

类型

描述

示例值

object

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

RequestId

string

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

object

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

Data

array<object>

工作空间列表。

object

空间信息。

AllowPublishOperation

boolean

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

  • true:公开

  • false:不公开

true

AllowShareOperation

boolean

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

  • true:授权

  • false:不授权

true

CreateTime

string

工作空间创建时间。

2020-11-10 17:51:07

CreateUser

string

创建者的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****

CreateUserAccountName

string

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

pop****@aliyun.com

ModifiedTime

string

工作空间最新修改时间。

2020-11-10 17:51:07

ModifyUser

string

修改者的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****

ModifyUserAccountName

string

修改者的阿里云账号名。

pop****@aliyun.com

OrganizationId

string

工作空间的所属组织 ID。

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

Owner

string

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

de4bc5f9429141cc8091cdd1c15b****

OwnerAccountName

string

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

pop****@aliyun.com

WorkspaceDescription

string

工作空间备注。

该空间是测试空间

WorkspaceId

string

工作空间 ID。

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

WorkspaceName

string

工作空间名称。

测试空间

RealOwnerAccountName

string

工作空间所有者的 Quick BI 账户名称。

test

PageNum

integer

页码。

1

PageSize

integer

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

10

TotalNum

integer

总行数。

1

TotalPages

integer

总页数。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。

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

变更历史

更多信息,参考变更详情