This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.
Retrieve the list of workspaces under the current organization.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| quickbi-public:QueryOrganizationWorkspaceList | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Keyword | string | No | Keyword for the workspace name. | test |
| PageNum | integer | No | Current page number of the workspace list:
| 1 |
| PageSize | integer | No | Number of rows per page in a paginated query:
| 10 |
| UserId | string | No | User ID in Quick BI. | fe67f61a35a94b7da1a34ba174a7**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "test",
"OrganizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
"WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
"AllowShareOperation": true,
"CreateUser": "de4bc5f9429141cc8091cdd1c15b****",
"ModifiedTime": "2020-11-10 17:51:07",
"WorkspaceDescription": "test",
"ModifyUser": "de4bc5f9429141cc8091cdd1c15b****",
"AllowPublishOperation": true,
"OwnerAccountName": "pop****@aliyun.com",
"ModifyUserAccountName": "pop****@aliyun.com"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Instance.Expired | Your instance has expired. | Your instance has expired. |
| 400 | Instance.Not.Exist | The specified instance does 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. | The specified organizational unit does not exist. |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | The specified user is not in the organizational unit. |
| 400 | Invalid.User.Organization | The user is not in your organization. | The user is not in your organization. |
| 400 | System.Param.Empty | You must specify the %s parameter. | You must specify the %s parameter. |
| 400 | Internal.System.Error | An internal system error occurred. | An internal system error occurred. |
For a list of error codes, visit the Service error codes.