All Products
Search
Document Center

Data Management:GetDataCorrectTaskDetail

Last Updated:Jul 15, 2024

Queries the information about a data change, lock-free data change, or data import task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 CreateDataCorrectOrder , CreateDataImportOrder , or CreateFreeLockCorrectOrder operation to obtain the ticket ID.

12435523
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
14325432

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773
Successboolean

Indicates whether the request was successful.

true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
DataCorrectTaskDetailobject

The details of the data change task.

DBTaskGroupIdlong

The ID of the SQL task group.

1234235
jobStatusstring

The state of the SQL task. Valid values:

  • INIT: The SQL task was initialized.
  • PENDING: The SQL task waited to be run.
  • BE_SCHEDULED: The SQL task waited to be scheduled.
  • FAIL: The SQL task failed.
  • SUCCESS: The SQL task was successful.
  • PAUSE: The SQL task was paused.
  • DELETE: The SQL task was deleted.
  • RUNNING: The SQL task was being run.
SUCCESS
ActualAffectRowslong

The number of rows affected by the SQL statement.

1
CreateTimestring

The time when the task was created.

2021-03-05 15:08:55

Examples

Sample success responses

JSONformat

{
  "RequestId": "B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DataCorrectTaskDetail": {
    "DBTaskGroupId": 1234235,
    "jobStatus": "SUCCESS",
    "ActualAffectRows": 1,
    "CreateTime": "2021-03-05 15:08:55"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history