GetDataTrackJobDegree - Data Management - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetDataTrackJobDegree	none	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	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	double	The progress of binary log obtaining. Valid values: 0 to 1. A value of 1 indicates that binary log obtaining is complete.	1
DownloadCompletionDegree	double	The progress of binary log download. Valid values: 0 to 1. A value of 1 indicates that binary log download is complete.	1
FilterCompletionDegree	double	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

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 time	Summary of changes	Operation

No change history