调用SummaryJobDetail接口统计DTS数据迁移或同步任务中迁移表的数量

调试

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

调试

请求参数

名称	类型	是否必选	示例值	描述

名称	类型	是否必选	示例值	描述
Action	String	是	SummaryJobDetail	系统规定参数。取值：SummaryJobDetail。
DtsJobId	String	是	l3m1213ye7l****	迁移或同步任务ID。
JobCode	String	是	02	迁移阶段，取值： 02：结构迁移阶段。 03：增量迁移阶段。
SynchronizationDirection	String	是	Forward	同步链路方向，取值： Forward：正向。 Reverse：反向。说明默认取值为Forward。当数据同步实例的拓扑为双向时，才可以传入Reverse以释放反向同步链路。
RegionId	String	否	cn-hangzhou	DTS实例所属的地域，详情请参见支持的地域列表。
DtsInstanceId	String	否	dtsl3m1213ye7l****	迁移或同步实例ID。
StructType	String	否	before	结构定义的类型，取值： before：库表结构迁移或初始化。 after：增量数据迁移或同步的DDL操作。

返回数据

名称	类型	示例值	描述

名称	类型	示例值	描述
HttpStatusCode	Integer	200	状态码。
Code	String	200	错误码。
RequestId	String	9033138C-5AB3-5EB7-BA78-43131F19297C	请求ID。
Success	Boolean	true	请求是否成功，返回值： true：请求成功。 false：请求失败。
JobId	String	l3m1213ye7l****	迁移或同步任务ID。
ProgressSummaryDetails	Array of ProgressSummaryDetail		迁移对象数组返回信息。说明数组返回格式如下：[{"key":"Function","state":5,"totalCount":22},{"key":"Procedure","state":5,"totalCount":26},{"key":"Table","state":0,"totalCount":68},{"key":"View","state":5,"totalCount":100}]。
Key	String	Table	迁移对象类型，返回值：Table（表）、Constraint（约束）、Index（索引）、View（视图）、Materialize View（物化视图）、Type（自定义类型）、Synonym（同义词）、Trigger（触发器）、Function（函数）、Procedure（存储过程）、Package（包）、Default（默认值）、Rule（规则）、PlanGuide（执行计划）、Sequence（序列）。
TotalCount	Long	100	迁移对象总数。
State	Integer	0	迁移状态，返回值： 0：finish（结束）。 1：catched（等待同步）。 2：init（初始化）。 3：running（同步中）。 4：warning（报错）。 5：failed（失败）。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=SummaryJobDetail
&DtsJobId=l3m1213ye7l****
&JobCode=02
&SynchronizationDirection=Forward
&RegionId=cn-hangzhou
&DtsInstanceId=dtsl3m1213ye7l****
&StructType=before
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SummaryJobDetailResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Code>200</Code>
    <RequestId>9033138C-5AB3-5EB7-BA78-43131F19297C</RequestId>
    <Success>true</Success>
    <JobId>l3m1213ye7l****</JobId>
    <ProgressSummaryDetails>
        <Key>Table</Key>
        <TotalCount>100</TotalCount>
        <State>0</State>
    </ProgressSummaryDetails>
</SummaryJobDetailResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "Code" : "200",
  "RequestId" : "9033138C-5AB3-5EB7-BA78-43131F19297C",
  "Success" : true,
  "JobId" : "l3m1213ye7l****",
  "ProgressSummaryDetails" : [ {
    "Key" : "Table",
    "TotalCount" : 100,
    "State" : 0
  } ]
}

错误码

HttpCode	错误码	错误信息	描述

HttpCode	错误码	错误信息	描述
400	Throttling.User	Request was denied due to user flow control.	由于请求频次达到阈值，请求被拒绝，请稍后重试。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	签名已经过期，请更新签名

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