/** * ModifyCompareTask返回参数结构体 */ export interface ModifyCompareTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSyncJobs返回参数结构体 */ export interface DescribeSyncJobsResponse { /** *
任务数目
*/ TotalCount?: number; /** *任务详情数组
*/ JobList?: Array数据订阅的实例ID
*/ SubscribeId?: string; /** *数据订阅实例的名称
*/ SubscribeName?: string; /** *订阅实例发送数据的kafka topic
*/ Topic?: string; /** *订阅实例的类型,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
*/ Product?: string; /** *订阅的数据库实例ID(如果订阅的是云数据库)如果实例不是腾讯云上的,此值为空。
*/ InstanceId?: string; /** *云数据库状态:running 运行中,isolated 已隔离,offline 已下线。如果不是云上,此值为空
*/ InstanceStatus?: string; /** *数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
*/ Status?: string; /** *数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
*/ SubsStatus?: string; /** *上次修改时间,时间格式如:Y-m-d h:m:s
*/ ModifyTime?: string; /** *创建时间,时间格式如:Y-m-d h:m:s
*/ CreateTime?: string; /** *隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
*/ IsolateTime?: string; /** *包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
*/ ExpireTime?: string; /** *下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
*/ OfflineTime?: string; /** *计费方式,0 - 包年包月,1 - 按量计费
*/ PayType?: number; /** *自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
*/ AutoRenewFlag?: number; /** *数据订阅实例所属地域
*/ Region?: string; /** *接入方式。枚举值:extranet(公网) vpncloud(vpn接入) dcg(专线接入) ccn(云联网) cdb(云数据库) cvm(云主机自建) intranet(自研上云) vpc(私有网络vpc)
*/ AccessType?: string; /** *数据库节点信息
*/ Endpoints?: Array数据订阅版本, 当前支持kafka和kafkaPro(专业版)
*/ SubscribeVersion?: string; /** *标签
注意:此字段可能返回 null,表示取不到有效值。 */ Tags?: Array任务报错信息,如果有的话。
注意:此字段可能返回 null,表示取不到有效值。 */ Errors?: Array订阅实例规格
*/ InstanceClass?: string; /** *新版订阅消费端路由阶段
*/ ConsumerRoutePhase?: string; } /** * ModifyMigrateJobSpec请求参数结构体 */ export interface ModifyMigrateJobSpecRequest { /** * 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ JobId: string; /** * 新实例规格大小,包括:micro、small、medium、large、xlarge、2xlarge */ NewInstanceClass: string; } /** * DeleteSyncCompareTask返回参数结构体 */ export interface DeleteSyncCompareTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * IsolateSubscribe返回参数结构体 */ export interface IsolateSubscribeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConsumerGroupPassword请求参数结构体 */ export interface ModifyConsumerGroupPasswordRequest { /** * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。 */ SubscribeId: string; /** * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。 */ AccountName: string; /** * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。 */ ConsumerGroupName: string; /** * 新密码。字符长度不小于3,不大于32 */ NewPassword: string; } /** * 当前步骤错误信息或者警告信息 */ export interface StepTip { /** * 错误码 */ Code?: string; /** * 错误信息 */ Message?: string; /** * 解决方式 */ Solution?: string; /** * 帮助文档 */ HelpDoc?: string; /** * 当前步骤跳过信息 */ SkipInfo?: string; } /** * ModifySyncRateLimit返回参数结构体 */ export interface ModifySyncRateLimitResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSyncCompareTasks返回参数结构体 */ export interface DescribeSyncCompareTasksResponse { /** *数量
注意:此字段可能返回 null,表示取不到有效值。 */ TotalCount?: number; /** *一致性校验任务列表
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Arraykafka分区编号
*/ PartitionNo?: number; /** *kafka offset
*/ Offset?: number; } /** * SkipCheckItem返回参数结构体 */ export interface SkipCheckItemResponse { /** * 跳过的提示信息 */ Message?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumeSyncJob请求参数结构体 */ export interface ResumeSyncJobRequest { /** *同步任务id,可通过DescribeSyncJobs接口获取。
*/ JobId: string; } /** * ModifySubscribeObjects请求参数结构体 */ export interface ModifySubscribeObjectsRequest { /** *数据订阅实例的ID,可通过DescribeSubscribeJobs接口获取。
*/ SubscribeId: string; /** *数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合
*/ SubscribeObjectType: number; /** *修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。
*/ Objects?: Arraykafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。
*/ DistributeRules?: Array默认分区策略。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。
该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。
mongo输出聚合设置,mongo任务可选。如果不填,默认不修改。
*/ PipelineInfo?: Array任务 Id
*/ JobId: string; /** *分页设置,表示每页显示多少条任务,默认为 20
*/ Limit?: number; /** *分页偏移量
*/ Offset?: number; /** *校验任务 ID
*/ CompareTaskId?: string; /** *任务状态过滤,可能的值:created - 创建完成;readyRun - 等待运行;running - 运行中;success - 成功;stopping - 结束中;failed - 失败;canceled - 已终止
*/ Status?: Array数据库名
*/ Db?: string; /** *schema
*/ Schema?: string; /** *表名
*/ Table?: string; /** *分块号
*/ Chunk?: number; /** *源库数值
*/ SrcItem?: string; /** *目标库数值
*/ DstItem?: string; /** *索引名称
*/ IndexName?: string; /** *索引下边界
*/ LowerBoundary?: string; /** *索引上边界
*/ UpperBoundary?: string; /** *对比消耗时间,单位为 ms
*/ CostTime?: number; /** *完成时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
库名
*/ Db?: string; /** *schema名
*/ Schema?: string; /** *表名
*/ Table?: string; /** *校验结果
*/ Conclusion?: string; /** *校验状态。仅全量阶段有意义
*/ Status?: string; /** *校验进度。仅全量阶段有意义
*/ Progress?: number; /** *不一致行数
*/ RowCount?: number; /** *该表开始校验的时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
该表校验结束的时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
预计该表校验结束的时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
源端行数,如果是行数校验此值有意义
*/ SrcItem?: string; /** *目标端行数,如果是行数校验此值有意义
*/ DstItem?: string; } /** * ContinueMigrateJob请求参数结构体 */ export interface ContinueMigrateJobRequest { /** * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ JobId: string; } /** * DescribeMigrateGtidCompareReport请求参数结构体 */ export interface DescribeMigrateGtidCompareReportRequest { /** * 任务id */ JobId: string; /** * 创建的校验任务id */ CompareTaskId?: string; /** * 是否需要展示不一致详情 */ NeedDiffDetail?: boolean; } /** * ResetConsumerGroupOffset请求参数结构体 */ export interface ResetConsumerGroupOffsetRequest { /** *订阅实例id,可通过DescribeSyncJobs接口获取。
*/ SubscribeId: string; /** *订阅的kafka topic,可通过DescribeSyncJobs接口获取。
*/ TopicName: string; /** *消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过DescribeConsumerGroups接口获取。
*/ ConsumerGroupName: string; /** *需要修改offset的分区编号,可通过DescribeOffsetByTime接口获取。
*/ PartitionNos: Array重置方式。枚举值为 earliest-从最开始位置开始消费;latest-从最新位置开始消费;datetime-从指定时间前最近的checkpoint开始消费
*/ ResetMode: string; /** *当 ResetMode 为 datetime 时该项需要填。当 DateTimeISOFormat=true 时按 RFC 3339 传入(如 2026-04-23T20:21:35+08:00),否则按 Y-m-d h:m:s(北京时间)传入。如果不填,默认用 0 时间,效果与 earliest 相同。
参数格式:2026-04-23T20:21:35+08:00
*/ ResetDatetime?: string; } /** * ModifySyncRateLimit请求参数结构体 */ export interface ModifySyncRateLimitRequest { /** *同步任务ID,可通过DescribeSyncJobs接口获取。
*/ JobId: string; /** *同步任务全量导出线程数、有效值为 1-16
*/ DumpThread?: number; /** *同步任务全量导出的 Rps 限制、需要大于 0;对于mongodb最大值为20000,其他数据库最大值为50000000
*/ DumpRps?: number; /** *同步任务全量导入线程数、有效值为 1-16
*/ LoadThread?: number; /** *同步任务增量导入线程数、有效值为 1-128
*/ SinkerThread?: number; /** *同步任务全量导入的Rps
*/ LoadRps?: number; } /** * DescribeCheckSyncJobResult请求参数结构体 */ export interface DescribeCheckSyncJobResultRequest { /** * 同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。 */ JobId?: string; } /** * ModifySubscribeAutoRenewFlag返回参数结构体 */ export interface ModifySubscribeAutoRenewFlagResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroySyncJob返回参数结构体 */ export interface DestroySyncJobResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 结构不一致详情 */ export interface SchemaDifference { /** * 结构不一致的表所在库 */ Db?: string; /** * 结构不一致的表所在schema */ Schema?: string; /** * 结构不一致的表 */ Table?: string; /** * 源库表结构 */ SrcSchema?: string; /** * 目标库表结构 */ DstSchema?: string; } /** * 任务错误信息 */ export interface ErrorInfoItem { /** * 错误码 */ Code?: string; /** * 解决方案 */ Solution?: string; /** * 错误日志信息 */ ErrorLog?: string; /** * 文档提示 */ HelpDoc?: string; } /** * IsolateMigrateJob请求参数结构体 */ export interface IsolateMigrateJobRequest { /** * 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ JobId: string; } /** * 库/表/视图级别的 DDL/DML 白名单 */ export interface DBOpFilter { /** * 规则生效的库名 */ DbName: string; /** * 库级 DDL/DML 过滤规则 */ OpFilter?: OpFilter; /** * 表级 DDL/DML 过滤信息 */ Tables?: Array符合筛选条件的数量
*/ TotalCount?: number; /** *实例列表
*/ Instances?: Array查询结果的数量
*/ TotalCount?: number; /** *查询结果详情
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array数据迁移任务ID,可通过DescribeMigrationJobs接口获取。
*/ JobId: string; } /** * StartSyncCompare请求参数结构体 */ export interface StartSyncCompareRequest { /** * 任务 Id */ JobId: string; /** * 对比任务 ID,形如:sync-8yv4w2i1-cmp-37skmii9 */ CompareTaskId: string; } /** * CreateConsumerGroup请求参数结构体 */ export interface CreateConsumerGroupRequest { /** * 订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。 */ SubscribeId: string; /** * 消费组名称,以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName} */ ConsumerGroupName: string; /** * 账号名称。以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的账户全称形如:account-#{SubscribeId}-#{AccountName} */ AccountName: string; /** * 消费组密码,长度必须大于3 */ Password: string; /** * 消费组备注 */ Description?: string; } /** * ResizeSyncJob请求参数结构体 */ export interface ResizeSyncJobRequest { /** * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。 */ JobId: string; /** * 任务规格,可选值包括micro,small,medium,large */ NewInstanceClass: string; } /** * mongodb行数校验不一致性详情结果 */ export interface DifferenceRowDetail { /** * 不一致总数 */ TotalCount?: number; /** * 不一致列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array同步任务id,如:sync-btso140
*/ JobId?: string; /** *同步任务名
*/ JobName?: string; /** *付款方式,PostPay(按量付费)、PrePay(包年包月)
*/ PayMode?: string; /** *运行模式,Immediate(表示立即运行,默认为此项值)、Timed(表示定时运行)
*/ RunMode?: string; /** *期待运行时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
支持的所有操作
*/ AllActions?: Array当前状态能进行的操作
注意:此字段可能返回 null,表示取不到有效值。 */ Actions?: Array同步选项
*/ Options?: Options; /** *同步库表对象
*/ Objects?: Objects; /** *任务规格
*/ Specification?: string; /** *过期时间,格式为 yyyy-mm-dd hh:mm:ss
*/ ExpireTime?: string; /** *源端地域,如:ap-guangzhou等
*/ SrcRegion?: string; /** *源端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。
*/ SrcDatabaseType?: string; /** *源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)
*/ SrcAccessType?: string; /** *源端信息,单节点数据库使用
*/ SrcInfo?: Endpoint; /** *枚举值:cluster、single。源库为单节点数据库使用single,多节点使用cluster
*/ SrcNodeType?: string; /** *源端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
*/ SrcInfos?: SyncDBEndpointInfos; /** *目标端地域,如:ap-guangzhou等
*/ DstRegion?: string; /** *目标端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。
*/ DstDatabaseType?: string; /** *目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)
*/ DstAccessType?: string; /** *目标端信息,单节点数据库使用
*/ DstInfo?: Endpoint; /** *枚举值:cluster、single。目标库为单节点数据库使用single,多节点使用cluster
*/ DstNodeType?: string; /** *目标端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
*/ DstInfos?: SyncDBEndpointInfos; /** *创建时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
开始时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
任务状态,UnInitialized(未初始化)、Initialized(已初始化)、Checking(校验中)、CheckPass(校验通过)、CheckNotPass(校验不通过)、ReadyRunning(准备运行)、Running(运行中)、Pausing(暂停中)、Paused(已暂停)、Stopping(停止中)、Stopped(已结束)、ResumableErr(任务错误)、Resuming(恢复中)、Failed(失败)、Released(已释放)、Resetting(重置中)、Unknown(未知)
*/ Status?: string; /** *结束时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
标签相关信息
*/ Tags?: Array同步任务运行步骤信息
*/ Detail?: SyncDetailInfo; /** *用于计费的状态,可能取值有:Normal(正常状态)、Resizing(变配中)、Renewing(续费中)、Isolating(隔离中)、Isolated(已隔离)、Offlining(下线中)、Offlined(已下线)、NotBilled(未计费)、Recovering(解隔离)、PostPay2Prepaying(按量计费转包年包月中)、PrePay2Postpaying(包年包月转按量计费中)
*/ TradeStatus?: string; /** *同步链路规格,如micro,small,medium,large
*/ InstanceClass?: string; /** *自动续费标识,当PayMode值为PrePay则此项配置有意义,取值为:1(表示自动续费)、0(不自动续费)
*/ AutoRenew?: number; /** *下线时间,格式为 yyyy-mm-dd hh:mm:ss
*/ OfflineTime?: string; /** *动态修改对象,修改任务的状态等
*/ OptObjStatus?: string; /** *自动重试时间段设置
*/ AutoRetryTimeRangeMinutes?: number; /** *全量导出可重入标识:enum::"yes"/"no"。yes表示当前任务可重入、no表示当前任务处于全量导出且不可重入阶段;如果在该值为no时重启任务导出流程不支持断点续传
*/ DumperResumeCtrl?: string; } /** * StartSubscribe请求参数结构体 */ export interface StartSubscribeRequest { /** * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。 */ SubscribeId: string; } /** * DescribeSubscribeReturnable返回参数结构体 */ export interface DescribeSubscribeReturnableResponse { /** * 实例是否支持退还/退货 */ IsReturnable?: boolean; /** * 不支持退还的原因 */ ReturnFailMessage?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMigrateRuntimeAttribute返回参数结构体 */ export interface ModifyMigrateRuntimeAttributeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeOffsetByTime返回参数结构体 */ export interface DescribeOffsetByTimeResponse { /** *时间与Offset的对应
*/ Items?: Array源实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore
枚举值:
目标实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore,tendis
枚举值:
源实例地域,如:ap-guangzhou
*/ SrcRegion: string; /** *目标实例地域,如:ap-guangzhou。注意,目标地域必须和API请求地域保持一致。
*/ DstRegion: string; /** *实例规格,包括:small、medium、large、xlarge、2xlarge。当前未计费链路仅支持medium字段值。不同规格类型参考计费概述
*/ InstanceClass: string; /** *购买数量,范围为[1,15],默认为1
*/ Count?: number; /** *迁移服务名称,最大长度128
*/ JobName?: string; /** *标签信息
*/ Tags?: Array迁移任务 Id,可通过 DescribeMigrationJobs 接口获取。
*/ JobId: string; /** *分页设置,表示每页显示多少条任务,默认为 20
*/ Limit?: number; /** *分页偏移量
*/ Offset?: number; /** *校验任务 ID
*/ CompareTaskId?: string; /** *任务状态过滤,可能的值:created - 创建完成;readyRun - 等待运行;running - 运行中;success - 成功;stopping - 结束中;failed - 失败;canceled - 已终止
*/ Status?: Array一致性校验摘要信息
*/ Abstract?: CompareAbstractInfo; /** *一致性校验详细信息
*/ Detail?: CompareDetailInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSyncGtidCompareReport返回参数结构体 */ export interface DescribeSyncGtidCompareReportResponse { /** * 校验结论 */ Conclusion?: string; /** * 校验状态 */ Status?: string; /** * 校验类型 */ Type?: string; /** * 不一致详情 */ Detail?: Array订阅实例id,可通过DescribeSubscribeJobs接口获取。
*/ SubscribeId: string; /** *返回记录的起始偏移量。默认0
*/ Offset?: number; /** *单次返回的记录数量。默认10
*/ Limit?: number; } /** * kafka消费者组详情 */ export interface GroupInfo { /** *消费者组账号
*/ Account?: string; /** *消费者组名称
*/ ConsumerGroupName?: string; /** *消费者组备注
*/ Description?: string; /** *消费组偏移量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区的偏移量。各分区的偏移量详见StateOfPartition字段
*/ ConsumerGroupOffset?: number; /** *消费组未消费的数据量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区未消费的数据量。各分区未消费数据量详见StateOfPartition字段
*/ ConsumerGroupLag?: number; /** *消费延迟(单位为秒)
*/ Latency?: number; /** *各分区的消费状态
*/ StateOfPartition?: Array消费者组创建时间。
*/ CreatedAt?: string; /** *消费者组修改时间。
*/ UpdatedAt?: string; /** *消费者组状态,包括Dead、Empty、Stable等,只有Dead和Empty两种状态可以执行reset操作
*/ ConsumerGroupState?: string; /** *每个消费者正在消费的分区
*/ PartitionAssignment?: Array数据库名
注意:此字段可能返回 null,表示取不到有效值。 */ DBName?: string; /** *schema名
*/ SchemaName?: string; /** *数据表名
注意:此字段可能返回 null,表示取不到有效值。 */ TableName?: string; /** *分块号
注意:此字段可能返回 null,表示取不到有效值。 */ ChunkId?: number; /** *数据标识符,比如主键信息等
注意:此字段可能返回 null,表示取不到有效值。 */ Identifier?: string; /** *不一致类型,可能的取值为:data - 两边数据不一致;srcLack - 源缺失;dstLack - 目标缺失
注意:此字段可能返回 null,表示取不到有效值。 */ DiffType?: string; /** *表结构信息
注意:此字段可能返回 null,表示取不到有效值。 */ SchemaInfo?: Array源端数据
注意:此字段可能返回 null,表示取不到有效值。 */ SrcItem?: Array目标端数据
注意:此字段可能返回 null,表示取不到有效值。 */ DstItem?: Array完成时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
数据订阅的ID,形如subs-b6x64o31tm
*/ SubscribeId?: string; /** *数据订阅实例的名称
*/ SubscribeName?: string; /** *订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)
*/ Product?: string; /** *订阅的云数据库实例ID,只有订阅云数据库该值才有意义
*/ InstanceId?: string; /** *订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline
*/ InstanceStatus?: string; /** *订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng
*/ Status?: string; /** *订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error
*/ SubsStatus?: string; /** *修改时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。
创建时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。
隔离时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。
包年包月任务的到期时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。
下线时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。
付费方式,可能值为:0-包年包月,1-按量计费
*/ PayType?: number; /** *自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
*/ AutoRenewFlag?: number; /** *任务所在地域
*/ Region?: string; /** *Kafka topic
*/ Topic?: string; /** *Kafka服务Broker地址
*/ Broker?: string; /** *数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合
*/ SubscribeMode?: string; /** *订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档
*/ Protocol?: string; /** *订阅的数据库表信息
*/ SubscribeObjects?: Arraykafka配置信息
*/ KafkaConfig?: SubscribeKafkaConfig; /** *订阅内置kafka的版本信息
*/ KafkaVersion?: string; /** *源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
*/ AccessType?: string; /** *接入类型信息
*/ Endpoints?: Arraymongo输出聚合设置
*/ PipelineInfo?: Array标签
*/ Tags?: Array订阅任务报错信息
注意:此字段可能返回 null,表示取不到有效值。 */ Errors?: Array为业务添加的额外信息。参数名作key,参数值作value。
mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。
mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。
数据订阅版本, 当前支持kafka和kafkaPro(专业版)
*/ SubscribeVersion?: string; /** *消费端地址所在vpc
*/ ConsumerVpcId?: string; /** *消费端地址所在子网
*/ ConsumerSubnetId?: string; /** *订阅实例规格
*/ InstanceClass?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ContinueSyncJob返回参数结构体 */ export interface ContinueSyncJobResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 计费状态信息 */ export interface TradeInfo { /** *交易订单号
*/ DealName?: string; /** *上一次交易订单号
*/ LastDealName?: string; /** *实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
*/ InstanceClass?: string; /** *计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
*/ TradeStatus?: string; /** *到期时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
下线时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
隔离时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 yyyy-mm-dd hh:mm:ss(北京时间)
下线原因
*/ OfflineReason?: string; /** *隔离原因
*/ IsolateReason?: string; /** *付费类型,包括:postpay(后付费)、prepay(预付费)
*/ PayType?: string; /** *任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
*/ BillingType?: string; } /** * mongodb数据不一致性详情 */ export interface DifferenceDataDetail { /** * 总数 */ TotalCount?: number; /** * mongo数据不一致详细列表 注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array迁移对象选项,需要告知迁移服务迁移哪些库表对象
*/ DatabaseTable: DatabaseTableObject; /** *迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。
*/ MigrateType?: string; /** *数据一致性校验选项, 默认为不开启一致性校验
注意:此字段可能返回 null,表示取不到有效值。 */ Consistency?: ConsistencyOption; /** *是否迁移账号,true(迁移账号),false(不迁移账号)
*/ IsMigrateAccount?: boolean; /** *是否用源库Root账户覆盖目标库,值包括:false-不覆盖,true-覆盖,选择库表或者结构迁移时应该为false,注意只对旧版迁移有效
*/ IsOverrideRoot?: boolean; /** *是否在迁移时设置目标库只读(仅对mysql有效),true(设置只读)、false(不设置只读,默认此值)
*/ IsDstReadOnly?: boolean; /** *其他附加信息,对于特定库可设置额外参数。
Redis可定义如下的参数:
["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(要求目标端为空,否则校验不通过) ,不显示指定默认以覆盖写的方式执行任务 "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
Tidb可定义如下的参数
["tidb_increment_enable":true, 增量迁移开关,可取值true(开启增量,平台从下列ticdc_kafka_字段提取用户自建Kafka配置)、false或不传(仅做结构+全量迁移,忽略所有ticdc_kafka_字段) ,严格匹配字符串true(不区分大小写)才算开启 "ticdc_kafka_broker":"1.1.1.1:9092", TiCDC输出的Kafka broker地址(用户自建Kafka,平台不负责创建/回收topic),增量开启时必填 "ticdc_kafka_topic":"tidb_topic", TiCDC输出的Kafka topic,增量开启时必填(连通性测试场景可不填) "ticdc_kafka_data_format":"open-protocol", 数据格式,可取值open-protocol(默认,不传时按此处理)、canal-json,其他值校验不通过 "ticdc_kafka_security_protocol":"PLAINTEXT", 传输层安全协议,可取值PLAINTEXT(默认,无认证,忽略下方认证字段)、SASL_PLAINTEXT、SASL_SSL,其他值校验不通过 "ticdc_kafka_sasl_mechanism":"SCRAM-SHA-256", SASL认证机制,可取值SCRAM-SHA-256、SCRAM-SHA-512,当security_protocol为SASL_PLAINTEXT/SASL_SSL时必填 "ticdc_kafka_username":"user", Kafka SASL用户名,当security_protocol为SASL_PLAINTEXT/SASL_SSL时必填 "ticdc_kafka_password":"password", Kafka SASL密码,当security_protocol为SASL_PLAINTEXT/SASL_SSL时必填(不做trim,允许首尾空格) "ticdc_kafka_ssl_ca_base64_content":"base64字符串", base64编码的CA证书内容,仅security_protocol=SASL_SSL时使用,可选(为空表示信任系统根证书)]
pgsql迁移分类:logical(逻辑迁移)、physical(物理迁移)
*/ MigrateWay?: string; /** *迁移配置阶段限速相关参数
*/ RateLimit?: RateLimit; } /** * DescribeSubscribeDetail请求参数结构体 */ export interface DescribeSubscribeDetailRequest { /** *订阅实例ID,可通过DescribeSubscribeJobs接口获取。
*/ SubscribeId: string; } /** * 跳过校验的表详情 */ export interface SkippedDetail { /** * 跳过的表数量 */ TotalCount?: number; /** * 跳过校验的表详情 */ Items?: Array查询结果的数量
*/ TotalCount?: number; /** *查询结果详情
注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array数据订阅实例的ID数组
*/ SubscribeIds?: Array迁移任务数量
*/ TotalCount?: number; /** *迁移任务列表
*/ JobList?: Array任务id,可通过DescribeMigrationJobs接口获取。
*/ JobId: string; /** *运行模式,取值如:immediate(表示立即运行)、timed(表示定时运行)
*/ RunMode: string; /** *迁移任务配置选项,描述任务如何执行迁移等一系列配置信息;字段下的RateLimitOption不可配置、如果需要修改任务的限速信息、请在任务运行后通过ModifyMigrateRateLimit接口修改
*/ MigrateOption: MigrateOption; /** *源实例信息
*/ SrcInfo: DBEndpointInfo; /** *目标实例信息
*/ DstInfo: DBEndpointInfo; /** *迁移任务名称,最大长度128
*/ JobName?: string; /** *期待启动时间,当RunMode取值为timed时,此值必填。
参数格式:当 DateTimeISOFormat=true 时按 RFC 3339 传入(如 2026-04-23T20:21:35+08:00),否则按 yyyy-mm-dd hh:mm:ss(北京时间)传入
标签信息
*/ Tags?: Array自动重试的时间段、可设置5至720分钟、0表示不重试
*/ AutoRetryTimeRangeMinutes?: number; } /** * StopCompare返回参数结构体 */ export interface StopCompareResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyMigrateJob返回参数结构体 */ export interface DestroyMigrateJobResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务步骤信息 */ export interface ProcessProgress { /** * 步骤的状态, 包括:notStarted(未开始)、running(运行中)、success(成功)、failed(失败)等 */ Status?: string; /** * 进度信息 */ Percent?: number; /** * 总的步骤数 */ StepAll?: number; /** * 当前进行的步骤 */ StepNow?: number; /** * 当前步骤输出提示信息 */ Message?: string; /** * 步骤信息 */ Steps?: Array数据迁移任务ID,如:dts-amm1jw5q
*/ JobId?: string; /** *数据迁移任务名称
*/ JobName?: string; /** *数据迁移任务状态,可取值包括:created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)
*/ Status?: Array源实例ID,格式如:cdb-c1nl9rpv
*/ SrcInstanceId?: string; /** *源实例地域,如:ap-guangzhou
*/ SrcRegion?: string; /** *源实例数据库类型,如:sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql
*/ SrcDatabaseType?: Array源实例接入类型,值包括:extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)
*/ SrcAccessType?: Array目标实例ID,格式如:cdb-c1nl9rpv
*/ DstInstanceId?: string; /** *目标实例地域,如:ap-guangzhou
*/ DstRegion?: string; /** *目标源实例数据库类型,如:sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql
*/ DstDatabaseType?: Array目标实例接入类型,值包括:extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)
*/ DstAccessType?: Array任务运行模式,值包括:immediate(立即运行),timed(定时运行)
*/ RunMode?: string; /** *排序方式,可能取值为asc、desc,默认按照创建时间倒序
*/ OrderSeq?: string; /** *返回实例数量,默认20,有效区间[1,100]
*/ Limit?: number; /** *偏移量,默认为0
*/ Offset?: number; /** *标签过滤
*/ TagFilters?: Array下单成功随机生成的迁移任务id列表,形如:dts-c1f6rs21
注意:此字段可能返回 null,表示取不到有效值。 */ JobIds?: Array投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json,debezium
*/ DataType?: string; /** *同步topic策略,如Single(集中投递到单topic),Multi (自定义topic名称)
*/ TopicType?: string; /** *用于存储ddl的topic
*/ DDLTopicName?: string; /** *单topic和自定义topic的描述
*/ TopicRules?: Array其他附加信息,对于特定数据类型可设置额外参数。比如针对Canal兼容的功能支持:"canalOfficialFormat":"on"表示打开Canal兼容功能,默认不带。针对大消息跳过的功能支持:"skipLargeMessage":"on"表示开启跳过大消息,默认不带;开启时需同时设置"maxMessageSizeMB"为1~100的正整数字符串,表示最大消息大小阈值(MB),超过该大小的消息将被跳过,默认不带。
*/ DataOption?: Array表示节点角色,针对分布式数据库,如mongodb中的mongos节点。tdsqlmysql的可选项:proxy表示节点类型为主机,set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填。
*/ Role?: string; /** *内核版本,针对mariadb的不同内核版本等
*/ DbKernel?: string; /** *实例的IP地址,对于公网、专线、VPN、云联网、自研上云、VPC等接入方式此项必填
*/ Host?: string; /** *实例的端口,对于公网、云主机自建、专线、VPN、云联网、自研上云、VPC等接入方式此项必填
*/ Port?: number; /** *实例的用户名
*/ User?: string; /** *实例的密码
*/ Password?: string; /** *CVM实例短ID,格式如:ins-olgl39y8;与云服务器控制台页面显示的实例ID相同;如果接入类型为云主机自建的方式,此项必填
*/ CvmInstanceId?: string; /** *VPN网关ID,格式如:vpngw-9ghexg7q;如果接入类型为vpncloud的方式,此项必填
*/ UniqVpnGwId?: string; /** *专线网关ID,格式如:dcg-0rxtqqxb;如果接入类型为专线接入的方式,此项必填
*/ UniqDcgId?: string; /** *数据库实例ID,格式如:cdb-powiqx8q;如果接入类型为云数据库的方式,此项必填
*/ InstanceId?: string; /** *云联网ID,如:ccn-afp6kltc 注意:此字段可能返回 null,表示取不到有效值。
*/ CcnGwId?: string; /** *私有网络ID,格式如:vpc-92jblxto;如果接入类型为vpc、vpncloud、ccn、dcg的方式,此项必填
*/ VpcId?: string; /** *私有网络下的子网ID,格式如:subnet-3paxmkdz;如果接入类型为vpc、vpncloud、ccn、dcg的方式,此项必填
*/ SubnetId?: string; /** *数据库版本,当实例为RDS实例时才有效,格式如:5.6或者5.7,默认为5.6
*/ EngineVersion?: string; /** *实例所属账号
*/ Account?: string; /** *跨账号迁移时的角色,只允许[a-zA-Z0-9-_]+
*/ AccountRole?: string; /** *资源所属账号 为空或self(表示本账号内资源)、other(表示其他账户资源)
*/ AccountMode?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpSecretId?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpSecretKey?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpToken?: string; /** *是否走加密传输、UnEncrypted表示不走加密传输,Encrypted表示走加密传输,默认UnEncrypted
*/ EncryptConn?: string; /** *tdsql的分片id。如节点类型为set必填。
*/ SetId?: string; } /** * 单topic和自定义topic的描述。投递到单topic时,该数组的最后一项会被视为默认分区策略,所有未匹配到的数据都会按该策略投递,默认策略只支持 投递至partition0、按表名、表名+主键三种。 */ export interface TopicRule { /** * topic名。单topic时,所有的TopicName必须相同 */ TopicName?: string; /** * topic分区策略,自定义topic时支持:Random(随机投递),集中投递到单Topic时支持:AllInPartitionZero(全部投递至partition0)、PartitionByTable(按表名分区)、PartitionByTableAndKey(按表名加主键分区)、PartitionByCols(按列分区) */ PartitionType?: string; /** * 库名匹配规则,如Regular(正则匹配), Default(不符合匹配规则的剩余库),数组中最后一项必须为‘Default’ */ DbMatchMode?: string; /** * 库名,DbMatchMode=Regular时生效 */ DbName?: string; /** * 表名匹配规则,如Regular(正则匹配), Default(不符合匹配规则的剩余表),数组中最后一项必须为‘Default’ */ TableMatchMode?: string; /** * 表名,仅TableMatchMode=Regular时生效 */ TableName?: string; /** * 按列分区时需要选择配置列名,可以选择多列 注意:此字段可能返回 null,表示取不到有效值。 */ Columns?: Array同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量);mongodb链路只支持全量数据初始化或仅增量。
*/ InitType?: string; /** *同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、ExecuteAfterIgnore(忽略并继续执行)
*/ DealOfExistSameTable?: string; /** *冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
*/ ConflictHandleType?: string; /** *是否添加附加列
*/ AddAdditionalColumn?: boolean; /** *所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), PartialDDL(自定义,和DdlOptions一起配合使用)。注意,这里至少需要包含DML中的一种。
注意:此字段可能返回 null,表示取不到有效值。 */ OpTypes?: Array冲突处理的详细选项,如条件覆盖中的条件行和条件操作
*/ ConflictHandleOption?: ConflictHandleOption; /** *DDL同步选项,具体描述要同步哪些DDL
注意:此字段可能返回 null,表示取不到有效值。 */ DdlOptions?: Arraykafka同步选项
*/ KafkaOption?: KafkaOption; /** *任务限速信息
*/ RateLimitOption?: RateLimitOption; /** *自动重试的时间窗口设置
*/ AutoRetryTimeRangeMinutes?: number; /** *同步到kafka链路指定位点。目前只支持时间格式:2023-12-20T19:24:23+08:00。如果没有指定位点,为空。
*/ StartPosition?: string; /** *同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
*/ FilterBeginCommit?: boolean; /** *同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
*/ FilterCheckpoint?: boolean; } /** * 一致性校验库表对象 */ export interface CompareObjectItem { /** *数据库名
*/ DbName: string; /** *数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象
*/ DbMode: string; /** *schema名称
*/ SchemaName?: string; /** *表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象
*/ TableMode?: string; /** *用于一致性校验的表配置,当 TableMode 为 partial 时,需要填写
*/ Tables?: Array视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象(一致性校验不校验视图,当前参数未启作用)
*/ ViewMode?: string; /** *用于一致性校验的视图配置,当 ViewMode 为 partial 时, 需要填写(一致性校验不校验视图,当前参数未启作用)
注意:此字段可能返回 null,表示取不到有效值。 */ Views?: Array同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过DescribeSyncJobs接口获取。
*/ JobId: string; /** *源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
*/ SrcAccessType: string; /** *目标端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
*/ DstAccessType: string; /** *同步库表对象信息
*/ Objects: Objects; /** *同步任务名称
*/ JobName?: string; /** *配置任务模式,默认值为fullMode
枚举值:
运行模式,取值如:Immediate(表示立即运行,默认为此项值)、Timed(表示定时运行)
*/ RunMode?: string; /** *期待启动时间,当 RunMode 取值为 Timed 时此值必填。当 DateTimeISOFormat=true 时按 RFC 3339 传入(如 2026-04-23T20:21:35+08:00),否则按 yyyy-mm-dd hh:mm:ss(北京时间)传入
源端tdsql连接方式:proxy-通过tdsql proxy主机访问各个set节点,注意只有在自研上云的网络环境下才能通过这种方式连接,SrcInfos中只需要提供proxy主机信息。set-直连set节点,如选择直连set方式,需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。
*/ SrcConnectType?: string; /** *源端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
*/ SrcInfo?: Endpoint; /** *源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
*/ SrcInfos?: SyncDBEndpointInfos; /** *枚举值:cluster、single。源库为单节点数据库使用single,多节点使用cluster
*/ SrcNodeType?: string; /** *目标端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
*/ DstInfo?: Endpoint; /** *目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
*/ DstInfos?: SyncDBEndpointInfos; /** *枚举值:cluster、single。目标库为单节点数据库使用single,多节点使用cluster
*/ DstNodeType?: string; /** *同步任务选项
*/ Options?: Options; /** *自动重试的时间段、可设置5至720分钟、0表示不重试
*/ AutoRetryTimeRangeMinutes?: number; } /** * pg对象owner不一致信息 */ export interface OwnerDifference { /** * owner不一致的pg对象所在库 */ Db?: string; /** * owner不一致的pg对象所在schema */ Schema?: string; /** * owner不一致的pg对象名 */ ObjectName?: string; /** * owner不一致的pg对象类型 */ ObjectType?: string; /** * 源库对象owner */ SrcOwner?: string; /** * 目标库对象owner */ DstOwner?: string; } /** * 订阅校验任务的各步骤信息。 */ export interface SubscribeCheckStepInfo { /** * 步骤名称 */ StepName?: string; /** * 步骤Id */ StepId?: string; /** * 步骤编号,从 1 开始 */ StepNo?: number; /** * 当前步骤状态,可能值为 notStarted-未开始,running-运行中,finished-已完成,failed-失败,unknown-未知 */ Status?: string; /** * 当前步骤进度 */ Percent?: number; /** * 错误提示 */ Errors?: Array数据库类型,如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。
*/ DatabaseType: string; /** *实例作为迁移的源还是目标,src(表示源),dst(表示目标)
*/ MigrateRole?: string; /** *云数据库实例ID,可通过对应业务实例列表获取实例信息。
*/ InstanceId?: string; /** *云数据库名称,可通过对应业务实例列表获取实例信息。
*/ InstanceName?: string; /** *返回数量限制
*/ Limit?: number; /** *偏移量
*/ Offset?: number; /** *资源所属账号 为空值或self(表示本账号内资源)、other(表示其他账户资源)
*/ AccountMode?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpSecretId?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpSecretKey?: string; /** *临时密钥Id,可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197,其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。
*/ TmpToken?: string; } /** * 校验任务运行详情 */ export interface CheckStepInfo { /** * 任务开始时间 */ StartAt?: string; /** * 任务结束时间 */ EndAt?: string; /** * 任务步骤信息 */ Progress?: ProcessProgress; } /** * 错误信息及告警信息对象 */ export interface ProcessStepTip { /** *提示信息
*/ Message?: string; /** *解决方案
*/ Solution?: string; /** *文档提示
*/ HelpDoc?: string; } /** * ModifyCompareTask请求参数结构体 */ export interface ModifyCompareTaskRequest { /** * 任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ JobId: string; /** * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ CompareTaskId: string; /** * 任务名称 */ TaskName?: string; /** * 数据对比对象模式,sameAsMigrate(全部迁移对象, 默认为此项配置)、custom(自定义),注意自定义对比对象必须是迁移对象的子集 */ ObjectMode?: string; /** * 对比对象,若CompareObjectMode取值为custom,则此项必填 */ Objects?: CompareObject; /** * 一致性校验选项 */ Options?: CompareOptions; } /** * StopMigrateJob请求参数结构体 */ export interface StopMigrateJobRequest { /** * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。 */ JobId: string; } /** * DDL/DML 过滤规则 */ export interface OpFilter { /** * DML 白名单 */ OpTypes?: Array需要迁移或同步的库名,当ObjectMode为Partial时,此项必填
*/ DbName?: string; /** *迁移或同步后的库名,默认与源库相同
*/ NewDbName?: string; /** *DB选择模式: All(为当前对象下的所有对象),Partial(部分对象),当Mode为Partial时,此项必填。注意,高级对象的同步不依赖此值,如果整库同步此处应该为All。
*/ DbMode?: string; /** *迁移或同步的 schema
*/ SchemaName?: string; /** *迁移或同步后的 schema name
*/ NewSchemaName?: string; /** *schema选择模式,pg和sqlserver需要使用
枚举值:
表选择模式: All(为当前对象下的所有对象),Partial(部分对象),当DBMode为Partial时此项必填,如果整库同步此处应该为All。
*/ TableMode?: string; /** *表图对象集合,当 TableMode 为 Partial 时,此项需要填写
*/ Tables?: Array