All Products
Search
Document Center

Data Management:GetDataTrackJobDegree

最終更新日:Oct 21, 2024

Queries the progress of a data tracking task.

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 query the ticket ID.

321****
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

C51420E3-144A-4A94-B473-8662FCF4AD10
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
JobDegreeobject

The progress details of the data tracking task.

ListCompletionDegreedouble

The progress of binary log obtaining. Valid values: 0 to 1. A value of 1 indicates that binary log obtaining is complete.

1
DownloadCompletionDegreedouble

The progress of binary log download. Valid values: 0 to 1. A value of 1 indicates that binary log download is complete.

1
FilterCompletionDegreedouble

The progress of binary log parsing. Valid values: 0 to 1. A value of 1 indicates that binary log parsing is complete.

1
JobStatusstring

The status of the data tracking task. Valid values:

  • INIT: The task is being initialized.
  • LISTING: The binary logs are being obtained.
  • LIST_SUCCESS: The binary logs are successfully obtained.
  • DOWNLOADING: The binary logs are being downloaded.
  • DOWNLOAD_FAIL: The binary logs failed to be downloaded.
  • DOWNLOAD_SUCCESS: The binary logs are successfully downloaded.
  • FILTERING: The binary logs are being parsed.
  • FILTER_FAIL: The binary logs failed to be parsed.
  • FILTER_SUCCESS: The binary logs are successfully parsed.
FILTER_SUCCESS
StatusDescstring

The description of the task status.

searching success

Examples

Sample success responses

JSONformat

{
  "RequestId": "C51420E3-144A-4A94-B473-8662FCF4AD10",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "JobDegree": {
    "ListCompletionDegree": 1,
    "DownloadCompletionDegree": 1,
    "FilterCompletionDegree": 1,
    "JobStatus": "FILTER_SUCCESS",
    "StatusDesc": "searching success"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history