Asynchronously aggregates the full request data in the SQL Explorer results of a database instance by SQL ID.
Operation description
After you invoke the operation asynchronously, the complete results are not returned immediately. If the isFinish parameter in the response is false, wait 1 second and invoke the operation again until isFinish is true, which indicates that the complete results are returned.
The SQL Explorer feature diagnoses the health status of SQL statements and troubleshoots performance issues. For details, see SQL Explorer.
For supported database instances, see Usage notes for DAS Enterprise Edition.
When you use an SDK to invoke DAS, you must set the region to cn-shanghai.
Starting September 1, 2024, due to the optimization of the SQL template algorithm, the value of the SqlId parameter will change when you invoke this operation. For details, see Notice: Optimization of the SQL template algorithm.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdm:GetFullRequestStatResultByInstanceId |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| UserId |
string |
No |
The instance ID, which is the ID of the Alibaba Cloud account that created the database instance. Note
This parameter is optional. After you enter the ID of the target database instance, the system automatically obtains the instance ID when you call the API operation. |
196278346919**** |
| InstanceId |
string |
Yes |
The instance ID. |
rm-2ze8g2am97624**** |
| NodeId |
string |
No |
The node ID. Note
For PolarDB for MySQL instances, the node ID is required. |
pi-bp12v7243x012**** |
| SqlId |
string |
No |
The SQL ID. Note
If you specify an SQL ID, the full request data of the specified SQL ID is aggregated. If you leave this parameter empty, the full request data of the entire database instance is aggregated. |
d71f82be1eef72bd105128204d2e**** |
| OriginHost |
string |
No |
The IP address of the client that executed the SQL statement. Note
This parameter is optional. If you specify a client IP address, the full request data of the specified client IP address is aggregated. If you leave this parameter empty, the full request data of the entire database instance is aggregated. |
172.26.XX.XXX |
| Keyword |
string |
No |
The query keyword. |
dbtest01 |
| Start |
integer |
Yes |
The start time of the query. The format is a UNIX timestamp, in milliseconds. Note
The start time must be within the SQL Explorer storage duration for the database instance and cannot be more than 90 days earlier than the current time. |
1645581813000 |
| End |
integer |
Yes |
The end time of the query. The time is a UNIX timestamp in milliseconds. Note
The end time must be later than the start time, and the interval between the start time and the end time cannot exceed one day. |
1645668213000 |
| OrderBy |
string |
No |
The field by which to sort the results. Default value: count.
|
count |
| Asc |
boolean |
No |
Specifies whether to sort the results in ascending order. Default value: false. |
False |
| PageNo |
integer |
Yes |
The page number for the paged query. The paging starts from 1. Default value: 1. |
1 |
| PageSize |
integer |
Yes |
The data volume per page for paging in a paged query. Default value: 20. |
20 |
| SqlType |
string |
No |
The type of the SQL statement. Valid values: SELECT, INSERT, UPDATE, DELETE, LOGIN, LOGOUT, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE, DROP, SET, DESC, REPLACE, CALL, BEGIN, DESCRIBE, ROLLBACK, FLUSH, USE, SHOW, START, COMMIT, and RENAME. Note
If the database instance is an ApsaraDB RDS for MySQL, PolarDB for MySQL, or PolarDB-X 2.0 instance, you can aggregate data by SQL statement type. |
SELECT |
| DbName |
string |
No |
The name of the database. |
dbtest01 |
| Role |
string |
No |
The node information of the PolarDB-X 2.0 database instance. Valid values:
|
polarx_cn |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The detailed list of returned information. |
||
| Message |
string |
The message returned for the request. Note
If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned. |
Successful |
| RequestId |
string |
The request ID. |
7172BECE-588A-5961-8126-C216E16B**** |
| Data |
object |
The returned data. |
|
| Result |
object |
The returned full request data. |
|
| List |
array<object> |
The list of full request data. |
|
|
object |
The list of full request data. |
||
| SqlId |
string |
The SQL ID. |
d71f82be1eef72bd105128204d2e**** |
| AvgFetchRows |
integer |
The average number of rows pulled by the compute node from the data node in the PolarDB-X 2.0 database instance. |
0 |
| AvgLockWaitTime |
number |
The average lock wait time, in seconds. |
0.00009589874265269765 |
| AvgLogicalRead |
number |
The average number of logical reads. |
654.4470327860251 |
| AvgPhysicalAsyncRead |
integer |
The average number of physical asynchronous reads. |
0 |
| AvgPhysicalSyncRead |
integer |
The average number of physical synchronous reads. |
0 |
| AvgExaminedRows |
number |
The average number of scanned rows. Note
This field is supported by the following databases: ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL. |
10000 |
| AvgReturnedRows |
number |
The average number of returned rows. |
10000 |
| AvgUpdatedRows |
integer |
The average number of updated rows. Note
This field is supported by the following databases: ApsaraDB RDS for MySQL and PolarDB-X 2.0. |
10000 |
| AvgRt |
number |
The average time to execute. |
2.499 |
| AvgSqlCount |
integer |
The average SQL count. |
10000 |
| Count |
integer |
The total number of executions. |
100000 |
| CountRate |
number |
The proportion of times the statements execute. |
0.0586 |
| Database |
string |
The name of the database. |
dbtest01 |
| ErrorCount |
integer |
The number of execution errors. |
1 |
| FetchRows |
integer |
The number of rows pulled by the compute node from the data node in the PolarDB-X 2.0 database instance. |
0 |
| Ip |
string |
The network address of the instance. |
rm-uf6dyi58dm6****.mysql.rds.aliy****.com |
| LockWaitTime |
number |
The lock wait time, in seconds. |
1089.4177720290281 |
| LogicalRead |
integer |
The number of logical reads. |
7.434573266E9 |
| PhysicalAsyncRead |
integer |
The number of physical asynchronous reads. |
0 |
| PhysicalSyncRead |
integer |
The number of physical synchronous reads. |
0 |
| Port |
integer |
The port number. |
3306 |
| Psql |
string |
The SQL template. |
select * from dbtest01 where **** |
| Rows |
integer |
The total number of rows updated or returned by the compute node in the PolarDB-X 2.0 database instance. |
0 |
| ExaminedRows |
integer |
The total number of scanned rows. Note
This field is supported by the following databases: ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL. |
10000 |
| RtGreaterThanOneSecondCount |
integer |
The number of SQL statements whose execution time is greater than 1 second. |
20 |
| RtRate |
number |
The execution time proportion. |
2.499 |
| SqlCount |
integer |
The number of SQL statements. |
200 |
| SumUpdatedRows |
integer |
The total number of changed rows. |
100 |
| Tables |
array |
The name of the database table. |
|
|
string |
The name of the database table. |
tabletest01,tabletest02 |
|
| Version |
integer |
The version. |
1 |
| VpcId |
string |
The VPC ID. |
vpc-2zentqj1sk4qmolci**** |
| Total |
integer |
The total amount of data. |
1 |
| Fail |
boolean |
Indicates whether the request failed. Valid values:
|
false |
| IsFinish |
boolean |
Indicates whether the asynchronous request is completed. Valid values:
|
true |
| ResultId |
string |
The ID of the request. |
9CB97BC4-6479-55D0-B9D0-EA925AFE**** |
| State |
string |
The execution status of the asynchronous request. Valid values:
|
SUCCESS |
| Timestamp |
integer |
The execution time. The time is a UNIX timestamp in milliseconds. |
1645668213000 |
| Code |
integer |
The returned status code. |
200 |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"Message": "Successful",
"RequestId": "7172BECE-588A-5961-8126-C216E16B****",
"Data": {
"Result": {
"List": [
{
"SqlId": "d71f82be1eef72bd105128204d2e****",
"AvgFetchRows": 0,
"AvgLockWaitTime": 0.00009589874265269765,
"AvgLogicalRead": 654.4470327860251,
"AvgPhysicalAsyncRead": 0,
"AvgPhysicalSyncRead": 0,
"AvgExaminedRows": 10000,
"AvgReturnedRows": 10000,
"AvgUpdatedRows": 10000,
"AvgRt": 2.499,
"AvgSqlCount": 10000,
"Count": 100000,
"CountRate": 0.0586,
"Database": "dbtest01",
"ErrorCount": 1,
"FetchRows": 0,
"Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
"LockWaitTime": 1089.4177720290281,
"LogicalRead": 7434573266,
"PhysicalAsyncRead": 0,
"PhysicalSyncRead": 0,
"Port": 3306,
"Psql": "select * from dbtest01 where ****",
"Rows": 0,
"ExaminedRows": 10000,
"RtGreaterThanOneSecondCount": 20,
"RtRate": 2.499,
"SqlCount": 200,
"SumUpdatedRows": 100,
"Tables": [
"tabletest01,tabletest02"
],
"Version": 1,
"VpcId": "vpc-2zentqj1sk4qmolci****"
}
],
"Total": 1
},
"Fail": false,
"IsFinish": true,
"ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
"State": "SUCCESS",
"Timestamp": 1645668213000
},
"Code": 200,
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | The request parameters are invalid. |
| 403 | NoPermission | You are not authorized to do this action. | You do not have the permission to perform this operation. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.