QueryComponentPerformance - Quick BI - Alibaba Cloud Documentation Center

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.

Queries component performance logs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:QueryComponentPerformance	list	All Resources ``	none	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 ID of the work. The works here include BI portal, dashboards, spreadsheets, and self-service access.	6b407e50-e774-406b-9956-da2425c2****
ResourceType	string	No	The resource types.	report
CostTimeAvgMin	integer	No	The average duration (minutes).	1
PageSize	integer	No	The number of rows per page in a paged query. Default value: 10. Maximum value: 1,000.	100
PageNum	integer	No	The current page number of the workspace member list: Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BCE45E6D-9304-4F94-86BB-5A772B1615FF
Result	array<object>	The result returned.
Data	object	Component performance analysis model.
CacheCostTimeAvg	double	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 name of the add-on.	test
CostTimeAvg	double	The average query duration associated with the SQL pattern.	0.3
QueryCount	integer	The number of queries.	5
QueryCountAvg	double	The average number of queries.	0.3
QueryOverFivePercentNum	double	The query exceeds the 5S number of queries.	5
QueryOverFiveSecPercent	string	Query the proportion of more than 5S.	0.3
QueryOverTenSecPercent	string	The percentage of queries that exceed 10s.	0.3
QueryOverTenSecPercentNum	double	The percentage of queries that exceed 10s.	0.3
QueryTimeoutCount	integer	The number of times that the chart query times out.	1
QueryTimeoutCountPercent	double	The percentage of timeout times for chart queries.	0.3
QuickIndexCostTimeAvg	double	The average time consumed by the Quick engine query.	0.3
QuickIndexQueryCount	integer	The number of times that the Quick engine is hit.	3
RepeatQueryPercent	string	The proportion of duplicate queries.	0.3
RepeatQueryPercentNum	double	The number of duplicate queries.	2
RepeatSqlQueryCount	integer	The number of times the query is repeated.	5
RepeatSqlQueryPercent	string	The proportion of duplicate queries.	0.3
ReportId	string	The ID of the work.	6b407e50-e774-406b-9956-da2425c2****
ReportName	string	The name of the report.	ClusterRiskReport
ReportType	string	The format of the report.	report
WorkspaceId	string	The unique ID of the space.	89713491-cb4f-4579-b889-e82c35f1****
WorkspaceName	string	The name of the group.	test
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "BCE45E6D-9304-4F94-86BB-5A772B1615FF",
  "Result": [
    {
      "CacheCostTimeAvg": 0.3,
      "CacheQueryCount": 3,
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "test",
      "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": "test"
    }
  ],
  "Success": true
}

Error codes

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

For a list of error codes, visit the Service error codes.