Use GetFullRequestStatResultByInstanceId to asynchronously collect full request statistics - Database Autonomy Service

Asynchronously collects the full request statistics in the SQL Explorer results of a database instance by SQL ID.

Operation description

Note

GetFullRequestStatResultByInstanceId is an asynchronous operation. After a request is sent, the complete results are not returned immediately. If the value of the isFinish parameter is false in the response, wait for 1 second and then send a request again. If the value of the isFinish parameter is true, the complete results are returned.

The SQL Explorer feature allows you to check the health status of SQL statements and troubleshoot performance issues. For more information, see SQL Explorer.

For more information about database instances that support this feature, see Overview of DAS Enterprise Edition.
If you use an SDK to call the API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.
When you call this operation, the value of the SqlId parameter changes due to the optimization of the SQL template algorithm starting from September 1, 2024. For more information, see [Notice] Optimization of the SQL template algorithm.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:GetFullRequestStatResultByInstanceId

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	No	The ID of the Alibaba Cloud account that was used to create the database instance. Note This parameter is optional. The system can automatically obtain the Alibaba Cloud account ID based on the value of InstanceId when you call the GetFullRequestOriginStatByInstanceId operation.	196278346919****
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
NodeId	string	No	The node ID. Note You must specify the node ID if your database instance is a PolarDB for MySQL cluster.	pi-bp12v7243x012****
SqlId	string	No	The SQL ID. Note If this parameter is specified, the full request statistics of the specified SQL query are collected. If this parameter is left empty, the full request statistics of the entire database instance are collected.	d71f82be1eef72bd105128204d2e****
OriginHost	string	No	The IP address of the client that executes the SQL statement. Note This parameter is optional. If this parameter is specified, the full request statistics of the specified IP address are collected. If this parameter is left empty, the full request statistics of the entire database instance are collected.	172.26.XX.XXX
Keyword	string	No	The keywords that are used for query.	dbtest01
Start	integer	Yes	The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The start time can be up to 90 days earlier than the current time.	1645581813000
End	integer	Yes	The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The end time must be later than the start time. The interval cannot exceed one day.	1645668213000
OrderBy	string	No	The field by which to sort the returned entries. Default value: count. Valid values: count: the number of executions. avgRt: the average execution duration. rtRate: the execution duration percentage. rowsExamined: the total number of scanned rows. avgRowsExamined: the average number of scanned rows. avgRowsReturned: the average number of returned rows.	count
Asc	boolean	No	Specifies whether to sort the results in ascending order. By default, the results are not sorted in ascending order.	关闭
PageNo	integer	Yes	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. 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 your database instance is an ApsaraDB RDS for MySQL instance, a PolarDB for MySQL cluster, or a PolarDB-X 2.0 instance, the statistics can be collected based on the SQL statement type.	SELECT
DbName	string	No	The name of the database.	dbtest01
Role	string	No	The role of the node in the PolarDB-X 2.0 instance. Valid values: polarx_cn: compute node. polarx_dn: data node.	polarx_cn

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message that contains information 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 full request data.
	object
SqlId	string	The SQL ID.	d71f82be1eef72bd105128204d2e****
AvgFetchRows	integer	The average number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
AvgLockWaitTime	number	The average lock wait latency. Unit: 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 parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
AvgReturnedRows	number	The average number of returned rows.	10000
AvgUpdatedRows	integer	The average number of updated rows. Note This parameter is returned only for ApsaraDB RDS for MySQL and PolarDB-X 2.0 databases.	10000
AvgRt	number	The average execution duration.	2.499
AvgSqlCount	integer	The average number of SQL statements.	10000
Count	integer	The total number of executions.	100000
CountRate	number	The percentage of the total number of executions.	0.0586
Database	string	The name of the database.	dbtest01
ErrorCount	integer	The number of failed executions.	1
FetchRows	integer	The number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
Ip	string	The IP address of the database instance.	rm-uf6dyi58dm6**.mysql.rds.aliy**.com
LockWaitTime	number	The lock wait latency. Unit: 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 that is used to connect to the database instance.	3306
Psql	string	The SQL template.	select * from dbtest01 where ****
Rows	integer	The total number of rows updated or returned by the compute nodes of the PolarDB-X 2.0 instance.	0
ExaminedRows	integer	The total number of scanned rows. Note This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
RtGreaterThanOneSecondCount	integer	The number of SQL statements that take longer than 1 second to execute.	20
RtRate	number	The execution duration percentage.	2.499
SqlCount	integer	The number of SQL statements.	200
SumUpdatedRows	integer	The total number of updated rows.	100
Tables	array	The names of tables in the database.
	string	The names of tables in the database.	tabletest01,tabletest02
Version	integer	The version number.	1
VpcId	string	The virtual private cloud (VPC) ID.	vpc-2zentqj1sk4qmolci****
Total	integer	The total number of entries returned.	1
Fail	boolean	Indicates whether the asynchronous request failed. Valid values: true false	false
IsFinish	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
ResultId	string	The request ID.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
State	string	The state of the asynchronous request. Valid values: RUNNING SUCCESS FAIL	SUCCESS
Timestamp	integer	The time when the asynchronous request was sent. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1645668213000
Code	integer	The HTTP status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	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.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.