Database Autonomy Service:GetSqlOptimizeAdvice - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Queries optimization suggestions that are generated by the SQL diagnostics feature of Database Autonomy Service (DAS).

Operation description

The SQL diagnostics feature provides optimization suggestions for instances based on diagnostics results. You can use the optimization suggestions to optimize instance indexes. For more information, see Automatic SQL optimization.

Note

Returns only optimization suggestions that the SQL diagnostics feature automatically generates.

Before you call this operation, take note of the following items:

This operation is applicable to ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters.
If you use an Alibaba Cloud SDK or DAS SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.

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:GetSqlOptimizeAdvice

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
Engine	string	No	The database engine. Valid values: MySQL: ApsaraDB RDS for MySQL. PolarDBMySQL: PolarDB for MySQL.	MySQL
InstanceIds	string	No	The instance ID. Note You must specify the instance ID only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster.	rm-2ze1jdv45i7l6****
StartDt	string	No	The start date of the time range to query. Specify the date in the yyyyMMdd format. The time must be in UTC. The default value of this parameter is one day before the current day. The value must be earlier than the current day.	20210916
EndDt	string	No	The end date of the time range to query. Specify the date in the yyyyMMdd format. The time must be in UTC. The default value of this parameter is one day before the current day. The value must be earlier than the current day. The interval between the start date and the end date cannot exceed 30 days.	20210917
Region	string	No	The region in which the instance resides. Valid values: cn-china: Chinese mainland. cn-hongkong: China (Hong Kong). ap-southeast-1: Singapore. This parameter takes effect only if InstanceIds is left empty. If you leave InstanceIds empty, the system obtains data from the region specified by Region. By default, Region is set to cn-china. If you specify InstanceIds, Region does not take effect, and the system obtains data from the region in which the first specified instance resides.** Note If your instances reside in the regions inside the Chinese mainland, set this parameter to cn-china**.	cn-china

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	string	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	object	The detailed information, including the error codes and the number of entries that are returned.
Status	string	The status of the task. Valid values: INIT: The task is being initialized. RUNNING: The task is running. FINISH: The task is complete. FAILED: The task failed.	FINISH
StatusCode	string	The status code of the task. Valid values: NO_DATA: No data is returned. INTERNAL_ERROR: An internal error occurred. SUCCESS: The task is successful.	SUCCESS
DownloadUrl	string	The URL that is used to download the file.	https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******
CreateTime	string	The time when the task was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1632303861000
ExpireTime	string	The time when the file expires. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The file expires three days after the task is created.	1632563061000
TaskId	string	The task ID.	2021091710461519216****
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Status": "FINISH",
    "StatusCode": "SUCCESS",
    "DownloadUrl": "https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******",
    "CreateTime": "1632303861000",
    "ExpireTime": "1632563061000",
    "TaskId": "2021091710461519216****"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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.