All Products
Search

This Product

    Data Management:ListDataImportSQLPreCheckDetail

    Document Center

    Data Management:ListDataImportSQLPreCheckDetail

    Last Updated:Aug 28, 2026

    Retrieves the precheck details of SQL statements used for data import in a ticket.

    Operation description

    This operation supports only data import tickets that use security mode. Tickets that use express mode are not supported.

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

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    OrderId

    integer

    Yes

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

    11****
    SqlType

    string

    No

    The type of the SQL statement. Valid values:

    • SELECT

    • INSERT

    • DELETE

    • CREATE_TABLE

    Note

    You can log on to the Data Management (DMS) console and choose Security and Specifications > Operation Audit in the top navigation bar to view more types of SQL statements.

    INSERT
    StatusCode

    string

    No

    The state of the ticket. If not specified, all states are returned by default. Valid values:

    • INIT: The ticket is being initialized.

    • RUNNING: The ticket is in progress.

    • SUCCESS: The ticket is complete.

    • TIMEOUT: The ticket is skipped due to timeout.

    • FAIL: The ticket fails.

    SUCCESS
    PageNumer

    integer

    No

    The page number. Pages start from page 1.

    1
    PageSize

    integer

    No

    The number of entries per page.

    20
    Tid

    integer

    No

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

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID, used to locate logs and troubleshoot issues.

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

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true
    ErrorMessage

    string

    The error message returned if the request failed.

    UnknownError
    ErrorCode

    string

    The error code returned if the request failed.

    UnknownError
    PreCheckSQLDetailList

    array<object>

    The precheck information of SQL statements.

    object

    The precheck information of the SQL statement.

    SqlId

    integer

    The sequence number of the SQL statement, starting from 1.

    1
    SqlType

    string

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

    INSERT
    StatusCode

    string

    The state of the ticket. Valid values:

    • INIT: The ticket was being initialized.

    • RUNNING: The ticket was in progress.

    • SUCCESS: The ticket was complete.

    • TIMEOUT: The ticket was skipped due to timeout.

    • FAIL: The ticket failed.

    SUCCESS
    Skip

    boolean

    Indicates whether the precheck of the SQL statement was skipped. Valid values:

    • true

    • false

    true
    TotalCount

    integer

    The number of SQL statements.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PreCheckSQLDetailList": [
    {
      "SqlId": 1,
      "SqlType": "INSERT",
      "StatusCode": "SUCCESS",
      "Skip": true
    }
  ],
  "TotalCount": 1
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.