本文汇总数据库传输服务 DTS 的 API 接口中使用的数据结构定义详情。 ## AccountMapping 账号信息。在 `TaskType` 取值为 `DataMigration` 或 `DataSynchronization`、`ProgressType` 取值为 `Account` 时，可设置的参数信息。被以下接口引用： * MySQL2MySQLSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Account |String |是 |待迁移的账号名称。 |test\*\*\*\* | |ResetPassword |Bool |否 |是否重置密码，取值如下：

* `true`：表示重置新密码。

* `false`：表示不重置新密码。默认值。 |true | |Password |String |否 |待迁移账号的新密码。 |\*Test\*\*\*\* | ## AccountProgressItem 任务中用户迁移进度。被以下接口引用： * TaskProgress |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |Account |String |账号名称。 |test\*\*\*\* | |StartTime |Long |用户迁移的开始时间，毫秒时间戳。 |0 | |FinishTime |Long |用户迁移的结束时间，毫秒时间戳。 |1679300319338820 | |Statement |String |需要传输的 SQL 语句。取值如下：

* `StmtDMLInsert`

* `StmtDMLUpdate`

* `StmtDMLDelete`

* `StmtDDLAll`

* `StmtDDLAlterTable`

* `StmtDDLAlterView`

* `StmtDDLCreateFunction`

* `StmtDDLCreateIndex`

* `StmtDDLCreateProcedure`

* `StmtDDLCreateTable`

* `StmtDDLCreateView`

* `StmtDDLDropIndex`

* `StmtDDLDropTable`

* `StmtDDLDropFunction`

* `StmtDDLDropProcedure`

* `StmtDDLTruncateTable`

* `StmtDDLRenameTable`

* `StmtDDLDropView` |StmtDDLAll | |state |String |单个任务传输状态。取值如下：

* `None`：表示任务待启动。

* `Transmitting`：表示任务传输中。

* `Completed`：表示任务已完成。

* `Removed`：表示任务传输失败。 |None | |type |String |用户迁移的类型，取值如下：

* `Account`：表示迁移账号。

* `Privileges`：表示迁移账号权限。 |Account | ## AccountTransmissionSettings 将源库中指定的非系统账号及账号所拥有的权限迁移到目标库的详细信息。被以下接口引用： * MySQL2MySQLSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |EnableAccount |Bool |否 |是否开启用户迁移。取值如下：

* `true`：表示开启。

* `false`：表示不开启。 |false | ## BuiltinKafkaSettings 在 `EndpointType` 取值为 `Builtin_Kafka` 时，目标库的信息。被以下接口引用： * DataSource |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Brokers |Array of String |是 |Broker 的 IP 地址及端口号，格式为 `host:port`。 |[

"100.67.158.158:9092",

"100.67.158.158:9192",

"100.67.158.158:9292",

"100.67.158.158:9392",

"100.67.158.158:9492"

] | |Topic |String |是 |Kafka 的 Topic ID。 |6f2fd63c0ea947b280877f5d2a\*\*\*\*\*\* | ## ChargeConfig 计费的配置信息。被以下接口和结构体引用： * CreateTransmissionTask * TaskInfo |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ChargeType |String |否 |计费类型，取值如下：

* `NotEnabled`：表示未开启计费。

* `PostPaid`：表示按量付费。

* `PrePaid`：表示包年包月。 |PrePaid | |Times |Integer |否 |购买时长。

> **说明**

> 在 `ChargeType` 取值为 `PrePaid` 时，支持此配置。
|12 | |AutoRenew |Bool |否 |是否自动续费，取值如下：

* `true`：表示自动续费。

* `false`：表示不自动续费，默认值。 |true | |OneStep |Bool |否 |是否立即付费，取值如下：

* `true`：表示立即付费。

* `false`：表示不立即付费，默认值。 |false | ## ChargeDetailObject 计费的详细信息。被以下结构体引用： * TaskInfo |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |ChargeStartTime |Long |任务开始计费的时间，毫秒时间戳。 |1668569330000 | |ChargeStatus |String |任务订单状态。取值如下：

* `Init`：任务订单待启动。

* `Normal`：任务订单状态正常。

* `Overdue`：任务订单已过期。

* `Unpaid`：任务订单未支付。 |Normal | |ChargeType |String |计费类型，取值如下：

* `NotEnabled`：表示未开启计费。

* `PostPaid`：表示按量付费。

* `PrePaid`：表示包年包月。 |Postpaid | |OrderNo |Integer |计费订单 ID。 |Order7166450525830\*\*\*\*\*\* | ## Check |**名称** |**类型** |**描述** |**示例值** | |---|---|---|---| |Pass |Bool |检查项是否通过，取值如下：

* `true`：表示预检查项通过。

* `false`：表示预检查项未通过。 |true | |Level |String |预检查项未通过时，预检查项的等级，取值如下：

* `Error`：表示在预检查项的等级为若不通过则预检查不通过。

* `Warning`：若不通过则不影响整个预检查是否通过。 |Error | |Name |String |检查项的名称。 |运行环境检测 | |Desc |String |检查项的描述。 |运行环境检测 | |Details |String |检查项结果的详情信息。 |连接或展开通配符失败，请检查连通性或重试 | ## ConvertPostPaidToPrePaid |**名称** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Times |Integer |是 |包年包月的购买时长，支持 `1`、`2`、`3`、`4`、`5`、`6`、`7`、`8`、`9`、`12`、`24` 和 `36` 取值，单位：月。 |3 | |AutoRenew |Bool |否 |包年包月到期后是否自动续费，取值如下：

* `true`：表示自动续费。

* `false`：表示不自动续费，默认值。 |true | ## CrossAccountObject |**参数名** |**类型** |**是否必填** |**描述** | |---|---|---|---| |SourceAccount |string |是 |源端账号 ID。 | |Role |string |是 |通过源端账号创建的用于传输数据的角色名称。 | ## DataSource 源库或目标库的详细信息。被以下接口和结构体引用： * CreateTransmissionTask * ModifyTransmissionTask * TaskInfo |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |Category |String |MySQL |实例的类型，取值如下：

* `MySQL`：表示实例类型为 MySQL。

* `PostgreSQL`：表示实例类型为 PostgreSQL。

* `ElasticSearch`：表示实例类型为 ElasticSearch。

* `MongoDB`：表示实例类型为 MongoDB。

* `Redis`：表示实例类型为 Redis。 | |CreateTime |Long |1734070854504 |源端或目标端实例的创建时间，使用毫秒时间戳格式。 | |DataSourceId |Integer |1867454442941460510 |源端或目标端实例 ID。 | |ModifyTime |Integer |1734070873088 |源端或目标端实例的修改时间。 | |EndpointType |String |是 |实例的接入方式，取值如下：

* `Volc_MySQL`：表示火山引擎版 MySQL。

* `Volc_veDB_MySQL`：表示火山引擎版 veDB MySQL。

* `Volc_PostgreSQL`：表示火山引擎版 PostgreSQL。

* `Volc_Mongo`：表示火山引擎版 MongoDB。

* `Volc_ElasticSearch`：表示火山引擎版 ElasticSearch。

* `Volc_Kafka`：表示消息队列 Kafka 版。

* `Volc_RocketMQ`：表示消息队列 RocketMQ 版。

* `Volc_Redis`：表示火山引擎版 Redis。

* `Public_MySQL`：表示公有网络 MySQL。

* `Public_PostgreSQL`：表示公有网络 PostgreSQL。

* `Public_Mongo`：表示公有网络 MongoDB。

* `Public_ElasticSearch`：表示公有网络 ElasticSearch。

* `Public_Redis`：表示公有网络 Redis。

* `Builtin_Kafka`：表示内置中间件。

* `Express_MySQL`：表示专有网络 MySQL。

* `Express_PostgreSQL`：表示专有网络 PostgreSQL。

* `Express_Mongo`：表示专有网络 MongoDB。

* `Express_Redis`：表示专有网络 Redis。

* `Express_Kafka`：表示专有网络 Kafka。

* `Express_ElasticSearch`：表示专有网络 ElasticSearch。 | |VolcMySQLSettings |[VolcMySQLSettings](https://docs.volcengine.com/docs/6390/76140#volcmysqlsettings) |否 |表示接入方式为火山引擎版 MySQL 的源库或目标库信息。在 `EndpointType` 取值为 `Volc_MySQL` 时，该参数必选。 | |VolcveDBMySQLSettings |[VolcveDBMySQLSettings](https://docs.volcengine.com/docs/6390/76140#volcvedbmysqlsettings) |否 |表示接入方式为火山引擎版 veDB MySQL 的源库或目标库信息。在 `EndpointType` 取值为 `Volc_veDB_MySQL` 时，该参数必选。 | |VolcPostgreSQLSettings |[VolcPostgreSQLSettings](https://docs.volcengine.com/docs/6390/76140#volcpostgresqlsettings) |否 |表示接入方式为火山引擎版 PostgreSQL 的源库或目标库的信息。在 `EndpointType` 取值为 `Volc_PostgreSQL` 时，该参数必选。 | |VolcMongoSettings |[VolcMongoSettings](https://docs.volcengine.com/docs/6390/76140#volcmongosettings) |否 |表示接入方式为火山引擎版 MongoDB 的源库或目标库的信息。在 `EndpointType` 取值为 `Volc_Mongo` 时，该参数必选。 | |VolcElasticSearchSettings |[VolcElasticSearchSettings](https://docs.volcengine.com/docs/6390/76140#volcelasticsearchsettings) |否 |表示接入方式为火山引擎版 ElasticSearch 的目标库的信息。在 `EndpointType` 取值为 `Volc_ElasticSearch` 时，该参数必选。 | |VolcKafkaSettings |[VolcKafkaSettings](https://docs.volcengine.com/docs/6390/76140#volckafkasettings) |否 |表示接入方式为火山引擎版 Kafka 的目标库的信息。在 `EndpointType` 取值为 `Volc_Kafka` 时，该参数必选。 | |VolcRocketMQSettings |[VolcRocketMQSettings](https://docs.volcengine.com/docs/6390/76140#volcrocketmqsettings) |否 |表示接入方式为火山引擎版 RocketMQ 的目标库的信息。在 `EndpointType` 取值为 `Volc_RocketMQ` 时，该参数必选。 | |VolcRedisSettings |[VolcRedisSettings](https://docs.volcengine.com/docs/6390/76140#volcredissettings) |否 |表示接入方式为火山引擎版 Redis 的目标库的信息。在 `EndpointType` 取值为 `Volc_Redis` 时，该参数必选。 | |PublicMySQLSettings |[PublicMySQLSettings](https://docs.volcengine.com/docs/6390/76140#publicmysqlsettings) |否 |表示接入方式为公有网络 MySQL 的源库或目标库的信息。在 `EndpointType` 取值为 `Public_MySQL` 时，该参数必选。 | |PublicPostgreSQLSettings |[PublicPostgreSQLSettings](https://docs.volcengine.com/docs/6390/76140#publicpostgresqlsettings) |否 |表示接入方式为公有网络 PostgreSQL 的源库或目标库的信息。在 `EndpointType` 取值为 `Public_PostgreSQL` 时，该参数必选。 | |PublicMongoSettings |[PublicMongoSettings](https://docs.volcengine.com/docs/6390/76140#publicmongosettings) |否 |表示接入方式为公有网络 MongoDB 的源库或目标库的信息。在 `EndpointType` 取值为 `Public_Mongo` 时，该参数必选。 | |PublicElasticSearchSettings |[PublicElasticSearchSettings](https://docs.volcengine.com/docs/6390/76140#publicelasticsearchsettings) |否 |表示接入方式为公有网络 ElasticSearch 的源库或目标库的信息。在 `EndpointType` 取值为 `Public_ElasticSearch` 时，该参数必选。 | |PublicRedisSettings |[PublicRedisSettings](https://docs.volcengine.com/docs/6390/76140#publicredissettings) |否 |表示接入方式为公有网络 Redis 的源库或目标库的信息。在 `EndpointType` 取值为 `Public_Redis` 时，该参数必选。 | |BuiltinKafkaSettings |[BuiltinKafkaSettings](https://docs.volcengine.com/docs/6390/76140#builtinkafkasettings) |否 |表示在数据订阅任务中，将数据订阅到内置中间件的参数信息。在 `EndpointType` 取值为 `Builtin_Kafka` 时，该参数必选。 | |Express_Mongo |[ExpressMongoSettings](https://docs.volcengine.com/docs/6390/76140#expressmongosettings) |否 |表示接入方式为专有网络 MongoDB 的源库或目标库的信息。在 `EndpointType` 取值为 `Express_Mongo` 时，该参数必选。 | |Express_MySQL |[ExpressMySQLSettings](https://docs.volcengine.com/docs/6390/76140#expressmysqlsettings) |否 |表示接入方式为专有网络 MySQL 的源库或目标库的信息。在 `EndpointType` 取值为 `Express_MySQL` 时，该参数必选。 | |Express_PostgreSQL |[ExpressPostgreSQLSettings](https://docs.volcengine.com/docs/6390/76140#expresspostgresqlsettings) |否 |表示接入方式为专有网络 PostgreSQL 的源库或目标库的信息。在 `EndpointType` 取值为 `Express_PostgreSQL` 时，该参数必选。 | |Express_Redis |[ExpressRedisSettings](https://docs.volcengine.com/docs/6390/76140#expressredissettings) |否 |表示接入方式为专有网络 Redis 的源库或目标库的信息，在 `EndpointType` 取值为 `Express_Redis` 时，该参数必选。 | |ExpressElasticSearchSettings |[ExpressElasticSearchSettings](https://docs.volcengine.com/docs/6390/76140#expresselasticsearchsettings) |否 |表示接入方式为专有网络 ElasticSearch 的源库或目标库信息。在 `EndpointType` 取值为 `Express_ElasticSearch` 时，该参数必选。 | |ExpressKafkaSettings |[ExpressKafkaSettings](https://docs.volcengine.com/docs/6390/76140#expresskafkasettings) |否 |表示接入方式为专有网络 Kafka 的源库或目标库信息。在 `EndpointType` 取值为 `Express_Kafka` 时，该参数必选。 | |Categories |String |否 |数据库类型。取值如下：

* `MySQL`：表示数据源的数据库类型为 MySQL。

* `MongoDB`：表示数据源的数据库类型为 MongoDB。

* `Redis`：表示数据源的数据库类型为 Redis。

* `PostgreSQL`：表示数据源的数据库类型为 PostgreSQL。

* `Elasticsearch`：表示数据源的数据库类型为 Elasticsearch。

* `Kafka`：表示数据源的数据库类型为 Kafka。

* `RocketMQ`：表示数据源的数据库类型为 RocketMQ。 | |Name |String |是 |数据源的任务名称。在调用 CreateDataSource 接口创建数据源时需要配置该参数。 | |CreateTime |Long |\- |数据源的创建时间。毫秒时间戳。 | |ModifyTime |Long |\- |最近一次更新数据源的时间。毫秒时间戳。 | ## ErrorBehaviorSettings 错误重试时间。当源库或目标库断连后，若能在该时间内重新连上，任务即可自动恢复。被以下结构体引用： * MySQL2MySQLSettings * MySQL2ESSettings * MySQL2KafkaSettings * MySQL2RocketMQSettings * PG2PGSettings * PG2KafkaSettings * PG2RocketMQSettings * Mongo2MongoSettings * Redis2RedisSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |MaxRetrySeconds |Integer |否 |最大错误重试时间。取值范围：600~86400，单位：秒(s)。默认值为 600 秒。 |600 | ## ESExtraArgs 在同步至 ElasticSearch 时的参数信息。被以下结构体引用： * MySQL2ESSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |IdxNameRule |String |否 |索引拼接规则。

* `Table`：表示使用表名拼接方式。

* `DBAndTable`：表示使用库名+表名的拼接方式。 |Table | |ShardNum |Integer |否 |分片数。 |3 | |ReplicaNum |Integer |否 |副本数。 |1 | |TZ |String |否 |时区。支持 UTC \-12:00 ~ +13:00。默认值为 Region 所在的 TimeZone。 |UTC +08:00 | |RetryTimes |Integer |否 |错误重试时间。 |7200 | |Analyzer |String |否 |支持的分词器。 |standard | |InsertMode |String |否 |源端的插入操作，取值如下：

* `Replace`：表示在目标端不存在对应索引时，则插入一条新数据，在目标端存在对应索引时，则更新对应的索引。

* `Update`：表示在目标端不存在对应索引时，则跳过。在目标端存在对应索引时，则更新对应数据。 |Replace | ## ESMetaMappingSetting ElasticSearch 的结构映射参数。被以下结构体引用： * ObjectMappingSetting |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |PidCol |Array of String |否 |主键（_id）取值。当不设置此参数时，默认为主键的列。 |["id", "name"] | |EnableRouting |Bool |否 |是否启用 Routing，取值如下：

* `true`：表示启用 Routing。

* `false`：表示不启用 Routing。 |EnableRouting | |RoutingCol |Array of String |否 |_routing 的取值。当 `EnableRouting` 取值为 `true` 时，该参数必选。 |["id"] | ## ETLSettings ETL 参数的详细信息。被以下结构体引用： * MySQL2MySQLSettings * MySQL2ESSettings * MySQL2KafkaSettings * MySQL2RocketMQSettings * PG2PGSettings * PG2KafkaSettings * PG2RocketMQSettings * Mongo2MongoSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Script |String |否 |流式数据 ETL 的脚本。关于脚本依赖的语法信息，请参见 [DSL 语法](https://docs.volcengine.com/docs/6390/141464)。 |```json```
```(defn desensitization []```
``` (dts/match-table "user" (dts/map-column 'id_card str/md5)))```
| ## ExpressElasticSearchSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Endpoints |Array of String |是 |专有网络 ElasticSearch 实例的主机地址。 |[192.168.\*\*\* *.\*\*\** ] | |Username |String |是 |专有网络 ElasticSearch 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 ElasticSearch 实例的数据库账号密码。 |Admin@\*\*\* | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) | ## ExpressKafkaSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |BrokerEndpoints |Array of String |是 |专有网络 Kafka 实例 Broker 的 IP 地址及端口号，格式为 `host1:port1`。当存在多个 Broker 时，需使用英文逗号（,）隔开。 |[10.1.\*\*\*.\*\*\*:9093] | |AuthType |String |是 |认证方式，默认取值 `plain`。 |plain | |Username |String |是 |专有网络 Kafka 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 Kafka 实例的数据库账号密码。 |Admin@\*\*\* | |Topic |String |是 |专有网络 Kafka 实例的 Topic 信息。 |dts_sydtest | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) | ## ExpressMongoSettings 在 `EndpointType` 取值为 `Express_Mongo`（即专有网络 MongoDB）时，源库或目标库的信息。被以下接口或结构体引用： * DataSource |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |RegionSettings |RegionSetting |否 |实例所属地域。 |RegionSetting | |DeployType |String |是 |实例的实例类型。取值如下：

* `Standalone`：表示单节点。

* `ReplicaSet`：表示副本集。

* `ShardedCluster`：表示分片集群。 |ShardedCluster | |PullMethod |string |是 |源端增量获取方式。取值如下：

* `ChangeStream`：该获取方式提供从数据集（数据库、集合或管道）中获取特定类型已修改数据的改变事件的方法。例如插入、更新或删除事件。如果选择该获取方式，那么实例的版本需大于等于 3.6。

* `Oplog`：该获取方式表示直接获取 MongoD 操作日志。对于 MongoDB 分片集，选择该获取方式后需要填写所有分片地址。该方式相较于 ChangeStream 能提供更好的同步性能。

* `None`：选择 None 后无法选择增量迁移，只能选择全量迁移。

> **说明**

> 当 `DeployType` 参数取值为 `ShardedCluster` 时，需设置该参数信息。
|ChangeStream | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |cn\-beijing | |> **说明**

> 当 `DeployType` 参数取值为 `Standalone`、`Replicaset` 或 `DeployType` 参数设置为 `ShardedCluster` 且 `PullMethod` 参数设置为 `ChangeStream` 或 `None` 时，需设置以下参数信息。
||||| |Endpoints |Array of String |是 |专有网络 MongoDB 实例的主机地址，格式为 `Host:port`。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。 |192.168.\*\*\*.\*\*\*:4 | |Username |String |是 |专有网络 MongoDB 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 MongoDB 实例的数据库账号密码。 |Admin@\*\*\* | |MongoAuthSourceDB |String |是 |账号校验数据库。 |ReplicaSet | |> **说明**

> 当 `DeployType` 参数取值为 `ShardedCluster` 且 `PullMethod` 参数设置为 `oplog` 时，需设置以下参数信息。
||||| |Shards |Array of [MongoShardSetting](https://docs.volcengine.com/docs/6390/76140#mongoshardsetting) |否 |分片地址信息。

> **说明**

> 作为返回参数时，则不返回该参数的相关信息。
|[MongoShardSetting](https://docs.volcengine.com/docs/6390/76140#mongoshardsetting) | |UseNewShardingDatasource |Bool |是 |是否选择使用新版分片接入方式，取值如下：

* `false`：表示不使用新版分片接入方式。

* `true`：表示使用新版分片接入方式。部署类型为分片集场景时为默认值。 |true | |Endpoints |Array of String |是 |mongos 地址，格式为 `host:port`。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。 |192.168.\*\*\*.\*\*\*:4 | |Username |String |是 |mongos 数据库账号。 |test\*\*\*\* | |Password |String |是 |mongos 的数据库密码。 |test\*\*\*\* | |MongoAuthSourceDB |String |是 |mongos 的账号校验数据库名称。 |admin | ## ExpressMySQLSettings 在 `EndpointType` 取值为 `Express_MySQL`（即专有网络 MySQL ）时，源库或目标库的信息。被以下接口或结构体引用： * DataSource |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Host |String |是 |专有网络 MySQL 实例的主机地址。 |192.168.\*\*\* *.\*\*\** | |Port |Integer |是 |专有网络 MySQL 实例的端口。 |4 | |Username |String |是 |专有网络 MySQL 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 MySQL 实例的数据库账号密码。 |Admin@\*\*\* | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) | ## ExpressPostgreSQLSettings 在 `EndpointType` 取值为 `Express_PostgreSQL`（即专有网络 PostgreSQL）时，源库或目标库的信息。被以下接口或结构体引用： * DataSource |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Host |String |是 |专有网络 PostgreSQL 实例的主机地址。 |192.168.\*\*\* *.\*\*\** | |Port |Integer |是 |专有网络 PostgreSQL 实例的端口。 |4 | |Username |String |是 |专有网络 PostgreSQL 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 PostgreSQL 实例的数据库账号密码。 |Admin@\*\*\* | |DBName |String |是 |数据库名称。 |test\*\*\*\* | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) | ## ExpressRedisSettings 在 `EndpointType` 取值为 `Express_Redis`（即专有网络 Redis）时，源库或目标库的信息。被以下接口或结构体引用： * DataSource |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ArchType |String |是 |架构类型，取值如下：

* `Standalone`：单机版。

* `Cluster`：集群版。

> **说明**

> 如果专有网络 Redis 实例的集群有 Proxy 服务，那么 `ArchType` 需要设置为 `Standalone`。
|Standalone | |Host |String |是 |专有网络 Redis 实例实例的主机地址。

> **说明**

> 当参数 `ArchType` 设置为 `Standalone` 时，需设置该参数。
|192.168.\*\*\*.\*\*\* | |Port |Integer |是 |专有网络 Redis 实例的端口。

> **说明**

> 当参数 `ArchType` 设置为 `Standalone` 时，需设置该参数。
|4 | |Endpoints |Array of String |是 |请输入专线打通的私有网络内 Redis 集群各分片主节点的 `IP:端口`，以英文逗号分隔，例如：`ip1:port1,ip2:port2,ip3:port3`。

> **说明**

> 当参数 `ArchType` 设置为 `Cluster` 时，需设置该参数。
|10.10.10.10:3717 | |PrivateNetworkSettings |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) |是 |私有网络的配置信息。 |[PrivateNetworkSetting](https://docs.volcengine.com/docs/6390/76140#privatenetworksetting) | |RegionSettings |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) |是 |地域 ID。 |[RegionSetting](https://docs.volcengine.com/docs/6390/76140#regionsetting) | |Username |String |是 |专有网络 Redis 实例的数据库账号。 |test\*\*\* | |Password |String |是 |专有网络 Redis 实例的数据库账号密码。

> **说明**

> 当参数 `ArchType` 设置为 `Cluster` 时，多个分片的密码需一致，否则无法成功连接。
|Admin@\*\*\* | ## FullExtraCondition 全量过滤信息。被以下结构体引用： * FullTransmissionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Db |String |否 |需要过滤的数据库名称。 |TestName | |Table |String |否 |需要过滤的表格名称。 |TableName | |WhereSql |String |否 |过滤的 SQL 语句。 |id = 5 | ## FullProgressItem 任务中全量迁移、全量订阅或全量初始化进度。被以下结构体引用： * TaskProgress |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |Database |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |数据库信息。 |{

"DestObjName": "test\*\*\*\*1",

"ObjectType": "Database",

"SrcObjName": "test\*\*\*\*1"

} | |Object |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |源端和目标端的库表映射对象。 |{

"DestObjName": "auth_operation",

"ObjectType": "Table",

"SrcObjName": "auth_operation"

} | |StartTime |Long |开始进行全量迁移、订阅或初始化的时间，毫秒时间戳。 |1679300366000 | |FinishTime |Long |全量迁移、订阅或初始化的结束时间，毫秒时间戳。 |1679300366000 | |TransferRows |Integer |传输行数。 |0 | |TransferBytes |Integer |传输字节数。 |0 | |TransferEstimateRows |Integer |预估行数。 |0 | |State |String |任务传输状态。取值如下：

* `None`：表示任务待启动。

* `Transmitting`：表示任务传输中。

* `Completed`：表示任务已完成。

* `Removed`：表示任务传输失败。 |Completed | |ShardID |String |分片 ID。 |0 | |RowAvgBytes |Integer |行平均大小。 |0 | |TransferEstimateBytes |Integer |预估总的传输数据量。 |0 | ## FullTransmissionSettings 全量读取源表内容并写到对应的目标库的详细信息。被以下结构体引用： * MySQL2MySQLSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |EnableFull |Bool |否 |是否开启全量迁移、全量订阅或全量初始化。取值如下：

* `true`：表示开启。

* `false`：表示不开启，默认值。 |true | |Snapshot |Bool |否 |是否开启全量一致性迁移。取值如下：

* `true`：表示开启。

* `false`：表示不开启，默认值。 |true | |ExtraConditions |Array of FullExtraCondition |否 |全量过滤条件。 |[FullExtraCondition](https://docs.volcengine.com/docs/6390/76140#fullextracondition) | |RPSLimit |Integer |否 |每秒迁移或同步的行数，取值范围为 1~100000，默认值为 100000。 |100000 | |BPSLimit |Integer |否 |每秒迁移或同步的数据量，取值范围 1~25000，单位 KB，默认值为 25000。 |25000 | |FullSyncParalell |Integer |否 |迁移或同步任务的并发数。默认值 8，取值范围 8~64。 |8 | ## IncrProgressItem 任务中增量迁移、增量订阅或增量初始化。被以下结构体引用： * TaskProgress |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |Database |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |数据库信息。 |{

"DestObjName": "test\*\*\*\*",

"ObjectType": "Database",

"SrcObjName": "test\*\*\*\*"

} | |Object |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |源端和目标端的库表映射对象。 |{

"DestObjName": "test\*\*\*\*",

"ObjectType": "Database",

"SrcObjName": "test\*\*\*\*"

} | |TransferRows |Integer |传输行数。 |0 | |TransferBytes |Integer |传输字节数。 |0 | |ShardID |String |分片 ID。 |0 | |State |String |任务传输状态。取值如下：

* `None`：表示任务待启动。

* `Transmitting`：表示任务传输中。

* `Completed`：表示任务已完成。

* `Removed`：表示任务传输失败。 |Completed | |LatencySeconds |Integer |延迟时间，单位：秒（s）。 |0 | ## IncrTransmissionSettings 目标库增量日志解析和回放的详细信息。被以下结构体引用： * MySQL2MySQLSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |EnableIncr |Bool |否 |是否开启增量迁移、增量订阅或增量同步。取值如下：

* `true`：表示开启。

* `false`：表示不开启，默认值。

> **说明**

> 当 `TaskType` 取值为 `DataSynchronization` 时，该参数必填。
|true | |Statements |String |否 |需要传输的操作语句。取值如下：

* `StmtDMLInsert`

* `StmtDMLUpdate`

* `StmtDMLDelete`

* `StmtDDLAll`

* `StmtDDLAlterTable`

* `StmtDDLAlterView`

* `StmtDDLCreateFunction`

* `StmtDDLCreateIndex`

* `StmtDDLCreateProcedure`

* `StmtDDLCreateTable`

* `StmtDDLCreateView`

* `StmtDDLDropIndex`

* `StmtDDLDropTable`

* `StmtDDLDropFunction`

* `StmtDDLDropProcedure`

* `StmtDDLTruncateTable`

* `StmtDDLRenameTable`

* `StmtDDLDropView` |[

"StmtDDLAll",

"StmtDMLDelete",

"StmtDMLUpdate",

"StmtDMLInsert"

] | ## Info > **说明** > 当调用 DescribeValidationTasks 接口查询数据校验任务时，不返回该数据结构。传输任务总进度信息。被以下结构体引用： * ProgressSummary |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |ErrorInfo |String |任务报错信息。 |mysql endpoint error: dial tcp 172.17.46.117:3306: i/o timeout | |NameCN |String |任务进度的类型。 |增量订阅 | |ProgressType |String |任务类型。取值如下：

* `Account`：表示用户迁移。

* `Meta`：表示结构迁移、库表结构订阅或结构初始化。

* `Full`：表示全量迁移、全量订阅或全量初始化。

* `Incr`：表示增量迁移、增量订阅或增量同步。

* `PostMeta`：表示后置结构迁移。 |Incr | |Status |String |任务状态。取值如下：

* `Doing`：表示校验任务正在进行中。

* `Todo`：表示校验任务待进行。

* `Done`：表示校验任务已完成。 |Doing | ## MappingList 传输任务对象。被以下结构体引用： * ObjectMappings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |DestObjName |String |是 |目标端对象名称。 |test\*\*\*\* | |ObjectType |String |是 |对象类型。取值如下：

* `Database`：表示数据库。

* `Table`：表示表格。

* `View`：表示视图。

* `Column`：表示列。

* `Function`：表示函数。

* `Procedure`：表示程序。

* `Trigger`：表示触发器。

* `Type`：表示类型。

* `Domain`：表示域名。

* `Sequence`：表示序列。

* `Rule`：表示规则。

* `Operator`：表示操作符。

* `Aggregate`：表示聚合。

* `Extension`：表示扩展。

* `Constraint`：表示约束。

* `PostSequence`：表示 PostgreSQL 的序列。

* `Schema`：表示模式。

* `Event`：表示事件。

* `DomainConstraint`：表示域约束。 |Table | |SrcObjName |String |是 |源端对象名称。 |zaizai | ## MetaProgressItem 任务中结构迁移、库表结构订阅或结构初始化进度。被以下结构体引用： * TaskProgress |**参数** |**类型** |**描述** |**示例值** | |---|---|---|---| |Database |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |数据库信息。 |{

"DestObjName": "test\*\*\*\*",

"ObjectType": "Database",

"SrcObjName": "test\*\*\*\*"

} | |Object |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) |源端和目标端的库表映射对象。 |{

"DestObjName": "test\*\*\*\*",

"ObjectType": "Database",

"SrcObjName": "test\*\*\*\*"

} | |StartTime |Long |开始进行库表结构迁移、订阅或初始化的时间，毫秒时间戳。 |0 | |FinishTime |Long |库表结构迁移、订阅或初始化的结束时间，毫秒时间戳。 |1679300319338837 | |Ddl |String |创建库表结构的操作语句。 |\nCREATE DATABASE `test****` /\*!40100 DEFAULT CHARACTER SET utf8 \*/ | |State |String |任务传输状态。取值如下：

* `None`：表示任务待启动。

* `Transmitting`：表示任务传输中。

* `Completed`：表示任务已完成。

* `Removed`：表示任务传输失败。 |Completed | ## MetaTransmissionSettings 读取源库表结构定义语法，重新组装成目标库的语法格式的详细信息。被以下结构体引用： * MySQL2MySQLSettings * MySQL2ESSettings * MySQL2KafkaSettings * MySQL2RocketMQSettings * PG2PGSettings * PG2KafkaSettings * PG2RocketMQSettings * Mongo2MongoSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |EnableMeta |Bool |否 |是否开启库表结构迁移或订阅。取值如下：

* `true`：表示开启。

* `false`：表示不开启。 |true | |DisablePostMeta |Bool |否 |当 PostgreSQL 数据库迁移/同步类型中选择结构迁移/结构初始化时，DTS 会自动在增量迁移/同步结束后迁移/同步后置结构，您也可以选择跳过后置结构迁移/同步，即 DTS 不迁移/同步后置结构。

PostgreSQL 数据库后置结构/同步迁移对象包括普通触发器、事件触发器、RULE、互斥约束、外键约束、检查约束、Domain 约束、设置 Sequence 值。

是否跳过 PostgreSQL 后置结构迁移或后置结构同步。取值如下：

* `true`：表示跳过 PostgreSQL 后置结构迁移或后置结构同步。

* `false`：表示不跳过 PostgreSQL 后置结构迁移或后置结构同步。 |true | ## MigrationAssessmentProgress 评估迁移任务进度。被以下结构体引用： * TaskProgress |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Category |String |BasicInfo |评估类别。 | |ItemCode |String |DBVersion |评估项的唯一标识。 | |ItemName |String |源实例和目标实例版本 |评估项的名称。 | |Description |String |是否支持源版本向目标版本迁移 |评估项的描述信息。 | |ResultInfo |Json |

```JSON```
```{\"ResultCode\":\"Success\",\"SrcDBVersion\":\"5.6.51\",\"DstDBVersion\":\"5.7.32-log\"}```

|评估结果的详细信息。 | |Status |String |Success |评估项的状态。取值如下：

* `Success`：通过

* `Warn`：提示

* `Failed`：不通过 | |StatusDesc |String |源端：5.6.51，目标端：5.7.32\-log |评估结果的说明。 | |IsLast |Bool |false |是否为最后一个评估项。

* `true`：表示这是最后一个评估项。

* `false`：表示这不是最后一个评估项。 | |Suggestion |String | |评估后给出的优化建议。

> **说明**

> 当 `Status` 的取值为 `Success` 时，`Suggestion` 内容为空。
| ## ModifyInstanceSpecReq 任务链路规格信息。被以下接口引用： * [ModifyInstanceOrder](https://docs.volcengine.com/docs/6390/913081) |**名称** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |TrafficSpec |String |否 |任务链路规格。支持 `Compact` 、`Medium` 和 `Standard` 取值。关于链路规格的详细信息，请参见[产品规格](https://docs.volcengine.com/docs/6390/79112)。 |Compact | ## MySQL2ESSettings 在 `SolutionType` 取值为 `1` 时，即实例类型为 MySQL 的源实例同步至实例类型为 ElasticSearch 目标实例的参数配置，被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |MetaTransmissionSettings |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) |否 |读取源库表结构定义语法，重新组装成目标库的语法格式。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示结构迁移。

* 数据订阅：表示库表结构订阅。

* 数据同步：表示结构初始化。 |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) | |FullTransmissionSettings |[FullTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#fulltransmissionsettings) |否 |全量读取源表内容并写到对应的目标库。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示全量迁移。

* 数据订阅：表示全量订阅。

* 数据同步：表示全量初始化。 |[FullTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#fulltransmissionsettings) | |IncrTransmissionSettings |[IncrTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#incrtransmissionsettings) |否 |通过对目标库增量日志的解析和回放。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示增量迁移。

* 数据订阅：表示增量订阅。

* 数据同步：表示增量同步。

> **说明**

> 当 `TaskType` 取值为 `DataSynchronization` 时，该参数必填。
|[IncrTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#incrtransmissionsettings) | |ObjectMappings |Array of ObjectMapping |是 |源端和目标端对象的映射信息。详细信息，请参见 [ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings)。 |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) | |ETLSettings |[ETLSettings](https://docs.volcengine.com/docs/6390/76140#etlsettings) |否 |流式数据 ETL 参数配置。 |[ETLSettings](https://docs.volcengine.com/docs/6390/76140#etlsettings) | |ErrorBehaviorSettings |[ErrorBehaviorSettings](https://docs.volcengine.com/docs/6390/76140#errorbehaviorsettings) |否 |错误重试时间。当源库或目标库断连后，若能在该时间内重新连上，任务即可自动恢复。取值范围：600~86400，单位：秒(s)。 |7200 | |ESExtraArgs |[ESExtraArgs](https://docs.volcengine.com/docs/6390/76140#esextraargs) |否 |在同步至 Elasticsearch 时的参数信息。 |[ESExtraArgs](https://docs.volcengine.com/docs/6390/76140#esextraargs) | |PolicyForPrimaryKeyConflict |String |否 |主键冲突处理。当目标库已存在同主键值的行时的处理方法，取值如下：

* `ThrowError`：表示冲突报错，表示预检查时提示相关报错，需手动修改相关数据，否则同步任务无法启动。

* `Ignore`：表示冲突忽略，表示预检查时会跳过对目标数据库中存在同主键值的行，同步任务可正常启动。

* `Override`：表示冲突覆盖，表示使用源库数据覆盖目标库数据，同步任务可正常启动。

> **注意**

> 在取值为 `Ignore` 时，可能会导致数据不一致，给业务带来风险，请谨慎选择。
|ThrowError | ## Mongo2MongoSettings 在 `SolutionType` 取值为 `Mongo2Mongo` 时，即实例类型为 MongoDB 的源实例迁移至实例类型为 MongoDB 目标实例的参数配置，被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ObjectMappings |Array of ObjectMapping |是 |源端和目标端对象的映射信息。详细信息，请参见 [ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings)。 |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) | |MetaTransmissionSettings |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) |否 |读取源库表结构定义语法，重新组装成目标库的语法格式。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示结构迁移。

* 数据订阅：表示库表结构订阅。

* 数据同步：表示结构初始化。 |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) | |FullTransmissionSettings |[FullTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#fulltransmissionsettings) |否 |全量读取源表内容并写到对应的目标库。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示全量迁移。

* 数据订阅：表示全量订阅。

* 数据同步：表示全量初始化。 |[FullTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#fulltransmissionsettings) | |IncrTransmissionSettings |[IncrTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#incrtransmissionsettings) |否 |通过对目标库增量日志的解析和回放。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示增量迁移。

* 数据订阅：表示增量订阅。

* 数据同步：表示增量同步。

> **说明**

> 当 `TaskType` 取值为 `DataSynchronization` 时，该参数必填。
|[IncrTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#incrtransmissionsettings) | |ETLSettings |[ETLSettings](https://docs.volcengine.com/docs/6390/76140#etlsettings) |否 |ETL 参数配置。 |[ETLSettings](https://docs.volcengine.com/docs/6390/76140#etlsettings) | |ErrorBehaviorSettings |[ErrorBehaviorSettings](https://docs.volcengine.com/docs/6390/76140#errorbehaviorsettings) |否 |错误重试时间。当源库或目标库断连后，若能在该时间内重新连上，任务即可自动恢复。 |[ErrorBehaviorSettings](https://docs.volcengine.com/docs/6390/76140#errorbehaviorsettings) | ## MongoShardSetting > **说明** > 最多可添加 32 个分片信息。 |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |Address |String |是 |分片地址，例如 `IP:端口`或`域名:端口`。在存在多个地址时，需使用英文逗号（,）隔开，最多支持配置 5 个地址。 |192.168.0.1:27019,192.168.0.1:27020 | |Username |String |是 |数据库账号。 |test\*\*\*\* | |Password |String |是 |数据库密码。 |test\*\*\*\* | |AuthDb |String |是 |账号校验数据库。 |admin | ## MySQL2MySQLCompareDiffPatchSettings 在 `SolutionType` 取值为 `MySQL2MySQLCompareDiffPatch` 时，被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ObjectMappings |Array of ObjectMapping |是 |数据订正范围。详细信息，请参见 [ObjectMappings](https://www.volcengine.com/docs/6390/76140?lang=zh#objectmappings)。 |[ObjectMappings](https://www.volcengine.com/docs/6390/76140?lang=zh#objectmappings) | |EnableDelete |Bool |是 |是否订正 `DELETE` 类型 Diff，取值如下。

* `true`：按照订正基准，对于一端有而另一端无的 Diff 数据， DTS 生成包含 `DELETE` 类型的 SQL 语句。

* `false`：按照订正基准，对于一端有而另一端无的 Diff 数据， DTS 自动忽略，不生成包含 `DELETE` 类型的 SQL 语句。 |

true | |EnableReverse |Bool |是 |是否以目标库为订正基准，取值如下。

* `true`：以目标库为基准，订正 Diff 数据，使源库与目标库保持一致。

* `false`：以源库为基准，订正 Diff 数据，使目标端数据与源库保持一致。 |false

| ## MySQL2MySQLIncrDiffPatchSettings 在 `SolutionType` 取值为 `MySQL2MySQLIncrDiffPatch` 时，被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ObjectMappings |Array of ObjectMapping |是 |数据订正范围。详细信息，请参见 [ObjectMappings](https://www.volcengine.com/docs/6390/76140?lang=zh#objectmappings)。 |[ObjectMappings](https://www.volcengine.com/docs/6390/76140?lang=zh#objectmappings) | |EnableDelete |Bool |是 |是否订正 `DELETE` 类型 Diff，取值如下。

* `true`：按照订正基准，对于一端有而另一端无的 Diff 数据， DTS 生成包含 `DELETE` 类型的 SQL 语句。

* `false`：按照订正基准，对于一端有而另一端无的 Diff 数据， DTS 自动忽略，不生成包含 `DELETE` 类型的 SQL 语句。 |true | |EnableReverse |Bool |是 |是否以目标库为订正基准，取值如下。

* `true`：以目标库为基准，订正 Diff 数据，使源库与目标库保持一致。

* `false`：以源库为基准，订正 Diff 数据，使目标端数据与源库保持一致。 |false | ## MySQL2MySQLMigrationAssessment 在 `SolutionType` 取值为 `MySQL2MySQLMigrationAssessment` 时，即评估实例类型为 MySQL 的源实例迁移至实例类型为 MySQL 的目标实例的参数配置。被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ObjectMappings |Array of ObjectMapping |是 |源端和目标端对象的映射信息。详细信息，请参见 [ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings)。 |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) | ## MySQL2MySQLSettings 在 `SolutionType` 取值为 `MySQL2MySQL` 时，即实例类型为 MySQL 的源实例迁移或同步至实例类型为 MySQL 的目标实例的参数配置。被以下结构体引用： * SolutionSettings |**参数** |**类型** |**是否必选** |**描述** |**示例值** | |---|---|---|---|---| |ObjectMappings |Array of ObjectMapping |是 |源端和目标端对象的映射信息。详细信息，请参见 [ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings)。 |[ObjectMappings](https://docs.volcengine.com/docs/6390/76140#objectmappings) | |EnableForeignKeyChecks |Bool |否 |按需选择是否开启外键检查，开启外键检查后，支持迁移源库的外键级联更新、删除等操作，从而保证数据迁移的完整性和一致性。取值如下：

* `true`：表示开启外键检查。

* `false`：（默认值）表示不开启外键检查。

> **说明**

> 仅 `TaskType` 取值为 `DataMigration` 时支持配置此参数。
|false | |AccountTransmissionSettings |[AccountTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#accounttransmissionsettings) |否 |将源库中指定的非系统账号及账号所拥有的权限迁移到目标库。

> **说明**

> 仅 `TaskType` 取值为 `DataMigration` 或 `DataSynchronization` 时支持配置此参数。
|[AccountTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#accounttransmissionsettings) | |MetaTransmissionSettings |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) |否 |读取源库表结构定义语法，重新组装成目标库的语法格式。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示结构迁移。

* 数据订阅：表示库表结构订阅。

* 数据同步：表示结构初始化。 |[MetaTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#metatransmissionsettings) | |FullTransmissionSettings |[FullTransmissionSettings](https://docs.volcengine.com/docs/6390/76140#fulltransmissionsettings) |否 |全量读取源表内容并写到对应的目标库。根据不同任务，该参数意义有所差异，具体如下所示：

* 数据迁移：表示全量迁移。

* 数据订阅：表示全量订阅。

*