Use QueryCubePerformance to query dataset performance logs - Quick BI - Alibaba Cloud - Quick BI

Queries the performance logs of 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:QueryCubePerformance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryType	string	Yes	The query type. Valid values: lastDay: yesterday sevenDays: within the last seven days thirtyDays: within the last thirty days	sevenDays
WorkspaceId	string	Yes	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
CubeId	string	No	The dataset ID.	7c7223ae-****-3c744528014b
PageNum	integer	No	The current page number of the workspace member list. Starting value: 1 Default value: 1	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10 Maximum value: 1000	100
CostTimeAvgMin	integer	No	The average duration, in minutes.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	685072a0-1fd5-40ef-ae6b-cf94e79e718f
Result	array<object>	The list of dataset performance logs, which includes dataset information and performance statistics information such as query count, query duration, and cache hits.
	object	The dataset diagnostic information.
CacheCostTimeAvg	number	The average duration for cache hits.	1
CacheQueryCount	integer	The number of cache hits.	1
CostTimeAvg	number	The average query duration.	1
CubeId	string	The dataset ID.	7c7223ae-****-3c744528014b
CubeName	string	The dataset name.	test
QueryCount	integer	The number of queries.	50
QueryCountAvg	number	The average number of queries.	1
QueryOverFivePercentNum	number	The proportion of queries that take more than 5 seconds.	1.0
QueryOverFiveSecPercent	string	The percentage of queries that take more than 5 seconds.	1.0
QueryOverTenSecPercent	string	The percentage of queries that take more than 10 seconds.	1.0
QueryOverTenSecPercentNum	number	The proportion of queries that take more than 10 seconds.	1.0
QueryTimeoutCount	integer	The number of chart query timeouts.	1
QueryTimeoutCountPercent	number	The proportion of chart query timeouts.	1
QuickIndexCostTimeAvg	number	The average query duration for Quick engine hits.	1
QuickIndexQueryCount	integer	The number of Quick engine hits.	1
RepeatQueryPercent	string	The proportion of repeated queries.	0.3
RepeatQueryPercentNum	number	The number of repeated queries.	1
RepeatSqlQueryCount	integer	The number of repeated queries.	1
RepeatSqlQueryPercent	string	The proportion of repeated queries.	1
WorkspaceId	string	The ID of the workspace to which the resource belongs.	87c6b145-090c-43e1-9426-8f93be23****
WorkspaceName	string	The workspace name.	Test workspace
Success	boolean	Indicates whether the request is successful. Valid values: true: The request succeeded. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "685072a0-1fd5-40ef-ae6b-cf94e79e718f",
  "Result": [
    {
      "CacheCostTimeAvg": 1,
      "CacheQueryCount": 1,
      "CostTimeAvg": 1,
      "CubeId": "7c7223ae-****-3c744528014b",
      "CubeName": "test",
      "QueryCount": 50,
      "QueryCountAvg": 1,
      "QueryOverFivePercentNum": 1,
      "QueryOverFiveSecPercent": "1.0",
      "QueryOverTenSecPercent": "1.0",
      "QueryOverTenSecPercentNum": 1,
      "QueryTimeoutCount": 1,
      "QueryTimeoutCountPercent": 1,
      "QuickIndexCostTimeAvg": 1,
      "QuickIndexQueryCount": 1,
      "RepeatQueryPercent": "0.3",
      "RepeatQueryPercentNum": 1,
      "RepeatSqlQueryCount": 1,
      "RepeatSqlQueryPercent": "1",
      "WorkspaceId": "87c6b145-090c-43e1-9426-8f93be23****",
      "WorkspaceName": "taascontainerprod"
    }
  ],
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.