ListAccelerationOfWorkspace-阿里云帮助中心

Retrieves acceleration engine task information from the management page of a workspace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ListAccelerationOfWorkspace

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
CubeName	string	No	The dataset name.	test
CreatorId	string	No	The user ID in Quick BI, not your Alibaba Cloud account ID. You can call the QueryUserInfoByAccount operation to obtain the user ID.	1***************139
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of rows per page for a paged query. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D787E****************05DF8D885
Result	object	The acceleration task information model.
TotalPages	integer	The total number of pages.	1
TotalNum	integer	The total number of rows.	18
PageNum	integer	The page number.	1
PageSize	integer	The number of rows per page specified in the request.	10
Pre	integer	The previous page number. A value of NULL or 0 indicates that there is no previous page.	0
Next	integer	The next page number. A value of NULL or 0 indicates that there is no next page.	null
Data	array<object>	The array of acceleration task information.
	object	The array of acceleration task information.
CubeId	string	The dataset ID.	d14e*********fef8de29fd
CubeName	string	The dataset name.	test
CreatorName	string	The name of the creator.	system
Size	string	The size.	47045632
LastModifyTime	string	The last modification time, in the format of YYYYMMDD HH:mm:ss.	20250911 00:00:00
EnableQuickindexTime	string	The time when acceleration was enabled, in the format of YYYYMMDD HH:mm:ss.	20250911 00:00:00
JobId	string	The acceleration task ID.	b30b74**********b3b
JobStatus	integer	The status. Valid values: 0: pending 1: running 2: completed 3: failed 4: canceled 5: warning	0
JobHistoryId	string	The task history ID.	QWDAASG*******8SAD
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D787E****************05DF8D885",
  "Result": {
    "TotalPages": 1,
    "TotalNum": 18,
    "PageNum": 1,
    "PageSize": 10,
    "Pre": 0,
    "Next": 0,
    "Data": [
      {
        "CubeId": "d14e*********fef8de29fd",
        "CubeName": "test",
        "CreatorName": "system",
        "Size": "47045632",
        "LastModifyTime": "20250911 00:00:00",
        "EnableQuickindexTime": "20250911 00:00:00",
        "JobId": "b30b74**********b3b",
        "JobStatus": 0,
        "JobHistoryId": "QWDAASG*******8SAD"
      }
    ]
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Invalid.Workspace	The workspace is not owned by the organization.	The workspace is not in the organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.