Call the GetDataTrackJobDegree API to query the progress of a data tracking task - Data Management - Alibaba Cloud - Data Management

Queries the progress of a data tracking task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetDataTrackJobDegree

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket. You can call the ListOrders operation to query the ticket ID.	321****
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	C51420E3-144A-4A94-B473-8662FCF4AD10
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
JobDegree	object	The progress details of the data tracking task.
ListCompletionDegree	number	The progress of binary log obtaining. Valid values: 0 to 1. A value of 1 indicates that binary log obtaining is complete.	1
DownloadCompletionDegree	number	The progress of binary log download. Valid values: 0 to 1. A value of 1 indicates that binary log download is complete.	1
FilterCompletionDegree	number	The progress of binary log parsing. Valid values: 0 to 1. A value of 1 indicates that binary log parsing is complete.	1
JobStatus	string	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
StatusDesc	string	The description of the task status.	searching success

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.