GetSQLReviewCheckResultStatus - Data Management - Alibaba Cloud Documentation Center

Queries the result of an SQL review.

Operation description

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

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
dms:GetSQLReviewCheckResultStatus	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the ticket. You can obtain the ticket ID from the response parameters of the CreateSQLReviewOrder operation.	123321
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain 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 if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful.	true
CheckResultStatus	object	The result of the SQL review.
TotalSQLCount	long	The total number of SQL statements.	10
CheckedCount	long	The number of SQL statements that were reviewed.	10
CheckStatusResult	object	The result of the SQL status check.
New	long	The number of SQL statements to be reviewed.	0
Unknown	long	The number of abnormal SQL statements.	0
CheckNotPass	long	The number of SQL statements that failed to pass the review.	1
CheckPass	long	The number of SQL statements that passed the review.	8
ForcePass	long	The number of SQL statements that passed the manual review.	1
ForceNotPass	long	The number of SQL statements that failed to pass the manual review.	0
SQLReviewResult	object	The optimization suggestion for SQL statements.
MustImprove	long	The number of SQL statements that must be modified.	1
PotentialIssue	long	The number of SQL statements that have potential issues.	0
SuggestImprove	long	The number of SQL statements that can be modified.	3
UseDmsToolkit	long	The number of SQL statements that can be used for lock-free schema changes.	0
UseDmsDmlUnlock	long	The number of SQL statements that can be used for lock-free data changes.	0
TableIndexSuggest	long	The number of SQL statements that can use indexes.	2

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "CheckResultStatus": {
    "TotalSQLCount": 10,
    "CheckedCount": 10,
    "CheckStatusResult": {
      "New": 0,
      "Unknown": 0,
      "CheckNotPass": 1,
      "CheckPass": 8,
      "ForcePass": 1,
      "ForceNotPass": 0
    },
    "SQLReviewResult": {
      "MustImprove": 1,
      "PotentialIssue": 0,
      "SuggestImprove": 3,
      "UseDmsToolkit": 0,
      "UseDmsDmlUnlock": 0,
      "TableIndexSuggest": 2
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history