All Products
Search

This Product

    Data Management:ListDataCorrectPreCheckSQL

    Document Center

    Data Management:ListDataCorrectPreCheckSQL

    Last Updated:Aug 28, 2026

    Queries the SQL statements involved in the precheck of a data change ticket.

    Operation description

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

    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:ListDataCorrectPreCheckSQL

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    OrderId

    integer

    Yes

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

    453****
    PageNumber

    integer

    No

    The number of the page to return.

    1
    PageSize

    integer

    No

    The number of entries to return on each page.

    10
    DbId

    integer

    No

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

    1930****
    Tid

    integer

    No

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

    3***

    Response elements

    Element

    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.

    object

    CheckSQL

    string

    The SQL statement.

    OPTIMIZE TABLE `Text_TableNames`
    AffectRows

    integer

    The estimated number of affected rows.

    0
    DbId

    integer

    The ID of the database.

    1930****
    SQLReviewQueryKey

    string

    The key used to query optimization suggestion details. You can call the GetSQLReviewOptimizeDetail operation to query the details based on this key.

    b9e771fc6ec247dea6d06a32c777****
    SqlReviewStatus

    string

    The review status of the SQL statement. Valid values:

    • WAITING: The SQL statement is pending 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

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.