GetDataTrackJobDegree - 获取数据追踪任务进度 - 数据管理 DMS

获取数据追踪任务进度。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetDataTrackJobDegree

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OrderId	integer	是	工单 ID，可通过调用接口 ListOrders 获取该参数的值。	321****
Tid	integer	否	租户 ID。可通过调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	C51420E3-144A-4A94-B473-8662FCF4AD10
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
JobDegree	object	任务进度详情。
ListCompletionDegree	number	获取日志处理进展。进度范围从 0 到 1，1 表示日志已处理完成。	1
DownloadCompletionDegree	number	下载日志文件进度。进度范围从 0 到 1，1 表示已完成下载日志文件。	1
FilterCompletionDegree	number	解析日志文件进度。进度范围从 0 到 1，1 表示已完成解析日志文件。	1
JobStatus	string	数据追踪任务状态，取值和说明如下： INIT：任务初始化。 LISTING：正在获取 Binlog 列表。 LIST_SUCCESS：获取 Binlog 列表完成。 DOWNLOADING：正在下载 Binlog。 DOWNLOAD_FAIL：下载 Binlog 失败。 DOWNLOAD_SUCCESS：下载 Binlog 完成。 FILTERING：正在解析 Binlog。 FILTER_FAIL：解析 Binlog 失败。 FILTER_SUCCESS：解析 Binlog 完成。	FILTER_SUCCESS
StatusDesc	string	状态描述信息。	searching success

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。