Query dataset optimization suggestions - Quick BI - Alibaba Cloud - Quick BI

Retrieves optimization suggestions for a dataset.

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:QueryCubeOptimization

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	The query results.
	array<object>	The result of the API operation.
AdviceType	string	The type of the suggestion. Valid values: OPEN_CACHE: Enable caching. OPEN_QUICK_ENGINE: Enable FAST cache. INCREASE_CACHE_TIME: Increase cache duration.	OPENQUICKENGINE
CubePerformanceDiagnoseModel	object	The diagnostic information about the dataset.
CacheCostTimeAvg	number	The average duration of cache hits.	1
CacheQueryCount	integer	The number of cache hits.	2
CostTimeAvg	number	The average query duration associated with the SQL pattern.	1.0
CubeId	string	The dataset ID.	3e45b61a-9ba8-4c7c-8248-8dbe69945636
CubeName	string	The name of the dataset.	test
QueryCount	integer	The number of queries.	50
QueryCountAvg	number	The average number of queries.	2
QueryOverFivePercentNum	number	The percentage of queries that exceed 5 seconds.	0.1
QueryOverFiveSecPercent	string	The proportion of queries that exceed 5 seconds.	0.5
QueryOverTenSecPercent	string	The percentage of queries that exceed 10s.	0.1
QueryOverTenSecPercentNum	number	The percentage of queries that exceed 10s.	0.3
QueryTimeoutCount	integer	The number of chart query timeouts.	1
QueryTimeoutCountPercent	number	The percentage of chart queries that timed out.	0.3
QuickIndexCostTimeAvg	number	The average query time for the Quick engine.	1
QuickIndexQueryCount	integer	The number of times that the Quick engine is hit.	2
RepeatQueryPercent	string	The proportion of duplicate queries.	0.1
RepeatQueryPercentNum	number	The number of duplicate queries.	2
RepeatSqlQueryCount	integer	The number of repeated SQL queries.	2
RepeatSqlQueryPercent	string	The proportion of duplicate queries.	0.3
WorkspaceId	string	The workspace ID.	6ea74bff-c818-4188-b462-dbb45a24dbac
WorkspaceName	string	The name of the workspace.	eco0sh0prods
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": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "AdviceType": "OPENQUICKENGINE",
      "CubePerformanceDiagnoseModel": {
        "CacheCostTimeAvg": 1,
        "CacheQueryCount": 2,
        "CostTimeAvg": 1,
        "CubeId": "3e45b61a-9ba8-4c7c-8248-8dbe69945636",
        "CubeName": "test",
        "QueryCount": 50,
        "QueryCountAvg": 2,
        "QueryOverFivePercentNum": 0.1,
        "QueryOverFiveSecPercent": "0.5",
        "QueryOverTenSecPercent": "0.1",
        "QueryOverTenSecPercentNum": 0.3,
        "QueryTimeoutCount": 1,
        "QueryTimeoutCountPercent": 0.3,
        "QuickIndexCostTimeAvg": 1,
        "QuickIndexQueryCount": 2,
        "RepeatQueryPercent": "0.1",
        "RepeatQueryPercentNum": 2,
        "RepeatSqlQueryCount": 2,
        "RepeatSqlQueryPercent": "0.3",
        "WorkspaceId": "6ea74bff-c818-4188-b462-dbb45a24dbac",
        "WorkspaceName": "eco0sh0prods"
      }
    }
  ],
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.