Queries sample SQL statements in the SQL Explorer data of a database instance by SQL ID. You can query up to 20 sample SQL statements.
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 the database engines that support SQL Explorer, see SQL Explorer.
- If you use an SDK to call API operations of 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 Resources
is 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:GetFullRequestSampleByInstanceId | 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**** |
SqlId | string | Yes | The SQL statement ID. | 651b56fe9418d48edb8fdf0980ec**** |
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 feature of the database instance, and can be up to 90 days earlier than the current time.
| 1660097421000 |
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 must be equal to or greater than 1 hour.
| 1660104621000 |
Role | string | No | The role of the PolarDB-X 2.0 node. Valid values:
| polarx_cn |
Response parameters
Examples
Sample success responses
JSON
format
{
"Message": "Successful",
"RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
"Data": [
{
"Timestamp": 1660100753556,
"SqlId": "651b56fe9418d48edb8fdf0980ec****",
"Sql": "select * from testdb01 where ****",
"Database": "dbtest",
"Rt": 0.409789,
"User": "testuser",
"LockWaitTime": 0.0137,
"LogicalRead": 165848,
"PhysicalSyncRead": 0,
"PhysicalAsyncRead": 0,
"RowsExamined": 2048576,
"RowsReturned": 14,
"OriginHost": "172.17.XX.XX",
"ScanRows": 0,
"UpdateRows": 0,
"SqlType": "SELECT",
"Scnt": 0,
"Rows": 0,
"Frows": 0
}
],
"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 |
---|---|---|
2022-08-15 | Add Operation | View Change Details |