Retrieve Report Performance Logs via API - Quick BI

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 report 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:QueryReportPerformance	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.	95296e95-ca89-4c7d-8af9-dedf0ad0****
ReportId	string	No	The ID of the security report.	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.	10
PageNum	integer	No	Current page number for organization member list: Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	1FC71085-D5FD-08E0-813A-4D4BD1031BC5
Result	array<object>	The returned results.
Data	object	Report the performance analysis model.
ReportId	string	The ID of the work.	6b407e50-e774-406b-9956-da2425c2****
ReportName	string	The name of the report.	ClusterAddonUpgradeReport
ComponentQueryCount	integer	The number of times the chart is queried.	1
ComponentQueryCountAvg	double	The average number of times the chart is queried.	2.0
ReportType	string	The format of the report.	report
QueryTimeoutCount	integer	The number of times that the chart query times out.	8
RepeatSqlQueryPercent	string	The proportion of duplicate queries.	0.7
WorkspaceName	string	The name of the group.	test
WorkspaceId	string	The ID of the workspace to which the work belongs.	ab46ed33-6278-4ef7-8013-8c1335f266ee
RepeatQueryPercentNum	double	The number of duplicate queries.	3
RepeatQueryPercent	string	The proportion of duplicate queries.	0.8
QuickIndexCostTimeAvg	double	The average time consumed by the Quick engine query.	10
QuickIndexQueryCount	integer	The number of times that the Quick engine is hit.	5
CacheCostTimeAvg	double	The average duration of cache hits.	2.2
CacheQueryCount	integer	The number of cache hits.	1
RepeatSqlQueryCount	integer	The number of times the query is repeated.	1
CostTimeAvg	double	The average query duration associated with the SQL pattern.	0.2
QueryCountAvg	double	The average number of queries.	3.3
QueryCount	integer	The number of queries.	50
QueryTimeoutCountPercent	double	The percentage of timeout times for chart queries.	0.5
QueryOverTenSecPercentNum	double	The number of queries that exceed 10 seconds.	0.5
QueryOverFivePercentNum	double	The percentage of the number of queries that exceed the 5S.	0.5
QueryOverTenSecPercent	string	The percentage of queries that exceed 10s.	0.5
QueryOverFiveSecPercent	string	Query the proportion of more than 5S.	0.5
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": "1FC71085-D5FD-08E0-813A-4D4BD1031BC5",
  "Result": [
    {
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ReportName": "ClusterAddonUpgradeReport",
      "ComponentQueryCount": 1,
      "ComponentQueryCountAvg": 2,
      "ReportType": "report",
      "QueryTimeoutCount": 8,
      "RepeatSqlQueryPercent": 0.7,
      "WorkspaceName": "test",
      "WorkspaceId": "ab46ed33-6278-4ef7-8013-8c1335f266ee",
      "RepeatQueryPercentNum": 3,
      "RepeatQueryPercent": 0.8,
      "QuickIndexCostTimeAvg": 10,
      "QuickIndexQueryCount": 5,
      "CacheCostTimeAvg": 2.2,
      "CacheQueryCount": 1,
      "RepeatSqlQueryCount": 1,
      "CostTimeAvg": 0.2,
      "QueryCountAvg": 3.3,
      "QueryCount": 50,
      "QueryTimeoutCountPercent": 0.5,
      "QueryOverTenSecPercentNum": 0.5,
      "QueryOverFivePercentNum": 0.5,
      "QueryOverTenSecPercent": 0.5,
      "QueryOverFiveSecPercent": 0.5
    }
  ],
  "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.

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