Retrieve & Analyze Component Performance Logs via API - Quick BI - Alibaba Cloud - Quick BI

Queries the performance logs of components in a specified 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:QueryComponentPerformance

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryType	string	Yes	The query type. Valid values: lastDay: Yesterday sevenDays: Within seven days thirtyDays: Within 30 days	sevenDays
WorkspaceId	string	Yes	The workspace ID.	89713491-cb4f-4579-b889-e82c35f1****
ReportId	string	No	The work ID. Works include BI portals, dashboards, spreadsheets, and self-service access.	6b407e50-e774-406b-9956-da2425c2****
ResourceType	string	No	The resource type.	report
CostTimeAvgMin	integer	No	The average query duration, in minutes.	1
PageSize	integer	No	The number of rows per page. Default value: 10. Maximum value: 1,000.	100
PageNum	integer	No	The page number for paginated results. Pages start from page 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BCE45E6D-9304-4F94-86BB-5A772B1615FF
Result	array<object>	The query results.
	object	The component performance analysis model.
CacheCostTimeAvg	number	The average duration of cache hits.	0.3
CacheQueryCount	integer	The number of cache hits.	3
ComponentId	string	The component ID.	0696083a-ca72-4d89-8e7a-c017910e0***
ComponentName	string	The component name.	线图
CostTimeAvg	number	The average query duration associated with the SQL pattern.	0.3
QueryCount	integer	The number of queries.	5
QueryCountAvg	number	The average number of queries.	0.3
QueryOverFivePercentNum	number	The number of queries that exceeded 5 seconds.	5
QueryOverFiveSecPercent	string	The percentage of queries that exceeded 5 seconds.	0.3
QueryOverTenSecPercent	string	The percentage of queries that exceed 10s.	0.3
QueryOverTenSecPercentNum	number	The number of queries that exceeded 10 seconds.	0.3
QueryTimeoutCount	integer	The number of timed-out chart queries.	1
QueryTimeoutCountPercent	number	The timeout percentage of chart queries.	0.3
QuickIndexCostTimeAvg	number	The average query duration for the Quick engine.	0.3
QuickIndexQueryCount	integer	The number of Quick engine hits.	3
RepeatQueryPercent	string	The percentage of duplicate queries.	0.3
RepeatQueryPercentNum	number	The number of duplicate queries.	2
RepeatSqlQueryCount	integer	The number of repeated queries.	5
RepeatSqlQueryPercent	string	The percentage of repeated SQL queries.	0.3
ReportId	string	The work ID.	6b407e50-e774-406b-9956-da2425c2****
ReportName	string	The name of the report.	ClusterRiskReport
ReportType	string	The report type.	report
WorkspaceId	string	The workspace ID.	89713491-cb4f-4579-b889-e82c35f1****
WorkspaceName	string	The workspace name.	测试空间
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": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
  "Result": [
    {
      "CacheCostTimeAvg": 0.3,
      "CacheQueryCount": 3,
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "线图",
      "CostTimeAvg": 0.3,
      "QueryCount": 5,
      "QueryCountAvg": 0.3,
      "QueryOverFivePercentNum": 5,
      "QueryOverFiveSecPercent": "0.3",
      "QueryOverTenSecPercent": "0.3",
      "QueryOverTenSecPercentNum": 0.3,
      "QueryTimeoutCount": 1,
      "QueryTimeoutCountPercent": 0.3,
      "QuickIndexCostTimeAvg": 0.3,
      "QuickIndexQueryCount": 3,
      "RepeatQueryPercent": "0.3",
      "RepeatQueryPercentNum": 2,
      "RepeatSqlQueryCount": 5,
      "RepeatSqlQueryPercent": "0.3",
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ReportName": "ClusterRiskReport",
      "ReportType": "report",
      "WorkspaceId": "89713491-cb4f-4579-b889-e82c35f1****",
      "WorkspaceName": "测试空间"
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Parameter.Error	The parameter is invalid:%s.
500	Workspace.Not.Exist	The group workspace does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.