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

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Keywordstring

空间名称的关键字。

程序
PageNuminteger

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

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

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

用户在 Quick BI 的 ID。

fe67f61a35a94b7da1a34ba174a7****

返回参数

名称类型描述示例值
object
Successboolean

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

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

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

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

TotalPagesinteger

总页数。

1
PageNuminteger

页码。

1
PageSizeinteger

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

10
TotalNuminteger

总行数。

1
Dataarray<object>

工作空间列表。

Dataobject
CreateUserAccountNamestring

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

pop****@aliyun.com
Ownerstring

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

de4bc5f9429141cc8091cdd1c15b****
CreateTimestring

工作空间创建时间。

2020-11-10 17:51:07
WorkspaceNamestring

工作空间名称。

测试空间
OrganizationIdstring

工作空间的所属组织 ID。

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

工作空间 ID。

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

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

  • true:授权
  • false:不授权
true
CreateUserstring

创建者的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****
ModifiedTimestring

工作空间最新修改时间。

2020-11-10 17:51:07
WorkspaceDescriptionstring

工作空间备注。

该空间是测试空间
ModifyUserstring

修改者的 Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****
AllowPublishOperationboolean

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

  • true:公开
  • false:不公开
true
OwnerAccountNamestring

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

pop****@aliyun.com
ModifyUserAccountNamestring

修改者的阿里云账号名。

pop****@aliyun.com

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.User.OrganizationThe user is not in your organization.该用户不在您的组织中。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。

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