GetSQLReviewOptimizeDetail - Data Management - Alibaba Cloud Documentation Center

Queries the details of optimization suggestions. The operation applies only to the tickets for the data changes and SQL review.

Operation description

For more information about the SQL review feature, see SQL review.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SQLReviewQueryKey	string	Yes	The key that is used to query the details of optimization suggestions. You can call the ListSQLReviewOriginSQL operation to query the key.	a57e54ec5433475ea3082d882fdb****
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the ID of the tenant.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code returned.	UnknownError
ErrorMessage	string	The error message returned.	UnknownError
Success	boolean	Indicates whether the request is successful.	true
OptimizeDetail	object	The details of optimization suggestions for SQL statements.
QueryKey	string	The key that is used to query the details of optimization suggestions.	a57e54ec5433475ea3082d882fdb****
InstanceId	integer	The ID of the instance to which the database belongs.	123321
DbId	integer	The ID of the database.	111222
SqlType	string	The type of the SQL statement. Valid values: DELETE, UPDATE, and ALTER_TABLE.	UPDATE
QualityResult	object	The quality of the SQL statement.
ErrorMessage	string	The error message returned.	syntax error
Results	array<object>	The review results based on rules.
Results	object
RuleName	string	The name of the rule. For more information, see SQL review optimization.	SELECT_SUGGEST_ASSIGN_WHERE
Feedback	string	The optimization suggestion for the SQL statement. Valid values: MUST_IMPROVE: The SQL statement must be improved. POTENTIAL_ISSUE: The SQL statement contains potential issues. SUGGEST_IMPROVE: We recommend that you improve the SQL statement. USEDMSTOOLKIT: We recommend that you change schemas without locking tables. USEDMSDML_UNLOCK: We recommend that you change data without locking tables. TABLEINDEXSUGGEST: We recommend that you use SQL statements that use indexes.	MUST_IMPROVE
Comments	string	The comment that is specified when you create the SQL review rule. For more information, see SQL review optimization.	xxx business rule: the query must have a where condition.
Messages	array	The review results.
Messages	string	audit information.	the xxx table does not exist.
Scripts	array<object>	The SQL script for data changes.
Scripts	object
OpType	string	The purpose of the SQL script. The value is set to AddIndex.	AddIndex
Content	string	The content of the SQL script.	alter table xxx add index idx_xx(yyy);
TableName	string	The name of the table.	xxx
RuleType	string	The type of the SQL review rule. Valid values: REVIEW: a rule that is used to review SQL statements based on standards. OPTIMIZE: a rule that is used to provide optimization suggestions.	REVIEW
OccurError	boolean	Indicates whether an error occurs. Valid values: true: An error occurs. false: No error occurs.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "OptimizeDetail": {
    "QueryKey": "a57e54ec5433475ea3082d882fdb****",
    "InstanceId": 123321,
    "DbId": 111222,
    "SqlType": "UPDATE",
    "QualityResult": {
      "ErrorMessage": "syntax error",
      "Results": [
        {
          "RuleName": "SELECT_SUGGEST_ASSIGN_WHERE",
          "Feedback": "MUST_IMPROVE",
          "Comments": "xxx business rule: the query must have a where condition.",
          "Messages": [
            "the xxx table does not exist."
          ],
          "Scripts": [
            {
              "OpType": "AddIndex",
              "Content": "alter table xxx add index idx_xx(yyy);",
              "TableName": "xxx"
            }
          ],
          "RuleType": "REVIEW"
        }
      ],
      "OccurError": false
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history