GetSQLReviewCheckResultStatus API Overview - Data Management - Alibaba Cloud - Data Management

Queries the result of an SQL review.

Operation description

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

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

dms:GetSQLReviewCheckResultStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket. You can obtain the ticket ID from the response parameters of the CreateSQLReviewOrder operation.	123321
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the ID of the tenant.	1

Response elements

Element	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	integer	The total number of SQL statements.	10
CheckedCount	integer	The number of SQL statements that were reviewed.	10
CheckStatusResult	object	The result of the SQL status check.
New	integer	The number of SQL statements to be reviewed.	0
Unknown	integer	The number of abnormal SQL statements.	0
CheckNotPass	integer	The number of SQL statements that failed to pass the review.	1
CheckPass	integer	The number of SQL statements that passed the review.	8
ForcePass	integer	The number of SQL statements that passed the manual review.	1
ForceNotPass	integer	The number of SQL statements that failed to pass the manual review.	0
SQLReviewResult	object	The optimization suggestion for SQL statements.
MustImprove	integer	The number of SQL statements that must be modified.	1
PotentialIssue	integer	The number of SQL statements that have potential issues.	0
SuggestImprove	integer	The number of SQL statements that can be modified.	3
UseDmsToolkit	integer	The number of SQL statements that can be used for lock-free schema changes.	0
UseDmsDmlUnlock	integer	The number of SQL statements that can be used for lock-free data changes.	0
TableIndexSuggest	integer	The number of SQL statements that can use indexes.	2

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.