All Products
Search
Document Center

Data Management:GetDataExportPreCheckDetail

Last Updated:Oct 21, 2024

Queries the precheck details of an SQL result set export 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 ID of the ticket. You can call the ListOrders operation to obtain the ticket ID.

34****
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C1D39814-9808-47F8-AFE0-AF167239AC9B
ErrorCodestring

The error code returned.

UnknownError
ErrorMessagestring

The error message returned.

UnknownError
PreCheckResultobject

Indicates the result of the precheck task.

IgnoreAffectRowsboolean

Specifies whether to skip verification. Valid values:

  • true
  • false
true
PreCheckDetailListarray<object>

The list of pre-check details.

PreCheckDetailListobject
AffectRowslong

The estimated number of data rows to be affected.

1
SQLstring

The SQL statement.

SELECT * FROM tmp_table LIMIT 1
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "C1D39814-9808-47F8-AFE0-AF167239AC9B",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "PreCheckResult": {
    "IgnoreAffectRows": true,
    "PreCheckDetailList": {
      "PreCheckDetailList": [
        {
          "AffectRows": 1,
          "SQL": "SELECT * FROM tmp_table LIMIT 1"
        }
      ]
    }
  },
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history