接口说明
- 您可以根据需求在控制台进行相应的预配置，然后预览对应配置的 OpenAPI 参数信息，以协助您填写请求参数。更多信息，请参见预览 OpenAPI 的请求参数。
- 专属集群的任务仅支持先配置后购买，且不支持跨地域的任务。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
DtsJobNamestring | DTS 实例名称。 示例值:rdsmysql_to_mysql参考取值来源: DescribeDtsJobs |
SourceEndpointInstanceTypestring | 源实例类型，取值：展开详情 示例值:RDS |
SourceEndpointInstanceIDstring | 源实例 ID。展开详情 示例值:rm-bp1imrtn6fq7h**** |
SourceEndpointEngineNamestring | 源实例的数据库类型。展开详情 示例值:MYSQL |
SourceEndpointRegionstring | |
SourceEndpointIPstring | 源实例的 IP 地址。展开详情 示例值:172.16.**.*** |
SourceEndpointPortstring | 源实例的数据库服务端口。展开详情 示例值:3306 |
SourceEndpointOracleSIDstring | Oracle 数据库的 SID 信息。展开详情 示例值:testsid |
SourceEndpointDatabaseNamestring | 源实例中迁移对象所属的数据库名称。展开详情 示例值:dtstestdatabase |
SourceEndpointUserNamestring | 源库的数据库账号。展开详情 示例值:dtstest |
SourceEndpointPasswordstring | 源库数据库账号密码。 示例值:Test123456 |
SourceEndpointOwnerIDstring | 源实例所属的阿里云账号 ID。展开详情 示例值:140692647406**** |
SourceEndpointRolestring | 源实例所属云账号配置的角色名称。展开详情 示例值:ram-for-dts |
DestinationEndpointInstanceTypestring | 目标实例类型，取值：展开详情 示例值:EXPRESS |
DestinationEndpointInstanceIDstring | 目标实例 ID。展开详情 示例值:vpc-bp1opxu1zkhn00gzv**** |
DestinationEndpointEngineNamestring | 目标实例的数据库类型。展开详情 示例值:MYSQL |
DestinationEndpointRegionstring | |
DestinationEndpointIPstring | 目标实例的 IP 地址。展开详情 示例值:172.16.**.*** |
DestinationEndpointPortstring | 目标实例的数据库服务端口。展开详情 示例值:3306 |
DestinationEndpointDataBaseNamestring | 目标实例中迁移对象所属的数据库名称。展开详情 示例值:dtstestdata |
DestinationEndpointUserNamestring | 目标库的数据库账号。展开详情 示例值:dtstest |
DestinationEndpointPasswordstring | 目标库数据库账号密码。展开详情 示例值:Test123456 |
DestinationEndpointOwnerIDstring | 目标 RDS MySQL 实例所属的阿里云账号 ID。展开详情 示例值:140692647406**** |
DestinationEndpointRolestring | 目标实例所属云账号配置的角色名称。展开详情 示例值:ram-for-dts |
StructureInitializationboolean | 是否执行库表结构迁移或初始化，取值：展开详情 示例值:true |
DataInitializationboolean | 是否执行全量数据迁移或全量数据初始化，取值：展开详情 示例值:true |
DataSynchronizationboolean | 是否执行增量数据迁移或同步，取值：展开详情 示例值:true |
DbListstring | 待迁移或同步的对象，格式为 JSON 串。详细定义说明，请参见迁移、同步或订阅对象说明。展开详情 示例值:{"dtstest":{"name":"dtstest","all":true}} |
Reservestring | DTS 预留参数，格式为 JSON 字符串，您可以传入本参数完善源目库信息（如目标 Kafka 数据库的数据存储格式、云企业网 CEN 的实例 ID）。更多信息，请参见 Reserve 参数说明。 示例值:{ "srcInstanceId": "cen-9kqshqum*******" } |
Checkpointstring | 增量数据迁移的启动位点或者同步位点，格式为 Unix 时间戳，单位为秒。展开详情 示例值:1610540493 |
DestinationEndpointOracleSIDstring | Oracle 数据库的 SID 信息。展开详情 示例值:testsid |
JobTypestring | 任务类型，取值为：展开详情 示例值:SYNC |
DtsJobIdstring | 迁移或同步任务 ID。展开详情 示例值:k2gm967v16f****参考取值来源: ModifyDtsJob DescribeDtsJobs CreateReverseDtsJob |
DtsInstanceIdstring | 迁移或同步实例 ID。展开详情 示例值:dtsk2gm967v16f****参考取值来源: DescribeDtsJobDetail CreateReverseDtsJob |
DelayPhonestring | 延迟报警的联系人手机号码，多个手机号码以英文逗号（,）分隔。展开详情 示例值:1361234****,1371234**** |
DelayRuleTimeinteger<int64> | 触发延迟报警的阈值，单位为秒且需为整数，可根据业务需要设置阈值，建议设置 10 秒以上，避免因网络、数据库负载等原因导致的延迟波动。展开详情 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:10取值 <= 10000000000 |
DelayNoticeboolean | 是否监控延迟状态，取值：展开详情 示例值:true |
ErrorPhonestring | 异常报警的联系人手机号码，多个手机号码以英文逗号（,）分隔。展开详情 示例值:1361234****,1371234**** |
ErrorNoticeboolean | 是否监控异常状态，取值：展开详情 示例值:true |
SynchronizationDirectionstring | 同步方向，取值：展开详情 示例值:Forward参考取值来源: DescribeSynchronizationJobs |
RegionIdstring | DTS 实例所属的地域，请参见支持的地域列表。 示例值:cn-hangzhou |
DedicatedClusterIdstring | DTS 专属集群 ID。展开详情 示例值:dtscluster_atyl3b5214uk***参考取值来源: ModifyDedicatedCluster ListDedicatedCluster CreateDedicatedClusterMonitorRule DescribeDedicatedClusterMonitorRule |
FileOssUrlstring | 任务文件的 OSS 地址。 示例值:http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb************** |
DataCheckConfigurestring | 数据校验任务的参数，格式为 JSON 字符串，如参数限制或告警配置等信息。更多信息请参见 DataCheckConfigure 参数说明。 示例值:{"fullCheckModel":1,"fullCheckRatio":20,"checkMaximumHourEnable":1,"checkMaximumHour":1,"fullCheckErrorNotice":true,"fullCheckValidFailNotice":true,"fullCheckNoticeValue":8,"incrementalCheckErrorNotice":true,"incrementalCheckValidFailNotice":true,"incrementalCheckValidFailNoticeTimes":2,"incrementalCheckValidFailNoticePeriod":1,"incrementalCheckValidFailNoticeValue":1,"incrementalCheckDelayNotice":true,"incrementalCheckDelayNoticeTimes":2,"incrementalCheckDelayNoticePeriod":1,"incrementalCheckDelayNoticeValue":60,"fullDataCheck":true,"incrementalDataCheck":true,"dataCheckNoticePhone":"13126800****","dataCheckDbList":{"dts":{"name":"dts","all":true}}} |
DisasterRecoveryJobboolean | 是否为灾备实例，取值：展开详情 示例值:true |
SourceEndpointVSwitchIDstring | 数据投递链路交换机实例 ID。 示例值:vsw-bp10df3mxae6lpmku**** |
DtsBisLabelstring | DTS 实例的环境标签，取值为：展开详情 示例值:normal参考取值来源: DescribeDtsJobDetail |
SrcCaCertificateOssUrlstring | 源库通过 SSL 安全连接时，CA 证书的路径。展开详情 示例值:**** |
SrcCaCertificatePasswordstring | 源库通过 SSL 安全连接时，CA 证书的密钥。展开详情 示例值:**** |
DestCaCertificateOssUrlstring | 目标库通过 SSL 安全连接时，CA 证书的路径。展开详情 示例值:**** |
DestCaCertificatePasswordstring | 目标库通过 SSL 安全连接时，CA 证书的密钥。展开详情 示例值:**** |
MinDunumber<double> | DU 下限。展开详情 示例值:1 |
MaxDunumber<double> | DU 上限。展开详情 示例值:16 |
SrcClientCertOssUrlstring | 源库通过 SSL 安全连接时，客户端证书的路径。展开详情 示例值:**** |
SrcClientKeyOssUrlstring | 源库通过 SSL 安全连接时，客户端证书私钥的路径。展开详情 示例值:**** |
SrcClientPasswordstring | 源库通过 SSL 安全连接时，客户端证书私钥的密码。展开详情 示例值:**** |
DestClientCertOssUrlstring | 目标库通过 SSL 安全连接时，客户端证书的路径。展开详情 示例值:**** |
DestClientKeyOssUrlstring | 目标库通过 SSL 安全连接时，客户端证书私钥的路径。展开详情 示例值:**** |
DestClientPasswordstring | 目标库通过 SSL 安全连接时，客户端证书私钥的密码。展开详情 示例值:**** |
SrcPrimaryVswIdstring | VPCNAT 源端主 VSW 示例值:**** |
SrcSecondaryVswIdstring | VPCNAT 源端备 VSW 示例值:**** |
DestPrimaryVswIdstring | VPCNAT 目的端主 VSW 示例值:**** |
DestSecondaryVswIdstring | VPCNAT 目的端备 VSW 示例值:**** |
ResourceGroupIdstring | 资源组 ID。 示例值:rg-acfmzawhxxc**** |
返回参数
| 字段名称 | 字段详情 |
|---|---|
HttpStatusCodestring | 状态码。 示例值:200 |
RequestIdstring | 请求 ID。 示例值:224DB9F7-3100-4899-AB9C-C938BCCB**** |
ErrCodestring | 调用出错时返回的错误码。 示例值:InternalError |
DtsJobIdstring | 迁移或同步任务 ID。 示例值:k2gm967v16f**** |
DtsInstanceIdstring | 迁移或同步实例 ID。 示例值:dtsk2gm967v16f**** |
Successstring | 请求是否成功。 示例值:true |
ErrMessagestring | 调用错误时返回对应的错误信息。 示例值:The request processing has failed due to some unknown error. |