查询任务信息
所有文档

          数据传输服务 DTS

          查询任务信息

          接口说明

          查看指定id的数据传输任务信息

          请求URI

          GET /v{version}/task/{dtsId}

          参数名称 参数类型 是否必须 描述 示例值 参数位置
          version String API版本号 "1" Path
          dtsId String 任务ID "dtsmxxxyyy" Path

          请求体参数

          响应头参数

          除公共头域,无其它特殊头域。

          响应体参数

          响应体字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          dtsId String 任务ID dtsmxxyy1234
          taskName String 任务名称 dtsmxxyy1234
          status String 任务状态(unConfig:未配置, 当用户创建完任务后, 就进入未配置状态, 该状态只有dtsId信息;ready:未启动, 当配置完后任务后就进入未启动状态, 这时就包含任务的所有信息;checking:前置检查中, 当用户点击启动后, 先会进行前置检查;checkPass:前置检查通过, 只有前置检查通过后, 才可以进行启动任务;checkFailed:前置检查失败, 任务启动时,会进行前置检查, 若检查失败, 就进入该状态, 这时可以进行修改任务或直接结束任务;running:运行中,前置检测通过后, 就进入该状态, 包括数据迁移中或数据同步中;stopping:暂停中,处于该状态的任务不能进行任何操作;stopped:已暂停,从该状态启动,会进行断点续传,比如:暂停后修改数据同步对象;stopCheckFailed:已暂停(新增同步对象前置检查失败),当新增同步对象时,会进行前置检查,如果检查失败,回到已暂停状态,但是可以查看检查失败原因;runFailed:运行失败, 当运行过程中出现异常就进入该状态,如果是可恢复错误, 修复后可继续启动,如果是不可恢复错误, 只能结束任务;finished:任务结束,包括手工进行结束,或任务完成后自动结束,或出现不可恢复的错误) finished
          dataType DataType
          region String 地域 bj
          createTime String 创建时间 2020-12-10T13: 24: 10Z
          srcConnection Connection
          dstConnection Connection
          schemaMapping SchemaMapping
          runningTime Integer 任务已运行时长 20
          subStatus List<SubStatus> 子任务状态
          dynamicInfo DynamicInfo
          errmsg String 执行失败时返回的错误信息, 执行成功时为空字符串
          sdkRealtimeProgress String (只限数据订阅)任务实时进度, UTC格式
          granularity String 传输任务的粒度,目前只区分实例级和库表级两种 dbtb
          subDataScope SubDataScope (只限数据订阅)订阅通道数据范围
          payInfo PayInfo 付费信息
          lockStatus String 任务是否被锁定, 取值有: unlock, lockExpiration unlock
          dtsIdPos String 双向同步任务时,正向任务ID dtsmxxyy1234
          dtsIdNeg String 双向同步任务时,反向任务ID dtsmxxyy1234
          dtsTaskPos DtsTaskPos 双向同步任务时,正向任务信息
          dtsTaskNeg DtsTaskNeg 双向同步任务时,反向任务信息

          Connection字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          instanceType String 实例类型 bcerds
          region String 地域 bj
          dbType String 数据库类型 mysql
          dbUser String 数据库访问账号 dts_trans
          dbPass String 数据库访问密码
          dbPort Integer 数据库访问端口 3306
          dbHost String 数据库ip或主机名 192.168.1.1
          instanceId String 实例ID rdsmfgdti3d53f5
          field_whitelist String 列过滤(白名单)
          field_blacklist String 列过滤(黑名单)

          Schema字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          type String 需要传输的对象类型, 取值有: db(库), table(表), view(视图), function(函数), procedure(存储过程) table
          src String 源库的schema名称 test.table_src
          dst String 目标库的schema名称 test.table_dst
          where String where过滤条件

          SubStatus字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          s String 结构 running
          b String 全量 running
          i String 增量 running

          DynamicInfo字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          schema List<DynamicInfoSchema>
          base List<DynamicInfoBase>
          increment List<DynamicInfoIncrement>

          DynamicInfoSchema字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          current String 已迁移schema数 800
          count String 迁移总schema数 1000
          speed String 迁移速度 500
          expectFinishTime String 预测剩余时间(s) 20

          DynamicInfoBase字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          current String 已迁移数据行数 800
          count String 迁移总数据行数 1000
          speed String 迁移速度 500
          expectFinishTime String 预测剩余时间(s) 20

          DynamicInfoIncrement字段数据结构说明

          SubDataScope字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          startTime String 开始时间
          endTime String 结束时间

          PayInfo字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          productType String 付费方式,预付费(prepay)、后付费(postpay) postpay
          sourceInstanceType String 源端实例类型(OnBce:百度智能云数据库;OffBce:自建数据存储) OnBce
          targetInstanceType String 目标端实例类型(OnBce:百度智能云数据库;OffBce:自建数据存储) OnBce
          crossRegionTag Integer 跨地域标识(0:同地域;1:跨地域) 0
          createTime Long 资源创建时间,UNIX 时间戳(毫秒数) 1607606657000
          standard String 规格(Large:大规格;目前仅支持大规格) Large
          endTime Long UNIX 时间戳(毫秒数) 1607606657000

          DtsTaskPos字段数据结构说明

          dtsTaskPos 字段,即双向同步任务时,正向任务信息,所以该字段的值结构跟任务本身结构一致。

          DtsTaskNeg字段数据结构说明

          dtsTaskNeg 字段,即双向同步任务时,反向任务信息,所以该字段的值结构跟任务本身结构一致。

          请求示例

          GET /v1/task/{dtsId}
          <公共请求头>

          响应示例

          HTTP/1.1 200 OK
          <公共响应头>
          
          {
            "subDataScope" : {
              "startTime" : "startTime",
              "endTime" : "endTime"
            },
            "schemaMapping" : [ {
              "dst" : "test.table_dst",
              "src" : "test.table_src",
              "where" : "where",
              "type" : "table"
            }, {
              "dst" : "test.table_dst",
              "src" : "test.table_src",
              "where" : "where",
              "type" : "table"
            } ],
            "dataType" : [ "base", "base" ],
            "dtsId" : "dtsmxxyy1234",
            "errmsg" : "errmsg",
            "runningTime" : 20,
            "dtsIdNeg" : "dtsmxxyy1234",
            "subStatus" : [ {
              "b" : "running",
              "s" : "running",
              "i" : "running"
            }, {
              "b" : "running",
              "s" : "running",
              "i" : "running"
            } ],
            "dtsIdPos" : "dtsmxxyy1234",
            "sdkRealtimeProgress" : "sdkRealtimeProgress",
            "lockStatus" : "unlock",
            "createTime" : "2020-12-10T13: 24: 10Z",
            "granularity" : "dbtb",
            "dtsTaskNeg" : { },
            "taskName" : "dtsmxxyy1234",
            "region" : "bj",
            "srcConnection" : {
              "dbPass" : "dbPass",
              "dbPort" : 3306,
              "instanceId" : "rdsmfgdti3d53f5",
              "instanceType" : "bcerds",
              "dbUser" : "_dts_trans_",
              "field_whitelist" : "field_whitelist",
              "dbType" : "mysql",
              "dbHost" : "192.168.1.1",
              "field_blacklist" : "field_blacklist",
              "region" : "bj"
            },
            "dynamicInfo" : {
              "schema" : [ {
                "expectFinishTime" : "20",
                "current" : "800",
                "count" : "1000",
                "speed" : "500"
              }, {
                "expectFinishTime" : "20",
                "current" : "800",
                "count" : "1000",
                "speed" : "500"
              } ],
              "increment" : [ [ { }, { } ], [ { }, { } ] ],
              "base" : [ {
                "expectFinishTime" : "20",
                "current" : "800",
                "count" : "1000",
                "speed" : "500"
              }, {
                "expectFinishTime" : "20",
                "current" : "800",
                "count" : "1000",
                "speed" : "500"
              } ]
            },
            "payInfo" : {
              "standard" : "Large",
              "sourceInstanceType" : "OnBce",
              "createTime" : 1607606657000,
              "targetInstanceType" : "OnBce",
              "crossRegionTag" : 0,
              "endTime" : 1607606657000,
              "productType" : "postpay"
            },
            "dtsTaskPos" : { },
            "status" : "finished"
          }

          错误码

          请参考通用错误码

          上一篇
          创建任务
          下一篇
          查询任务列表