调用ConfigureDtsJob接口配置一个迁移或同步任务。

调试

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

请求参数

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

系统规定参数,取值:ConfigureDtsJob

DataInitialization Boolean true

是否执行全量数据迁移或全量数据初始化,取值:

  • true:是,为默认值。
  • false:否。
DataSynchronization Boolean false

是否执行增量数据迁移或同步,取值:

  • false:否,为默认值。
  • true:是。
DbList String {"dtstest":{"name":"dtstest","all":true}}

待迁移或同步的对象,格式为JSON串。详细定义说明,请参见迁移、同步或订阅对象说明

DestinationEndpointInstanceType String RDS

目标实例类型,取值:

  • RDS:阿里云数据库产品,包括RDS MySQL、PolarDB MySQL、PolarDB-X、MongoDB等。
  • LocalInstance:有公网IP的自建数据库。
  • ECS:ECS上的自建数据库。
  • Express:通过专线接入的自建数据库。
  • CEN:通过云企业网CEN接入的自建数据库。
  • dg:通过数据库网关接入的自建数据库。
DtsJobName String RDS间迁移

DTS实例名称。

JobType String MIGRATION

实例类型,取值为:

  • MIGRATION:迁移。
  • SYNC:同步。
SourceEndpointInstanceType String RDS

源实例类型,取值:

  • RDS:阿里云数据库产品,包括RDS MySQL、PolarDB MySQL、PolarDB-X、MongoDB等。
  • LocalInstance:有公网IP的自建数据库。
  • ECS:ECS上的自建数据库。
  • Express:通过专线接入的自建数据库。
  • CEN:通过云企业网CEN接入的自建数据库。
  • dg:通过数据库网关接入的自建数据库。
StructureInitialization Boolean true

是否执行库表结构迁移或初始化,取值:

  • true:是,为默认值。
  • false:否。
SourceEndpointInstanceID String rm-bp1imrtn6fq7h****

源实例ID。

SourceEndpointEngineName String MySQL

源实例数据库引擎类型。

  • MySQL:MySQL数据库(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB-O。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis数据库(包括云数据库Redis和自建Redis)。
  • DRDS:云原生分布式数据库PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB数据库(包括云数据库MongoDB和自建MongoDB)。
  • tidb:TiDB数据库。
  • ADS:云原生数仓 AnalyticDB MySQL 2.0。
  • ADB30:云原生数仓 AnalyticDB MySQL 3.0。
  • Greenplum:云原生数仓 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server数据库(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka数据库(包括消息队列Kafka版和自建Kafka)。
  • DataHub:阿里云流式数据服务DataHub。
  • clickhouse:云数据库 ClickHouse。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:表格存储Tablestore。
说明
SourceEndpointRegion String cn-hangzhou

源实例区域,详情请参见支持的地域列表

SourceEndpointIP String 172.16.88.***

源库的IP地址。

说明SourceEndpointInstanceType取值为LocalInstanceECSExpressdgCEN时,本参数才可用且必须传入。
SourceEndpointPort String 3306

源实例的数据库服务端口。

说明SourceEndpointInstanceType取值为 LocalInstanceECSExpressdgCEN时,本参数才可用且必须传入。
SourceEndpointOracleSID String testsid

Oracle数据库的SID信息。

说明SourceEndpointEngineName取值为Oracle,且Oracle数据库为非RAC实例时,本参数才可用且必须传入。
SourceEndpointDatabaseName String dtstestdatabase

待迁移的数据库名称或鉴权数据库名称。

说明
  • SourceEndpointEngineName取值为PostgreSQLMongoDB时,本参数才可用且必须传入。
  • SourceEndpointEngineName取值为PostgreSQL时,传入待迁移的数据库名称;取值为MongoDB时,传入数据库账号的鉴权数据库名称。
SourceEndpointUserName String dtstest

源库的数据库账号。

说明 迁移或同步不同的数据库所需的权限有所差异,详情请参见DTS数据迁移方案概览DTS数据同步方案概览中对应的配置案例。
SourceEndpointPassword String Test123456

源库数据库账号密码。

SourceEndpointOwnerID String 140692647406****

源RDS实例所属的阿里云账号ID。

说明 传入本参数即代表执行跨阿里云账号的数据迁移或同步,同时您还需要传入SourceEndpointRole参数。
SourceEndpointRole String ram-for-dts

源实例所属云账号配置的角色名称。

说明 执行跨阿里云账号的数据迁移或同步时须传入本参数,该角色所需的权限及授权方式请参见跨阿里云账号数据迁移或同步时如何配置RAM授权
DestinationEndpointInstanceID String rm-bp1162kryivb8****

目标实例ID。

DestinationEndpointEngineName String MySQL

目标数据库引擎类型。

  • MySQL:MySQL数据库(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB-O。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis数据库(包括云数据库Redis和自建Redis)。
  • DRDS:云原生分布式数据库PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB数据库(包括云数据库MongoDB和自建MongoDB)。
  • tidb:TiDB数据库。
  • ADS:云原生数仓 AnalyticDB MySQL 2.0。
  • ADB30:云原生数仓 AnalyticDB MySQL 3.0。
  • Greenplum:云原生数仓 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server数据库(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka数据库(包括消息队列Kafka版和自建Kafka)。
  • DataHub:阿里云流式数据服务DataHub。
  • clickhouse:云数据库 ClickHouse。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:表格存储Tablestore。
说明
DestinationEndpointRegion String cn-hangzhou

目标实例区域,详情请参见支持的地域列表

DestinationEndpointIP String 172.16.88.***

目标库的IP地址。

说明DestinationEndpointInstanceType取值为LocalInstanceECSExpressdgCEN时,本参数才可用且必须传入。
DestinationEndpointPort String 3306

目标实例的数据库服务端口。

说明DestinationEndpointInstanceType取值为 LocalInstanceECSExpressdgCEN时,本参数才可用且必须传入。
DestinationEndpointDataBaseName String dtstestdata

待迁入的数据库名称或鉴权数据库名称。

说明
  • DestinationEndpoint.EngineName取值为PostgreSQLDRDSMongoDB时,本参数才可用且必须传入。
  • DestinationEndpoint.EngineName取值为PostgreSQLDRDS时,传入待迁移的数据库名称;取值为MongoDB时,传入数据库账号的鉴权数据库名称。
DestinationEndpointUserName String dtstest

目标库的数据库账号。

说明 迁移或同步不同的数据库所需的权限有所差异,详情请参见DTS数据迁移方案概览DTS数据同步方案概览中对应的配置案例。
DestinationEndpointPassword String Test123456

目标库数据库账号密码。

Reserve String { "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }

DTS预留参数,格式为JSON串,您可以传入本参数实现特殊需求(例如是否自动启动预检查)。更多信息,请参见MigrationReserved参数说明

Checkpoint String 1610540493

增量数据迁移的启动位点或者同步位点,格式为Unix时间戳,单位为秒。

DestinationEndpointOracleSID String testsid

Oracle数据库的SID信息。

说明DestinationEndpointEngineName取值为Oracle,且Oracle数据库为非RAC实例时,本参数才可用且必须传入。
DtsJobId String l3m1213ye7l****

迁移、同步或订阅任务ID。

说明 本参数和参数DtsInstanceId两者中至少传入一个。
DtsInstanceId String dtsl3m1213ye7l****

迁移、同步或订阅实例ID。

说明 本参数和参数DtsJobId两者中至少传入一个。
DelayPhone String 1361234****,1371234****

延迟报警的联系人手机号码,多个手机号码以英文逗号(,)分隔。

说明
DelayRuleTime Long 10

触发延迟报警的阈值,单位为秒且需为整数,可根据业务需要设置阈值,建议设置10秒以上,避免因网络、数据库负载等原因导致的延迟波动。

说明DelayNotice取值为true时,本参数必须传入。
DelayNotice Boolean true

是否监控延迟状态,取值:

  • true:是。
  • false:否。
ErrorPhone String 1361234****,1371234****

异常报警的联系人手机号码,多个手机号码以英文逗号(,)分隔。

说明
ErrorNotice Boolean true

是否监控异常状态,取值:

  • true:是。
  • false:否。
SynchronizationDirection String Forward

同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明
  • 默认取值为Forward
  • 只有当同步任务的同步拓扑为双向时,本参数传入Reverse才会生效。

返回数据

名称 类型 示例值 描述
DtsInstanceId String dtsl3m1213ye7l****

迁移、同步或订阅实例ID。

DtsJobId String l3m1213ye7l****

迁移、同步或订阅任务ID。

ErrCode String InternalError

调用出错时返回的错误码。

ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。

HttpStatusCode String 200

状态码。

RequestId String 224DB9F7-3100-4899-AB9C-C938BCCB****

请求ID。

Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ConfigureDtsJob
&DataInitialization=true
&DataSynchronization=false
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DestinationEndpointInstanceType=RDS
&DtsJobName=RDS间迁移
&JobType=MIGRATION
&SourceEndpointInstanceType=RDS
&StructureInitialization=true
&<公共请求参数>

正常返回示例

XML格式

<ConfigureDtsJobResponse>
      <DtsJobId>l3m1213ye7l****</DtsJobId>
      <RequestId>224DB9F7-3100-4899-AB9C-C938BCCB****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <DtsInstanceId>dtsl3m1213ye7l****</DtsInstanceId>
      <Success>true</Success>
</ConfigureDtsJobResponse>

JSON格式

{
    "DtsJobId":"l3m1213ye7l****",
    "RequestId":"224DB9F7-3100-4899-AB9C-C938BCCB****",
    "HttpStatusCode":200,
    "DtsInstanceId":"dtsl3m1213ye7l****",
    "Success":true
}

错误码

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