GetQueryOptimizeSolution - Database Autonomy Service - Alibaba Cloud Documentation Center

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:GetQueryOptimizeSolution	get	All Resources *	none	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 parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message.	Successful
Data	object	The data returned.
Total	long	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.
QueryOptimizeSolutions	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

Sample success responses

JSONformat

{
  "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
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
2023-04-23	The Error code has changed. The request parameters of the API has changed	View Change Details