All Products
Search
Document Center

Data Management:ListDataImportSQLPreCheckDetail

Last Updated:Oct 21, 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

There is currently no authorization information disclosed in the API.

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