配置DTS迁移、同步或校验任务

系统规定参数。取值：ConfigureDtsJob。

DTS实例名称。

源实例类型，取值：

• RDS：RDS MySQL、RDS SQL Server、RDS PostgreSQL、RDS MariaDB。
• PolarDB：PolarDB MySQL版。
• REDIS：云数据库Redis。
• DISTRIBUTED_POLARDBX10：PolarDB-X 1.0（原DRDS）。
• POLARDBX20：PolarDB-X 2.0。
• MONGODB：云数据库MongoDB。
• DISTRIBUTED_DMSLOGICDB：数据管理DMS逻辑库。

• OTHER：有公网IP的自建数据库。
• ECS：ECS上的自建数据库。
• EXPRESS：通过专线接入的自建数据库。
• CEN：通过云企业网CEN接入的自建数据库。
• DG：通过数据库网关接入的自建数据库。

源实例ID。

如源实例为阿里云数据库（如RDS MySQL），则您需要传入阿里云数据库的ID（如RDS MySQL的实例ID）。

如源实例为自建数据库，则根据SourceEndpointInstanceType的取值不同，本参数的取值有所变化，例如SourceEndpointInstanceType取值为：

• ECS，则该参数需传入ECS的实例ID。
• DG，则该参数需传入数据库网关ID。
• EXPRESS、CEN：则该参数需传入已和源库互联的VPC ID。

源实例的数据库类型。

• MYSQL：MySQL数据库（包括RDS MySQL和自建MySQL）。
• MARIADB：RDS MariaDB。
• PolarDB：PolarDB MySQL版。
• POLARDB_O：PolarDB PostgreSQL版（兼容Oracle）。
• POLARDBX10：PolarDB-X 1.0（原DRDS）。
• POLARDBX20：云原生分布式数据库PolarDB-X 2.0。
• ORACLE：自建Oracle。
• POSTGRESQL：PostgreSQL数据库（包括RDS PostgreSQL和自建PostgreSQL）。
• MSSQL：SQL Server数据库（包括RDS SQL Server和自建SQL Server）。
• MONGODB：MongoDB数据库（包括自建MongoDB和云数据库MongoDB）。
• DB2：自建DB2 LUW。
• AS400：自建Db2 for i。
• DMSPOLARDB：数据管理DMS逻辑库。
• HBASE：自建HBase数据库。
• TERADATA：Teradata数据库。
• TiDB：TiDB数据库。
• REDIS：Redis数据库（包括自建Redis和云数据库Redis）。

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

源实例的IP地址。

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

Oracle数据库的SID信息。

源实例中迁移对象所属的数据库名称。

源库的数据库账号。

源库数据库账号密码。

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

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

目标实例类型，取值：

• RDS：RDS MySQL、RDS SQLServer、RDS PostgreSQL、RDS MariaDB。
• PolarDB：PolarDB MySQL版。
• DISTRIBUTED_POLARDBX10：PolarDB-X 1.0（原DRDS）。
• POLARDBX20：PolarDB-X 2.0。
• REDIS：云数据库Redis。
• ADS：AnalyticDB MySQL 2.0、3.0。
• MONGODB：云数据库MongoDB。
• GREENPLUM：AnalyticDB PostgreSQL。
• DATAHUB：阿里云流数据处理平台DataHub。
• ELK：阿里云检索分析服务Elasticsearch。
• Tablestore：表格存储Tablestore。
• ODPS：MaxCompute。

• OTHER：有公网IP的自建数据库。
• ECS：ECS上的自建数据库。
• EXPRESS：通过专线接入的自建数据库。
• CEN：通过云企业网CEN接入的自建数据库。
• DG：通过数据库网关接入的自建数据库。

目标实例ID。

如目标实例为云数据库（如RDS MySQL），则您需要传入云数据库的实例ID（如RDS MySQL的实例ID）。

如目标实例为自建数据库，则根据DestinationEndpointInstanceType的取值不同，本参数的取值有所变化，例如DestinationEndpointInstanceType取值为：

• ECS，则该参数需传入ECS的实例ID。
• DG，则该参数需传入数据库网关ID。
• EXPRESS、CEN：则该参数需传入已和源库互联的VPC ID。

目标实例的数据库类型。

• MYSQL：MySQL数据库（包括RDS MySQL和自建MySQL）。
• MARIADB：RDS MariaDB。
• PolarDB：PolarDB MySQL版。
• POLARDB_O：PolarDB PostgreSQL版（兼容Oracle）。
• POLARDBX10：PolarDB-X 1.0（原DRDS）。
• POLARDBX20：云原生分布式数据库PolarDB-X 2.0。
• ORACLE：自建Oracle。
• PostgreSQL：PostgreSQL数据库（包括RDS PostgreSQL、自建PostgreSQL）。
• MSSQL：SQL Server数据库（包括RDS SQL Server和自建SQL Server）。
• ADS：AnalyticDB MySQL 2.0。
• ADB30：AnalyticDB MySQL 3.0。
• MONGODB：MongoDB数据库（包括自建MongoDB和云数据库MongoDB）。
• GREENPLUM：AnalyticDB PostgreSQL。
• KAFKA：Kafka数据库（包括消息队列Kafka版和自建Kafka）。
• DATAHUB：阿里云流式数据服务DataHub。
• DB2：自建DB2 LUW。
• AS400：Db2 for i。
• ODPS：MaxCompute。
• Tablestore：表格存储Tablestore。
• ELK：阿里云检索分析服务Elasticsearch。
• REDIS：Redis数据库（包括自建Redis和云数据库Redis）。

目标实例区域，请参见支持的地域列表。

目标实例的IP地址。

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

目标实例中迁移对象所属的数据库名称。

目标库的数据库账号。

目标库数据库账号密码。

目标RDS MySQL实例所属的阿里云账号ID。

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

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

• true：是，为默认值。
• false：否。

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

• true：是，为默认值。
• false：否。

是否执行增量数据迁移或同步，取值：

• false：否，为默认值。
• true：是。

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

DTS预留参数，格式为JSON字符串，您可以传入本参数完善源目库信息（如目标Kafka数据库的数据存储格式、云企业网CEN的实例ID）。更多信息，请参见Reserve参数说明。

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

Oracle数据库的SID信息。

任务类型，取值为：

• MIGRATION：数据迁移。
• SYNC：数据同步。
• CHECK：数据校验（单独购买）。

迁移或同步任务ID。

迁移或同步实例ID。

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

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

是否监控延迟状态，取值：

• true：是。
• false：否。

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

是否监控异常状态，取值：

• true：是。
• false：否。

同步方向，取值：

• Forward：正向。
• Reverse：反向。

DTS实例所属的地域，请参见支持的地域列表。

DTS专属集群ID。

任务文件的OSS地址。

数据校验任务的参数，格式为JSON字符串，如参数限制或告警配置等信息。更多信息请参见DataCheckConfigure参数说明。

是否为灾备实例，取值：

• true：是。
• false：否。

数据投递链路交换机实例ID。

DTS实例的环境标签，取值为：

• normal：普通
• online：线上

源库通过SSL安全连接时，CA证书的路径。

源库通过SSL安全连接时，CA证书的密钥。

目标库通过SSL安全连接时，CA证书的路径。

目标库通过SSL安全连接时，CA证书的密钥。

DU下限。

DU上限。

源库通过SSL安全连接时，客户端证书的路径。

源库通过SSL安全连接时，客户端证书私钥的路径。

源库通过SSL安全连接时，客户端证书私钥的密码。

目标库通过SSL安全连接时，客户端证书的路径。

目标库通过SSL安全连接时，客户端证书私钥的路径。

目标库通过SSL安全连接时，客户端证书私钥的密码。

资源组ID。

状态码。

请求ID。

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

迁移或同步任务ID。

迁移或同步实例ID。

请求是否成功。

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