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

调试

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

请求参数

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

系统规定参数。取值:SummaryJobDetail。

DtsJobId String l3m1213ye7l****

迁移或同步任务ID。

说明 与实例ID两者至少需填一个。
JobCode String 02

迁移阶段,取值:

  • 02:结构迁移阶段。
  • 03:增量迁移阶段。
SynchronizationDirection String Forward

同步链路方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明
  • 默认取值为Forward
  • 当数据同步实例的拓扑为双向时,才可以传入Reverse以释放反向同步链路。
RegionId String cn-hangzhou

DTS实例所属的地域,详情请参见支持的地域列表

DtsInstanceId String dtsl3m1213ye7l****

迁移或同步实例ID。

说明 与任务ID两者至少需填一个。

返回数据

名称 类型 示例值 描述
Code String 200

错误码,本参数即将下线。

HttpStatusCode Integer 200

状态码。

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(序列)。

State Integer 0

迁移状态,返回值:

  • 0:finish(结束)。
  • 1:catched(等待同步)。
  • 2:init(初始化)。
  • 3:running(同步中)。
  • 4:warning(报错)。
  • 5:failed(失败)。
TotalCount Long 100

迁移对象总数。

RequestId String 65EE90A6-9062-51B0-9997-75F7E574****

请求ID。

Success Boolean true

请求是否成功,返回值:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

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

正常返回示例

XML格式

<SummaryJobDetailResponse>
      <requestId>65EE90A6-9062-51B0-9997-75F7E574****</requestId>
      <success>true</success>
      <progressSummaryDetails>
            <key>Function</key>
            <state>5</state>
            <totalCount>22</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>Procedure</key>
            <state>5</state>
            <totalCount>26</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>Table</key>
            <state>0</state>
            <totalCount>68</totalCount>
      </progressSummaryDetails>
      <progressSummaryDetails>
            <key>View</key>
            <state>5</state>
            <totalCount>100</totalCount>
      </progressSummaryDetails>
      <httpStatusCode>200</httpStatusCode>
</SummaryJobDetailResponse>

JSON格式

{
    "requestId": "65EE90A6-9062-51B0-9997-75F7E574****",
    "success": true,
    "progressSummaryDetails": [
        {
            "key": "Function",
            "state": 5,
            "totalCount": 22
        },
        {
            "key": "Procedure",
            "state": 5,
            "totalCount": 26
        },
        {
            "key": "Table",
            "state": 0,
            "totalCount": 68
        },
        {
            "key": "View",
            "state": 5,
            "totalCount": 100
        }
    ],
    "httpStatusCode": 200
}

错误码

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