获取当前组织下的工作空间列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| quickbi-public:QueryOrganizationWorkspaceList | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Keyword | string | 否 | 空间名称的关键字。 | 程序 |
| PageNum | integer | 否 | 工作空间列表的当前页码：
| 1 |
| PageSize | integer | 否 | 分页查询时的每页行数：
| 10 |
| UserId | string | 否 | 用户在 Quick BI 的 ID。 | fe67f61a35a94b7da1a34ba174a7**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Access.Forbidden | Access forbidden. Your instance version or access key is not allowed to call the API operation. | - |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
| 400 | Invalid.User.Organization | The user is not in your organization. | 该用户不在您的组织中。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
访问错误中心查看更多错误码。