All Products
Search
Document Center

Database Autonomy Service:GetQueryOptimizeSolution

Last Updated:Mar 03, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:GetQueryOptimizeSolutionRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnginestringYes

The database engine. Valid values:

  • MySQL
  • PolarDBMySQL
  • PostgreSQL
MySQL
SqlIdstringYes

The SQL template ID. You can call the GetQueryOptimizeDataStats operation to query the SQL template ID.

05fecf7e7b3efd123c4d5197035f****
RuleIdsstringYes

The tag ID. For more information, see Query governance.

LARGE_ROWS_EXAMINED
InstanceIdstringNo

The instance ID. You can call the GetQueryOptimizeDataStats operation to query the instance ID.

rm-bp1o3z6beqpej****

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

The returned message.

Successful
Dataobject

The data returned.

Totallong

The total number of entries returned.

1
PageNointeger

The reserved parameter.

None
PageSizeinteger

The reserved parameter.

None
Extrastring

The reserved parameter.

None
Listobject []

The optimization suggestions.

Levelstring

The severity level. Valid values:

  • INFO
  • WARN
INFO
RuleIdstring

The tag ID.

LARGE_ROWS_EXAMINED
Solutionstring

The suggestion.

LARGE_ROWS_EXAMINED_SOLUTION
SolutionExtstring

The reserved parameter.

None
RequestIdstring

The request ID.

30FF4E40-17F3-5A51-AB23-43F30D9B****
Successstring

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 codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-23The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: InstanceId