Automate SQL Tuning with OptimizeSqlByMetaAgent API - Data Management - Alibaba Cloud - Data Management

Operation description

Analyzes SQL performance and optimizes SQL statements for a specified database.

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

dms:OptimizeSqlByMetaAgent

none

*All Resource

*

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DbId	string	Yes	The ID of the database. You can call the ListDatabases operation to obtain the ID.	1***
Query	string	No	The remarks.	是否为慢SQL
Sql	string	Yes	The SQL statement to analyze.	select * from table where col = 1
Model	string	No	The model name. Only Qwen series models are supported.	qwen-plus

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The data returned.
Content	string	The answer.	SQL优化结果...
SessionId	string	The session ID.	f63a6eed-0e3c-4564-8533-b1295db8d6ff

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "Content": "SQL优化结果...",
    "SessionId": "f63a6eed-0e3c-4564-8533-b1295db8d6ff"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.