All Products
Search

This Product

    Data Management:ListDataImportSQLPreCheckDetail

    Document Center

    Data Management:ListDataImportSQLPreCheckDetail

    Last Updated:Nov 28, 2024

    Queries the precheck information of SQL statements used for data import in a ticket.

    Operation description

    You can call this operation only if the data is imported in security mode in your data import ticket.

    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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    dms:ListDataImportSQLPreCheckDetaillist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    OrderIdlongYes

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

    		11****
    SqlTypestringNo

    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
    StatusCodestringNo

    The state of the ticket. If you leave this parameter empty, all the states are queried 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
    PageNumerlongNo

    The page number. Pages start from page 1.

    		1
    PageSizelongNo

    The number of entries per page.

    		20
    TidlongNo

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

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID. You can use the ID to locate logs and troubleshoot issues.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    ErrorMessagestring

    The error message returned if the request failed.

    		UnknownError
    ErrorCodestring

    The error code returned if the request failed.

    		UnknownError
    PreCheckSQLDetailListarray<object>

    The precheck information of SQL statements.

    PreCheckSQLDetailobject

    The precheck information of the SQL statement.

    SqlIdlong

    The SQL ID, which indicates the sequence number of the SQL statement. The number starts with 1.

    		1
    SqlTypestring

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

    		INSERT
    StatusCodestring

    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
    Skipboolean

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

    • true
    • false
    		true
    TotalCountlong

    The number of SQL statements.

    		1

    Examples

    Sample success responses

    JSONformat

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

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

    Change history

    Change timeSummary of changesOperation
    No change history