Queries statistics on automatic SQL optimization events within a period of time, such as the total number of optimization events and the maximum improvement.
Operation description
Before you call this operation, take note of the following items:
- If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this API operation, we recommend that you use the latest version of the SDK.
- If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.
- The database engine is ApsaraDB RDS for MySQL or PolarDB for MySQL.
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:GetInstanceSqlOptimizeStatistic | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The database instance ID. Note
The database instance must be an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster.
| pc-wz90h9560rvdz**** |
| StartTime | string | 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. | 1661308902060 |
| EndTime | string | 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. | 1662518540764 |
| NodeId | string | No | The node ID. Note
For ApsaraDB RDS for MySQL Cluster Edition instances or PolarDB for MySQL clusters, you must specify the node ID.
| pi-bp12v7243x012**** |
| Threshold | string | No | The duration threshold for automatic SQL optimization events. After this parameter is specified, the system collects statistics on automatic SQL optimization events whose duration does not exceed the specified threshold. Note
This parameter is a reserved parameter and does not take effect.
| None |
| FilterEnable | string | No | Specifies whether to filter instances for which DAS Enterprise Edition is enabled. Valid values:
Note
If you set this parameter to true, only database instances for which DAS Enterprise Edition is disabled are queried. If you set this parameter to false, all database instances are queried.
| false |
| UseMerging | string | No | Specifies whether to merge automatic SQL optimization events. Valid values:
Note
This parameter is a reserved parameter and does not take effect.
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "200",
"Message": "Successful",
"Data": {
"count": 16,
"improvement": 1003
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"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 |
|---|