配置任务
所有文档

          数据传输服务 DTS

          配置任务

          接口说明

          配置传输任务, 内容包括传输对象的映射关系, 数据库连接信息等

          请求URI

          POST /v{version}/task/{dtsId}/config

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

          请求体参数

          请求体字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          dataType String[] 传输数据类型数组(schema:结构迁移;base:全量迁移;increment:增量迁移) ["base"]
          srcConnection Connection
          dstConnection Connection
          granularity String 传输任务的粒度(instance:实例级;dbtb:库表级) instance
          schemaMapping SchemaMapping

          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过滤条件

          响应头参数

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

          响应体参数

          响应体字段数据结构说明

          参数名称 参数类型 是否必须 描述 示例值
          dtsId String 任务ID dtsxxxyyyzzz

          请求示例

          POST /v1/task/{dtsId}/config
          <公共请求头>
          
          
          {
            "granularity" : "instance",
            "schemaMapping" : [ {
              "dst" : "test.table_dst",
              "src" : "test.table_src",
              "where" : "where",
              "type" : "table"
            } ],
            "dataType" : [ "base" ],
            "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"
            }
          }

          响应示例

          HTTP/1.1 200 OK
          <公共响应头>
          
          {
            "dtsId" : "dtsxxxyyyzzz"
          }

          错误码

          请参考通用错误码

          上一篇
          查询任务列表
          下一篇
          前置检查