All Products
Search
Document Center

Data Management:ListDataCorrectPreCheckSQL

Last Updated:Oct 21, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the data change ticket. You can call the ListOrders operation to query the ID of the data change ticket.

453****
PageNumberlongNo

The number of the page to return.

1
PageSizelongNo

The number of entries to return on each page.

10
DbIdlongNo

The ID of the database. The database can be a physical database or a logical database.

1930****
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

31853A2B-DC9D-5B39-8492-D2AC8BCF550E
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrorMessagestring

The error message returned.

UnknownError
ErrorCodestring

The error code returned.

UnknownError
PreCheckSQLListarray<object>

The precheck information about SQL statements.

PreCheckSQLobject
CheckSQLstring

The SQL statement.

OPTIMIZE TABLE `Text_TableNames`
AffectRowslong

The estimated number of affected rows.

0
DbIdlong

The ID of the database.

1930****
SQLReviewQueryKeystring

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****
SqlReviewStatusstring

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
SqlTypestring

The type of the SQL statement, such as DELETE, UPDATE, or ALTER_TABLE.

OPTIMIZE
TableNamesstring

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 timeSummary of changesOperation
No change history