GetQueryOptimizeSolution API Overview for SQL Query Optimization - DAS

Queries suggestions provided by query governance for optimizing an SQL template.

Operation description

If you use an Alibaba Cloud SDK or a Database Autonomy Service (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.
This operation supports the following database engines:
- ApsaraDB RDS for MySQL
- PolarDB for MySQL
- ApsaraDB RDS for PostgreSQL

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL	MySQL
SqlId	string	Yes	The SQL template ID. You can call the GetQueryOptimizeDataStats operation to query the SQL template ID.	05fecf7e7b3efd123c4d5197035f****
RuleIds	string	Yes	The tag ID. For more information, see Query governance.	LARGE_ROWS_EXAMINED
InstanceId	string	No	The instance ID. You can call the GetQueryOptimizeDataStats operation to query the instance ID.	rm-bp1o3z6beqpej****

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message.	Successful
Data	object	The data returned.
Total	integer	The total number of entries returned.	1
PageNo	integer	The reserved parameter.	None
PageSize	integer	The reserved parameter.	None
Extra	string	The reserved parameter.	None
List	array<object>	The optimization suggestions.
	object
Level	string	The severity level. Valid values: INFO WARN	INFO
RuleId	string	The tag ID.	LARGE_ROWS_EXAMINED
Solution	string	The suggestion.	LARGE_ROWS_EXAMINED_SOLUTION
SolutionExt	string	The reserved parameter.	None
RequestId	string	The request ID.	30FF4E40-17F3-5A51-AB23-43F30D9B****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 1,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "Level": "INFO",
        "RuleId": "LARGE_ROWS_EXAMINED",
        "Solution": "LARGE_ROWS_EXAMINED_SOLUTION",
        "SolutionExt": "None"
      }
    ]
  },
  "RequestId": "30FF4E40-17F3-5A51-AB23-43F30D9B****",
  "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.