DescribeOasSQLHistoryList - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this API to view the SQL execution history.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	Yes	The ID of the tenant.	t4louaeei****
StartTime	string	Yes	The start time of querying the execution history of the SQL statement. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2023-04-12T04:38:38Z
EndTime	string	Yes	The end time of querying the execution history of the SQL statement. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2023-04-12T05:38:38Z
DbName	string	No	The name of the database.	test_db
SqlId	string	Yes	SQL ID.	8D6E84**0B8FB1823D199E2CA1**
NodeIp	string	No	The IP address of the node.	i-bp19y05uq6x*********
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh-CN

Response parameters

Parameter	Type	Description	Example
	object	Returned response.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object []	The list of SQL execution history.
SQLId	string	SQL ID.	8D6E84**0B8FB1823D199E2CA1**
DbName	string	The name of the database.	test_db
AvgAffectedRows	long	Average updated rows during the execution period.	9978.75
AvgBlockCacheHit	long	Average BlockCache hit count during the execution period.	0.0
AvgBlockIndexCacheHit	long	Average BlockIndexCache hit count during the execution period.	0.0
AvgBloomFilterCacheHit	long	Average BloomFilterCache hit count during the execution period.	0.0
Executions	long	Total number of executions during the execution period.	1
FailCount	long	The total number of errors during the execution period.	0
AvgRpcCount	long	Average number of RPC sent during the execution.	8.0
RemotePlans	long	Remote plan count.	0
MissPlans	long	Missed plan count.	0
AvgReturnRows	long	Average number of rows returned during the execution period.	0.0
AvgLogicalReads	long	Average logical reads during the execution period.	0.0
RetryCount	long	Total number of retries during the execution period.	0
AvgRowCacheHit	long	Average RowCache hit count during the execution period.	0.0
AvgDiskReads	long	Average physical read count during the execution period.	0.0
AvgMemstoreReadRows	long	Average Memstore read rows during the execution period.	0.0
AvgSsstoreReadRows	long	Average Ssstore read rows during the execution period.	0.0
AvgApplicationWaitTime	double	Average Application event wait time (in milliseconds) during the client waiting period.	0.0
AvgElapsedTime	double	Average response time (in milliseconds) during the execution period.	1876.78
AvgExecuteTime	double	Average plan execution time (in milliseconds) during the execution period.	1895.7
AvgQueueTime	double	Average queueing time (in milliseconds) during the execution period.	0.01
AvgConcurrencyWaitTime	double	Average Concurrency event wait time (in milliseconds) during the execution period.	0.0
AvgCpuTime	double	Average CPU time (in milliseconds) during the execution period.	1875.34
AvgDecodeTime	double	Average syntax parsing time (in milliseconds) during the execution period.	0.0
AvgNetWaitTime	double	Average network enqueue time (in milliseconds) during the network waiting period.	0.0
AvgUserIoWaitTime	double	Average UserIO event wait time (in milliseconds) during the execution period.	0.0
AvgGetPlanTime	double	Average plan generation time (in milliseconds) during the execution period.	0.0
MaxElapsedTime	double	Max response time.	13643.3
SumWaitTime	double	The total wait time (in milliseconds) during the internal waiting period.	9421.73
AvgScheduleTime	double	Average Schedule event wait time (in milliseconds) during the scheduling period.	0.0
MaxCpuTime	double	Max CPU time.	13641.9
SumElapsedTime	double	Total response time (in milliseconds) during the execution period.	11452126.36
Timestamp	string	Timestamp for the sample.	2023-04-12T04:46:38Z
Server	string	The server where the SQL is executed.	i-bp1db1****8uemejio
UserName	string	Username.	test_user
AvgPartitionCount	double	Average number of partition accessed during the execution period.	1
FailPercentage	double	Error percentage during the execution period.	0
RetCode4012Count	double	Number of occurrences of code 4012 during the execution period.	0
RetCode4013Count	double	Number of occurrences of code 4013 during the execution period.	0
RetCode5001Count	double	Number of occurrences of code 5001 during the execution period.	0
RetCode5024Count	double	Number of occurrences of code 5024 during the execution period.	0
RetCode5167Count	double	Number of occurrences of code 5167 during the execution period.	0
RetCode5217Count	double	Number of occurrences of code 5217 during the execution period.	0
RetCode6002Count	double	Number of occurrences of code 6002 during the execution period.	0
AvgWaitTime	double	Average wait time (in milliseconds) during the execution period.	1442.49
AvgWaitCount	double	Average number of waits during the execution period.	0
LocalPlanPercentage	double	Local plan percentage during the execution period.	0
RemotePlanPercentage	double	Remote plan percentage during the execution period.	0
DistPlanPercentage	double	Distributed plan percentage during the execution period.	100
AvgNetTime	double	Average network transmission time (in milliseconds) during the execution period.	8
AvgExecutorRpcCount	double	Average number of RPC requests executed during the execution period.	0
MissPlanPercentage	double	Plan hit rage during the execution period.	0
TableScanPercentage	double	Table scan percentage during the execution period.	0
StrongConsistencyPercentage	double	Strong consistent transaction percentage during the execution period.	100
WeakConsistencyPercentage	double	Eventually consistent transaction percentage during the execution period.	0
MaxAffectedRows	double	Max updated rows during the execution period.	10000
MaxReturnRows	double	Max returned rows during the execution period.	0
MaxWaitTime	double	Max wait time (in milliseconds) during the execution period.	3.4
MaxApplicationWaitTime	double	Max Application event wait time (in milliseconds) during the execution period	0
MaxConcurrencyWaitTime	double	Max Concurrency event wait time (in milliseconds) during the execution period	0
MaxUserIoWaitTime	double	Max UserIO event wait time (in milliseconds) during the execution period	0
MaxDiskReads	double	Max physical read count during the execution period.	0
AvgExpectedWorkerCount	double	Average degree of parallelism during the execution period.	3
AvgUsedWorkerCount	double	Average number of threads used of the SQL during the execution period.	3
SumLogicalReads	double	Total logical reads.	0
ExecPs	double	Average execution count per second during the execution period.	0.31

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "SQLId": "8D6E84****0B8FB1823D199E2CA1****",
      "DbName": "test_db",
      "AvgAffectedRows": 9978.75,
      "AvgBlockCacheHit": 0,
      "AvgBlockIndexCacheHit": 0,
      "AvgBloomFilterCacheHit": 0,
      "Executions": 1,
      "FailCount": 0,
      "AvgRpcCount": 8,
      "RemotePlans": 0,
      "MissPlans": 0,
      "AvgReturnRows": 0,
      "AvgLogicalReads": 0,
      "RetryCount": 0,
      "AvgRowCacheHit": 0,
      "AvgDiskReads": 0,
      "AvgMemstoreReadRows": 0,
      "AvgSsstoreReadRows": 0,
      "AvgApplicationWaitTime": 0,
      "AvgElapsedTime": 1876.78,
      "AvgExecuteTime": 1895.7,
      "AvgQueueTime": 0.01,
      "AvgConcurrencyWaitTime": 0,
      "AvgCpuTime": 1875.34,
      "AvgDecodeTime": 0,
      "AvgNetWaitTime": 0,
      "AvgUserIoWaitTime": 0,
      "AvgGetPlanTime": 0,
      "MaxElapsedTime": 13643.3,
      "SumWaitTime": 9421.73,
      "AvgScheduleTime": 0,
      "MaxCpuTime": 13641.9,
      "SumElapsedTime": 11452126.36,
      "Timestamp": "2023-04-12T04:46:38Z",
      "Server": "i-bp1db1****8uemejio",
      "UserName": "test_user",
      "AvgPartitionCount": 1,
      "FailPercentage": 0,
      "RetCode4012Count": 0,
      "RetCode4013Count": 0,
      "RetCode5001Count": 0,
      "RetCode5024Count": 0,
      "RetCode5167Count": 0,
      "RetCode5217Count": 0,
      "RetCode6002Count": 0,
      "AvgWaitTime": 1442.49,
      "AvgWaitCount": 0,
      "LocalPlanPercentage": 0,
      "RemotePlanPercentage": 0,
      "DistPlanPercentage": 100,
      "AvgNetTime": 8,
      "AvgExecutorRpcCount": 0,
      "MissPlanPercentage": 0,
      "TableScanPercentage": 0,
      "StrongConsistencyPercentage": 100,
      "WeakConsistencyPercentage": 0,
      "MaxAffectedRows": 10000,
      "MaxReturnRows": 0,
      "MaxWaitTime": 3.4,
      "MaxApplicationWaitTime": 0,
      "MaxConcurrencyWaitTime": 0,
      "MaxUserIoWaitTime": 0,
      "MaxDiskReads": 0,
      "AvgExpectedWorkerCount": 3,
      "AvgUsedWorkerCount": 3,
      "SumLogicalReads": 0,
      "ExecPs": 0.31
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-02-02

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-21

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: DynamicSql