ListDataCorrectPreCheckSQL - Data Management - Alibaba Cloud Documentation Center

Queries the information about SQL statements that are involved in the precheck of a data change ticket.

Operation description

For more information about the Normal Data Modify feature, see Change regular data.

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

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:ListDataCorrectPreCheckSQL	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the data change ticket. You can call the ListOrders operation to query the ID of the data change ticket.	453****
PageNumber	long	No	The number of the page to return.	1
PageSize	long	No	The number of entries to return on each page.	10
DbId	long	No	The ID of the database. The database can be a physical database or a logical database. To query the ID of a physical database, call the ListDatabases or SearchDatabase operation. To query the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	1930****
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	31853A2B-DC9D-5B39-8492-D2AC8BCF550E
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrorMessage	string	The error message returned.	UnknownError
ErrorCode	string	The error code returned.	UnknownError
PreCheckSQLList	array<object>	The precheck information about SQL statements.
PreCheckSQL	object
CheckSQL	string	The SQL statement.	OPTIMIZE TABLE `Text_TableNames`
AffectRows	long	The estimated number of affected rows.	0
DbId	long	The ID of the database.	1930****
SQLReviewQueryKey	string	The key that is used to query the details of optimization suggestions. You can call the GetSQLReviewOptimizeDetail operation to query the details of optimization suggestions based on the key.	b9e771fc6ec247dea6d06a32c777****
SqlReviewStatus	string	The review status of the SQL statement. Valid values: WAITING: The SQL statement is pending for review. RUNNING: The SQL statement is being reviewed. IGNORE: The SQL statement review is skipped. PASS: The SQL statement passed the review. BLOCK: The SQL statement failed the review.	WAITING
SqlType	string	The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.	OPTIMIZE
TableNames	string	The name of the table whose data is changed.	Text_TableNames

Examples

Sample success responses

JSONformat

{
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PreCheckSQLList": [
    {
      "CheckSQL": "OPTIMIZE TABLE `Text_TableNames`",
      "AffectRows": 0,
      "DbId": 0,
      "SQLReviewQueryKey": "b9e771fc6ec247dea6d06a32c777****",
      "SqlReviewStatus": "WAITING",
      "SqlType": "OPTIMIZE",
      "TableNames": "Text_TableNames"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history