Collects the full request statistics in the SQL Explorer results of a database instance by access source.
Operation description
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 .
- If you use an SDK to call API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| hdm:GetFullRequestOriginStatByInstanceId | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| UserId | string | No | The ID of the Alibaba Cloud account that is used to create the database instance. Note
This parameter is optional. The system can automatically obtain the account ID based on the value of InstanceId when you call this operation.
| 196278346919**** |
| InstanceId | string | Yes | The instance ID. | rm-2ze8g2am97624**** |
| NodeId | string | No | The node ID. Note
This parameter must be specified if the database instance is a PolarDB for MySQL cluster.
| pi-bp12v7243x012**** |
| Start | long | 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 must be within the storage duration of the SQL Explorer of the database instance, and can be up to 90 days earlier than the current time.
| 1644716649000 |
| End | long | 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 between the start time and the end time cannot exceed 24 hours.
| 1644803409000 |
| OrderBy | string | No | The field by which the results to be returned are sorted. Default value: count. Valid values:
| count |
| Asc | boolean | No | Specifies whether to sort the results in ascending order. By default, the results are not sorted in ascending order. | Disabled |
| 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, 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 instance, a PolarDB for MySQL instance, or a PolarDB-X 2.0 instance, statistics can be collected based on the SQL statement type.
| SELECT |
| Role | string | No | The role of the PolarDB-X 2.0 node. Valid values:
| polarx_cn |
Response parameters
Examples
Sample success responses
JSONformat
{
"Message": "Successful",
"RequestId": "7172BECE-588A-5961-8126-C216E16B****",
"Data": {
"List": [
{
"Key": "172.26.6****",
"AvgFetchRows": 0,
"AvgLockWaitTime": 0.00009589874265269765,
"AvgLogicalRead": 654.4470327860251,
"AvgPhysicalAsyncRead": 0,
"AvgPhysicalSyncRead": 0,
"AvgRows": 0,
"AvgExaminedRows": 10000,
"AvgReturnedRows": 10000,
"AvgUpdatedRows": 10000,
"AvgRt": 2.499,
"AvgSqlCount": 10000,
"Count": 100000,
"CountRate": 0.0586,
"Database": "dbtest01",
"ErrorCount": 1,
"FetchRows": 200,
"Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
"LockWaitTime": 1089.4177720290281,
"LogicalRead": 7434573266,
"OriginHost": "172.26.6****",
"PhysicalAsyncRead": 0,
"PhysicalSyncRead": 0,
"Port": 3306,
"Rows": 0,
"ExaminedRows": 10000,
"RtGreaterThanOneSecondCount": 2,
"RtRate": 0.1384,
"SqlCount": 200,
"SumUpdatedRows": 200,
"Version": 1,
"VpcId": "vpc-2zentqj1sk4qmolci****"
}
],
"Total": 1
},
"Code": 200,
"Success": true
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. |
| 403 | NoPermission | You are not authorized to do this action. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|