DescribeSQLHistoryList - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the execution history of an SQL statement in a specified period based on an SQL ID.

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
TenantId	string	Yes	The ID of the tenant.	t2mr3oae0****
StartTime	string	Yes	The start time of the time range for querying the SQL execution history. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2021-06-13T15:40:43Z
EndTime	string	Yes	The end time of the time range for querying the SQL execution history. The value must be UTC time in the format of YYYY-MM-DDThh:mm:ssZ.	2021-09-13T15:40:43Z
SQLId	string	Yes	SQLID.	8D6E84**0B8FB1823D199E2CA1**
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries returned on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SQLHistoryList	object	The execution history of the SQL statement.
List	object []
ExecPerSecond	long	The number of executions per second.	163.0
MaxCpuTime	float	The maximum CPU time.	257.967
BlockCacheHit	long	The number of block cache hits.	14
DecodeTime	float	The time to wait for decoding.	0.0
RemotePlans	long	The number of remote plans.	0
RPCCount	long	The number of RPCs.	0
NetWaitTime	float	The network latency.	0.0
DiskRead	long	The number of physical reads.	0
NodeIp	string	The IP address of the node.	i-bp18qljorblo8es*****
ConcurrencyWaitTime	float	The wait time in concurrent execution.	0.0
DbName	string	The name of the database.	testdb
MemstoreReadRowCount	long	The number of rows read from the memory.	527
AppWaitTime	float	The wait time of the client.	0.0
ElapsedTime	float	The average response time.	76.382
MissPlans	long	The number of plan misses.	0
AffectedRows	long	The number of rows affected.	0
ScheduleTime	float	The scheduling duration.	0.0
Event	string	The wait event.	mysql response wait client
TotalWaitTime	float	The internal wait time.	10.966
ReturnRows	long	The number of rows returned.	1
ExecuteTime	float	The internal execution time.	61.044
UserName	string	The username.	tester
Executions	long	The number of executions.	89403
GetPlanTime	float	The time spent in hard parsing.	0.052
CpuTime	float	The average CPU time.	50.13
MaxElapsedTime	float	The maximum response time.	260.44
BlockIndexCacheHit	long	The number of block index cache hits.	4
EndTimeUTCString	string	The end time in UTC +0.	2021-12-28T02:08:18Z
EndTime	long	The end time.	2021-12-28T02:08:18Z
RetryCount	long	The number of retries.	0
ClientIp	string	The IP address of the client.	12.*.13.***
BloomFilterCacheHit	long	The number of Bloom filter cache hits.	0
IOWaitTime	float	The I/O wait time.	0.0
FailTimes	long	The number of failures.	0
QueueTime	float	The queuing time.	15.275
RowCacheHit	long	The number of row cache hits.	0
LogicalRead	long	The number of logical reads.	19
SsstoreReadRowCount	long	The number of rows read from the disk.	43086
Count	long	The quantity.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "SQLHistoryList": {
    "List": [
      {
        "ExecPerSecond": 163,
        "MaxCpuTime": 257.967,
        "BlockCacheHit": 14,
        "DecodeTime": 0,
        "RemotePlans": 0,
        "RPCCount": 0,
        "NetWaitTime": 0,
        "DiskRead": 0,
        "NodeIp": "i-bp18qljorblo8es*****",
        "ConcurrencyWaitTime": 0,
        "DbName": "testdb",
        "MemstoreReadRowCount": 527,
        "AppWaitTime": 0,
        "ElapsedTime": 76.382,
        "MissPlans": 0,
        "AffectedRows": 0,
        "ScheduleTime": 0,
        "Event": "mysql response wait client",
        "TotalWaitTime": 10.966,
        "ReturnRows": 1,
        "ExecuteTime": 61.044,
        "UserName": "tester",
        "Executions": 89403,
        "GetPlanTime": 0.052,
        "CpuTime": 50.13,
        "MaxElapsedTime": 260.44,
        "BlockIndexCacheHit": 4,
        "EndTimeUTCString": "2021-12-28T02:08:18Z",
        "EndTime": 0,
        "RetryCount": 0,
        "ClientIp": "1*2.***.1*3.***",
        "BloomFilterCacheHit": 0,
        "IOWaitTime": 0,
        "FailTimes": 0,
        "QueueTime": 15.275,
        "RowCacheHit": 0,
        "LogicalRead": 19,
        "SsstoreReadRowCount": 43086
      }
    ],
    "Count": 1
  }
}

Error codes

HTTP status code	Error code	Error message
2014	InternalError	The request processing has failed due to some unknown error.

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

Change history

Change time

Summary of changes

Operation

2022-01-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 2014
Output Parameters	The response structure of the API has changed.