tencentcloud-sdk-nodejs/tencentcloud/services/dts/v20211206/dts_models.d.ts

腾讯云 API NODEJS SDK

/**
 * ModifyCompareTask返回参数结构体
 */
export interface ModifyCompareTaskResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSyncJobs返回参数结构体
 */
export interface DescribeSyncJobsResponse {
    /**
     * 任务数目
     */
    TotalCount?: number;
    /**
     * 任务详情数组
     */
    JobList?: Array<SyncJobInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyMigrationJob返回参数结构体
 */
export interface ModifyMigrationJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSyncCompareTask返回参数结构体
 */
export interface CreateSyncCompareTaskResponse {
    /**
     * 数据对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CompareTaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ResetConsumerGroupOffset返回参数结构体
 */
export interface ResetConsumerGroupOffsetResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyMigrateRateLimit返回参数结构体
 */
export interface ModifyMigrateRateLimitResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * IsolateMigrateJob返回参数结构体
 */
export interface IsolateMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 订阅实例信息
 */
export interface SubscribeInfo {
    /**
     * 数据订阅的实例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<EndpointItem>;
    /**
     * 数据订阅版本, 当前支持kafka和kafkaPro（专业版）
     */
    SubscribeVersion?: string;
    /**
     * 标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Tags?: Array<TagItem>;
    /**
     * 任务报错信息，如果有的话。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Errors?: Array<SubsErr>;
    /**
     * 订阅实例规格
     */
    InstanceClass?: 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?: Array<CompareTaskItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 表级 DDL/DML 过滤信息
 */
export interface TableFilter {
    /**
     * 规则生效的表名
     */
    TableName: string;
    /**
     * 表级 DDL/DML 过滤规则
     */
    OpFilter?: OpFilter;
}
/**
 * DestroyMigrateJob请求参数结构体
 */
export interface DestroyMigrateJobRequest {
    /**
     * 任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
  
     */
    JobId?: string;
}
/**
 * CreateSyncCompareTask请求参数结构体
 */
export interface CreateSyncCompareTaskRequest {
    /**
     * 任务 Id
     */
    JobId: string;
    /**
     * 数据对比任务名称，若为空则默认给CompareTaskId相同值
     */
    TaskName?: string;
    /**
     * 数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)，custom(自定义模式)
     */
    ObjectMode?: string;
    /**
     * 对比对象，当ObjectMode值为custom时，此项需要填写
     */
    Objects?: CompareObject;
    /**
     * 一致性校验选项
     */
    Options?: CompareOptions;
}
/**
 * 数据订阅kafka分区中checkpoint信息
 */
export interface OffsetTimeMap {
    /**
     * kafka分区编号
     */
    PartitionNo?: number;
    /**
     * kafka offset
     */
    Offset?: number;
}
/**
 * SkipCheckItem返回参数结构体
 */
export interface SkipCheckItemResponse {
    /**
     * 跳过的提示信息
     */
    Message?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ResumeSyncJob请求参数结构体
 */
export interface ResumeSyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
  
     */
    JobId: string;
}
/**
 * ModifySubscribeObjects请求参数结构体
 */
export interface ModifySubscribeObjectsRequest {
    /**
     * 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
    /**
     * 数据订阅的类型，非mongo任务的枚举值：0-全实例更新；1-数据更新；2-结构更新；3-数据更新+结构更新。mongo任务的枚举值：0-全实例更新；4-订阅单库；5-订阅单集合
     */
    SubscribeObjectType: number;
    /**
     * 修改后的订阅数据库表信息。会覆盖原来的订阅对象，所以除非 SubscribeObjectType = 0或2，否则该字段必填。
     */
    Objects?: Array<ModifiedSubscribeObject>;
    /**
     * kafka分区策略。如果不填，默认不修改。如果填了，会覆盖原来的策略。
     */
    DistributeRules?: Array<DistributeRule>;
    /**
     * 默认分区策略。不满足DistributeRules中正则表达式的数据，将按照默认分区策略计算分区。
  非mongo产品支持的默认策略: table-按表名分区，pk-按表名+主键分区。mongo的默认策略仅支持：collection-按集合名分区。
  该字段与DistributeRules搭配使用。如果配置了DistributeRules，该字段也必填。如果配置了该字段，视为配置了一条DistributeRules，原来的分区策略也会被覆盖。
     */
    DefaultRuleType?: string;
    /**
     * mongo输出聚合设置，mongo任务可选。如果不填，默认不修改。
     */
    PipelineInfo?: Array<PipelineInfo>;
}
/**
 * 数据订阅中kafka消费者组的分区分配情况。该数据是实时查询的，如果需要最新数据，需重新掉接口查询。
 */
export interface PartitionAssignment {
    /**
     * 消费者的clientId
     */
    ClientId: string;
    /**
     * 该消费者正在消费的分区
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PartitionNo: Array<number | bigint>;
}
/**
 * mongodb行校验不一致详细信息
 */
export interface RowsCountDifference {
    /**
     * 数据库名
     */
    Db?: string;
    /**
     * 集合
     */
    Table?: string;
    /**
     * 源端行数
     */
    SrcCount?: number;
    /**
     * 目标端行数
     */
    DstCount?: number;
}
/**
 * pg owner不一致性详情
 */
export interface DifferenceOwnerDetail {
    /**
     * owner不一致总数
     */
    TotalCount?: number;
    /**
     * owner不一致详情
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Items?: Array<OwnerDifference>;
}
/**
 * DescribeSyncCompareTasks请求参数结构体
 */
export interface DescribeSyncCompareTasksRequest {
    /**
     * 任务 Id
     */
    JobId: string;
    /**
     * 分页设置，表示每页显示多少条任务，默认为 20
     */
    Limit?: number;
    /**
     * 分页偏移量
     */
    Offset?: number;
    /**
     * 校验任务 ID
     */
    CompareTaskId?: string;
    /**
     * 任务状态过滤，可能的值：created - 创建完成；readyRun - 等待运行；running - 运行中；success - 成功；stopping - 结束中；failed - 失败；canceled - 已终止
     */
    Status?: Array<string>;
}
/**
 * ResizeSyncJob返回参数结构体
 */
export interface ResizeSyncJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopMigrateJob返回参数结构体
 */
export interface StopMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSubscribeCheckJob请求参数结构体
 */
export interface CreateSubscribeCheckJobRequest {
    /**
     * 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
}
/**
 * ResumeMigrateJob返回参数结构体
 */
export interface ResumeMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 校验不一致的表详情
 */
export interface DifferenceItem {
    /**
     * 数据库名
     */
    Db?: string;
    /**
     * schema
     */
    Schema?: string;
    /**
     * 表名
     */
    Table?: string;
    /**
     * 分块号
     */
    Chunk?: number;
    /**
     * 源库数值
     */
    SrcItem?: string;
    /**
     * 目标库数值
     */
    DstItem?: string;
    /**
     * 索引名称
     */
    IndexName?: string;
    /**
     * 索引下边界
     */
    LowerBoundary?: string;
    /**
     * 索引上边界
     */
    UpperBoundary?: string;
    /**
     * 对比消耗时间,单位为 ms
     */
    CostTime?: number;
    /**
     * 完成时间
     */
    FinishedAt?: string;
}
/**
 * CreateModifyCheckSyncJob请求参数结构体
 */
export interface CreateModifyCheckSyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    JobId: string;
}
/**
 * IsolateSyncJob请求参数结构体
 */
export interface IsolateSyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    JobId: string;
}
/**
 * PauseMigrateJob请求参数结构体
 */
export interface PauseMigrateJobRequest {
    /**
     * 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
  
     */
    JobId: string;
}
/**
 * 不一致的表的校验结果详情。增量和全量都是这个结构，某些字段对增量没有意义，可以忽略。
 */
export interface CompareTableResult {
    /**
     * 库名
     */
    Db?: string;
    /**
     * schema名
     */
    Schema?: string;
    /**
     * 表名
     */
    Table?: string;
    /**
     * 校验结果
     */
    Conclusion?: string;
    /**
     * 校验状态。仅全量阶段有意义
     */
    Status?: string;
    /**
     * 校验进度。仅全量阶段有意义
     */
    Progress?: number;
    /**
     * 不一致行数
     */
    RowCount?: number;
    /**
     * 该表开始校验的时间
     */
    StartedAt?: string;
    /**
     * 该表校验结束的时间
     */
    FinishedAt?: string;
    /**
     * 预计该表校验结束的时间
     */
    ExpectedAt?: string;
    /**
     * 源端行数，如果是行数校验此值有意义
     */
    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](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    SubscribeId: string;
    /**
     * 订阅的kafka topic，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    TopicName: string;
    /**
     * 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/api/571/102947)接口获取。
     */
    ConsumerGroupName: string;
    /**
     * 需要修改offset的分区编号，可通过[DescribeOffsetByTime](https://cloud.tencent.com/document/api/571/102946)接口获取。
     */
    PartitionNos: Array<number | bigint>;
    /**
     * 重置方式。枚举值为 earliest-从最开始位置开始消费；latest-从最新位置开始消费；datetime-从指定时间前最近的checkpoint开始消费
     */
    ResetMode: string;
    /**
     * 当 ResetMode 为 datetime 时，该项需要填，格式为：Y-m-d h:m:s。如果不填，默认用0时间，效果与earliest相同。
     */
    ResetDatetime?: string;
}
/**
 * ModifySyncRateLimit请求参数结构体
 */
export interface ModifySyncRateLimitRequest {
    /**
     * 同步任务ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    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<TableFilter>;
    /**
     * 视图级 DDL/DML 过滤信息
     */
    Views?: Array<ViewFilter>;
}
/**
 * 表对象集合，当 TableMode 为 partial 时，此项需要填写
 */
export interface TableItem {
    /**
     * 迁移的表名，大小写敏感
     */
    TableName?: string;
    /**
     * 迁移后的表名，当TableEditMode为rename时此项必填，注意此配置与TmpTables互斥，只能使用其中一种
     */
    NewTableName?: string;
    /**
     * 迁移临时表，注意此配置与NewTableName互斥，只能使用其中一种。当配置的同步对象为表级别且TableEditMode为pt时此项有意义，针对pt-osc等工具在迁移过程中产生的临时表进行同步，需要提前将可能的临时表配置在这里，否则不会同步任何临时表。示例，如要对t1进行pt-osc操作，此项配置应该为["\_t1\_new","\_t1\_old"]；如要对t1进行gh-ost操作，此项配置应该为["\_t1\_ghc","\_t1\_gho","\_t1\_del"]，pt-osc与gh-ost产生的临时表可同时配置。
     */
    TmpTables?: Array<string>;
    /**
     * 编辑表类型，rename(表映射)，pt(同步附加表)
     */
    TableEditMode?: string;
}
/**
 * 表结构不一致信息
 */
export interface DifferenceSchemaDetail {
    /**
     * 表结构不一致的数量
     */
    TotalCount?: number;
    /**
     * 表结构不一致信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Items?: Array<SchemaDifference>;
}
/**
 * ModifyCompareTaskName请求参数结构体
 */
export interface ModifyCompareTaskNameRequest {
    /**
     * 迁移任务 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;
}
/**
 * CompleteMigrateJob返回参数结构体
 */
export interface CompleteMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigrateDBInstances返回参数结构体
 */
export interface DescribeMigrateDBInstancesResponse {
    /**
     * <p>符合筛选条件的数量</p>
     */
    TotalCount?: number;
    /**
     * <p>实例列表</p>
     */
    Instances?: Array<MigrateDBItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 存放配置时的额外信息
 */
export interface KeyValuePairOption {
    /**
     * 选项key
     */
    Key?: string;
    /**
     * 选项value
     */
    Value?: string;
}
/**
 * 数据不一致详情
 */
export interface DifferenceData {
    /**
     * 数据库名
     */
    Db?: string;
    /**
     * 集合
     */
    Table?: string;
    /**
     * 源端ID
     */
    SrcChunk?: string;
    /**
     * 目标端ID
     */
    DstChunk?: string;
    /**
     * 源端值
     */
    SrcItem?: string;
    /**
     * 目标端值
     */
    DstItem?: string;
    /**
     * 创建时间
     */
    CreatedAt?: string;
    /**
     * 更新时间
     */
    UpdatedAt?: string;
}
/**
 * DescribeSyncCompareDiffItems返回参数结构体
 */
export interface DescribeSyncCompareDiffItemsResponse {
    /**
     * 查询结果的数量
     */
    TotalCount?: number;
    /**
     * 查询结果详情
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Items?: Array<DiffChunkItem>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateCheckSyncJob请求参数结构体
 */
export interface CreateCheckSyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
  
     */
    JobId: string;
}
/**
 * StopSyncCompare请求参数结构体
 */
export interface StopSyncCompareRequest {
    /**
     * 任务 Id
     */
    JobId: string;
    /**
     * 对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9
     */
    CompareTaskId: string;
    /**
     * 是否强制停止。如果填true，迁移任务增量阶段会跳过一致性校验产生的binlog，达到快速恢复任务的效果
     */
    ForceStop?: boolean;
}
/**
 * DescribeModifyCheckSyncJobResult返回参数结构体
 */
export interface DescribeModifyCheckSyncJobResultResponse {
    /**
     * 校验任务执行状态，如：notStarted(未开始)、running(校验中)、failed(校验任务失败)、success(任务成功)
     */
    Status?: string;
    /**
     * 校验的步骤总数
     */
    StepCount?: number;
    /**
     * 当前所在步骤
     */
    StepCur?: number;
    /**
     * 总体进度，范围为[0,100]
     */
    Progress?: number;
    /**
     * 步骤详细信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StepInfos?: Array<StepInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartModifySyncJob返回参数结构体
 */
export interface StartModifySyncJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSubscribeReturnable请求参数结构体
 */
export interface DescribeSubscribeReturnableRequest {
    /**
     * 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
}
/**
 * DescribeMigrationDetail请求参数结构体
 */
export interface DescribeMigrationDetailRequest {
    /**
     * 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
  
     */
    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<RowsCountDifference>;
}
/**
 * ModifySubscribeName返回参数结构体
 */
export interface ModifySubscribeNameResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据同步中的ddl同步处理
 */
export interface DdlOption {
    /**
     * ddl类型，如Database,Table,View,Index等
     */
    DdlObject?: string;
    /**
     * ddl具体值，对于Database可取值[Create,Drop,Alter]<br>对于Table可取值[Create,Drop,Alter,Truncate,Rename]<br/>对于View可取值[Create,Drop]<br/>对于Index可取值[Create,Drop]
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DdlValue?: Array<string>;
}
/**
 * 冲突处理里的详细描述
 */
export interface ConflictHandleOption {
    /**
     * 条件覆盖的列
     */
    ConditionColumn?: string;
    /**
     * 条件覆盖操作，目前仅支持>
     */
    ConditionOperator?: string;
    /**
     * 条件覆盖优先级处理，支持类型有>,<,=
     */
    ConditionOrderInSrcAndDst?: string;
}
/**
 * mongo输出聚合设置。输出默认 Change Event
 */
export interface PipelineInfo {
    /**
     * 聚合运算符：$addFields、$match、$project、$replaceRoot、$redact、$replaceWith、$set、$unset。其中 $replaceWith、$set、$unset 只有当订阅实例是4.2及以上版本可选。
     */
    AggOp?: string;
    /**
     * 聚合表达式。必须是json格式
     */
    AggCmd?: string;
}
/**
 * ResumeSyncJob返回参数结构体
 */
export interface ResumeSyncJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RecoverMigrateJob返回参数结构体
 */
export interface RecoverMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyCompareTaskName返回参数结构体
 */
export interface ModifyCompareTaskNameResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 增量校验阶段的摘要信息
 */
export interface IncCompareAbstractInfo {
    /**
     * 增量起始位点
     */
    StartPosition?: string;
    /**
     * 增量当前位点
     */
    CurrentPosition?: string;
    /**
     * 已校验行数
     */
    CheckedRecord?: number;
    /**
     * 不一致行数
     */
    DiffRecord?: number;
    /**
     * 不一致表的数量
     */
    DiffTable?: number;
}
/**
 * 同步任务信息
 */
export interface SyncJobInfo {
    /**
     * 同步任务id，如：sync-btso140
     */
    JobId?: string;
    /**
     * 同步任务名
     */
    JobName?: string;
    /**
     * 付款方式，PostPay(按量付费)、PrePay(包年包月)
     */
    PayMode?: string;
    /**
     * 运行模式，Immediate(表示立即运行，默认为此项值)、Timed(表示定时运行)
     */
    RunMode?: string;
    /**
     * 期待运行时间，格式为 yyyy-mm-dd hh:mm:ss
     */
    ExpectRunTime?: string;
    /**
     * 支持的所有操作
     */
    AllActions?: Array<string>;
    /**
     * 当前状态能进行的操作
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Actions?: Array<string>;
    /**
     * 同步选项
     */
    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;
    /**
     * 创建时间，格式为 yyyy-mm-dd hh:mm:ss
     */
    CreateTime?: string;
    /**
     * 开始时间，格式为 yyyy-mm-dd hh:mm:ss
     */
    StartTime?: string;
    /**
     * 任务状态，UnInitialized(未初始化)、Initialized(已初始化)、Checking(校验中)、CheckPass(校验通过)、CheckNotPass(校验不通过)、ReadyRunning(准备运行)、Running(运行中)、Pausing(暂停中)、Paused(已暂停)、Stopping(停止中)、Stopped(已结束)、ResumableErr(任务错误)、Resuming(恢复中)、Failed(失败)、Released(已释放)、Resetting(重置中)、Unknown(未知)
     */
    Status?: string;
    /**
     * 结束时间，格式为 yyyy-mm-dd hh:mm:ss
     */
    EndTime?: string;
    /**
     * 标签相关信息
     */
    Tags?: Array<TagItem>;
    /**
     * 同步任务运行步骤信息
     */
    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<OffsetTimeMap>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * PauseSyncJob请求参数结构体
 */
export interface PauseSyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
  
     */
    JobId: string;
}
/**
 * CreateMigrateCheckJob返回参数结构体
 */
export interface CreateMigrateCheckJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifySyncJobConfig请求参数结构体
 */
export interface ModifySyncJobConfigRequest {
    /**
     * 同步任务ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
     */
    JobId: string;
    /**
     * 修改后的同步对象
     */
    DynamicObjects?: Objects;
    /**
     * 修改后的同步任务选项
     */
    DynamicOptions?: DynamicOptions;
}
/**
 * ContinueMigrateJob返回参数结构体
 */
export interface ContinueMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateMigrationService请求参数结构体
 */
export interface CreateMigrationServiceRequest {
    /**
     * <p>源实例数据库类型，如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore</p><p>枚举值：</p><ul><li>mysql： MySQL数据库</li></ul>
     */
    SrcDatabaseType: string;
    /**
     * <p>目标实例数据库类型，如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore,tendis</p><p>枚举值：</p><ul><li>mysql： MySQL数据库</li></ul>
     */
    DstDatabaseType: string;
    /**
     * <p>源实例地域，如：ap-guangzhou</p>
     */
    SrcRegion: string;
    /**
     * <p>目标实例地域，如：ap-guangzhou。注意，目标地域必须和API请求地域保持一致。</p>
     */
    DstRegion: string;
    /**
     * <p>实例规格，包括：small、medium、large、xlarge、2xlarge。当前未计费链路仅支持medium字段值。不同规格类型参考<a href="https://cloud.tencent.com/document/product/571/18736">计费概述</a></p>
     */
    InstanceClass: string;
    /**
     * <p>购买数量，范围为[1,15]，默认为1</p>
     */
    Count?: number;
    /**
     * <p>迁移服务名称，最大长度128</p>
     */
    JobName?: string;
    /**
     * <p>标签信息</p>
     */
    Tags?: Array<TagItem>;
}
/**
 * 每个检查步骤里的具体检查项
 */
export interface DetailCheckItem {
    /**
     * 检查项的名称，如：源实例权限检查
     */
    CheckItemName?: string;
    /**
     * 检查项详细内容
     */
    Description?: string;
    /**
     * pass(通过)，failed(失败), warning(校验有警告，但仍通过)
     */
    CheckResult?: string;
    /**
     * 检查项失败原因
     */
    FailureReason?: string;
    /**
     * 解决方案
     */
    Solution?: string;
    /**
     * 运行报错日志
     */
    ErrorLog?: Array<string>;
    /**
     * 详细帮助的文档链接
     */
    HelpDoc?: Array<string>;
    /**
     * 跳过风险文案
     */
    SkipInfo?: string;
}
/**
 * DescribeCompareTasks请求参数结构体
 */
export interface DescribeCompareTasksRequest {
    /**
     * 迁移任务 Id，可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。
  
     */
    JobId: string;
    /**
     * 分页设置，表示每页显示多少条任务，默认为 20
     */
    Limit?: number;
    /**
     * 分页偏移量
     */
    Offset?: number;
    /**
     * 校验任务 ID
     */
    CompareTaskId?: string;
    /**
     * 任务状态过滤，可能的值：created - 创建完成；readyRun - 等待运行；running - 运行中；success - 成功；stopping - 结束中；failed - 失败；canceled - 已终止
     */
    Status?: Array<string>;
}
/**
 * DestroyIsolatedSubscribe请求参数结构体
 */
export interface DestroyIsolatedSubscribeRequest {
    /**
     * 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
}
/**
 * ResetSubscribe返回参数结构体
 */
export interface ResetSubscribeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 一致性对比对象配置
 */
export interface CompareObject {
    /**
     * 对象模式 整实例-all,部分对象-partial
     */
    ObjectMode: string;
    /**
     * 对象列表
     */
    ObjectItems?: Array<CompareObjectItem>;
    /**
     * 高级对象类型，目前只支持mongodb链路。如index(索引),shardkey(片键),schema(库表)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AdvancedObjects?: Array<string>;
}
/**
 * DescribeCompareReport返回参数结构体
 */
export interface DescribeCompareReportResponse {
    /**
     * <p>一致性校验摘要信息</p>
     */
    Abstract?: CompareAbstractInfo;
    /**
     * <p>一致性校验详细信息</p>
     */
    Detail?: CompareDetailInfo;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSyncGtidCompareReport返回参数结构体
 */
export interface DescribeSyncGtidCompareReportResponse {
    /**
     * 校验结论
     */
    Conclusion?: string;
    /**
     * 校验状态
     */
    Status?: string;
    /**
     * 校验类型
     */
    Type?: string;
    /**
     * 不一致详情
     */
    Detail?: Array<DifferenceDetails>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RecoverSyncJob返回参数结构体
 */
export interface RecoverSyncJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 任务操作信息，包含迁移任务的所有操作列表，及迁移任务在当前状态下允许的操作列表
 */
export interface MigrateAction {
    /**
     * 任务的所有操作列表
     */
    AllAction?: Array<string>;
    /**
     * 任务在当前状态下允许的操作列表
     */
    AllowedAction?: Array<string>;
}
/**
 * ConfigureSubscribeJob返回参数结构体
 */
export interface ConfigureSubscribeJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeConsumerGroups请求参数结构体
 */
export interface DescribeConsumerGroupsRequest {
    /**
     * 订阅实例id，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    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<MonitorInfo>;
    /**
     * 消费者组创建时间，格式为YYYY-MM-DD hh:mm:ss
     */
    CreatedAt?: string;
    /**
     * 消费者组修改时间，格式为YYYY-MM-DD hh:mm:ss
     */
    UpdatedAt?: string;
    /**
     * 消费者组状态，包括Dead、Empty、Stable等，只有Dead和Empty两种状态可以执行reset操作
     */
    ConsumerGroupState?: string;
    /**
     * 每个消费者正在消费的分区
     */
    PartitionAssignment?: Array<PartitionAssignment>;
}
/**
 * DeleteCompareTask返回参数结构体
 */
export interface DeleteCompareTaskResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 实例信息
 */
export interface DBEndpointInfo {
    /**
     * 实例所在地域
     */
    Region: string;
    /**
     * 实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云服务器自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路
     */
    AccessType: string;
    /**
     * 实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等
     */
    DatabaseType: string;
    /**
     * 节点类型，simple表示普通节点、cluster表示集群节点；
  对于mongo业务，取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)；
  对于redis实例，simple(单节点)、cluster-cache(直连集群)、cluster-proxy(代理集群)；
     */
    NodeType: string;
    /**
     * 实例具体的连接信息，如ip、port、接入方式等
     */
    Info: Array<DBInfo>;
    /**
     * 实例服务提供商，如:"others","aliyun","aws"
     */
    Supplier?: string;
    /**
     * 此参数为数组类型，可以传多个键值对结构对象。
  MongoDB可定义如下的参数：
  'AuthDatabase':'admin',    //认证库
  'AuthFlag': "1",       //实例是否需要认证，"0": 不用认证；"1":需要认证
  'AuthMechanism':"SCRAM-SHA-1",    //实例认证方式
  "fetchMethod":"oplog",    //fetchMethod表示迁移方式，支持oplog、change_stream
  "connectMode":"srv",    //外网srv连接模式
  "EncryptedConnProtocol":"mongo_atlas_ssl"；    //加密连接方式
  其中fetchMethod表示迁移方式，还可支持change_stream；EncryptedConnProtocol值为mongo_atlas_ssl表示使用atlas ssl连接方式。
     */
    ExtraAttr?: Array<KeyValuePairOption>;
    /**
     * 数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；
     */
    DatabaseNetEnv?: string;
    /**
     * tdsql连接方式：proxy-通过tdsql proxy主机访问各个set节点，注意只有在自研上云的网络环境下才能通过这种方式连接，Info中只需要提供proxy主机信息。set-直连set节点，如选择直连set方式，Info中需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。
     */
    ConnectType?: string;
    /**
     * 云联网网关所属账号，如果云联网网关为其他账号资源需要填写
     */
    CcnOwnerUin?: string;
}
/**
 * ResumeSubscribe请求参数结构体
 */
export interface ResumeSubscribeRequest {
    /**
     * 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
}
/**
 * ModifySyncJobConfig返回参数结构体
 */
export interface ModifySyncJobConfigResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 列选项
 */
export interface CompareColumnItem {
    /**
     * 列名
     */
    ColumnName?: string;
}
/**
 * 数据块内不一致数据的详情信息
 */
export interface DiffChunkItem {
    /**
     * 数据库名
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DBName?: string;
    /**
     * schema名
     */
    SchemaName?: string;
    /**
     * 数据表名
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TableName?: string;
    /**
     * 分块号
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ChunkId?: number;
    /**
     * 数据标识符，比如主键信息等
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Identifier?: string;
    /**
     * 不一致类型，可能的取值为：data - 两边数据不一致；srcLack - 源缺失；dstLack - 目标缺失
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DiffType?: string;
    /**
     * 表结构信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SchemaInfo?: Array<string>;
    /**
     * 源端数据
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SrcItem?: Array<string>;
    /**
     * 目标端数据
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DstItem?: Array<string>;
    /**
     * 完成时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FinishedAt?: string;
}
/**
 * ModifySyncCompareTaskName返回参数结构体
 */
export interface ModifySyncCompareTaskNameResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSubscribeDetail返回参数结构体
 */
export interface DescribeSubscribeDetailResponse {
    /**
     * 数据订阅的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;
    /**
     * 修改时间，时间格式如：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;
    /**
     * 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?: Array<SubscribeObject>;
    /**
     * kafka配置信息
     */
    KafkaConfig?: SubscribeKafkaConfig;
    /**
     * 订阅内置kafka的版本信息
     */
    KafkaVersion?: string;
    /**
     * 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
     */
    AccessType?: string;
    /**
     * 接入类型信息
     */
    Endpoints?: Array<EndpointItem>;
    /**
     * mongo输出聚合设置
     */
    PipelineInfo?: Array<PipelineInfo>;
    /**
     * 标签
     */
    Tags?: Array<TagItem>;
    /**
     * 订阅任务报错信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Errors?: Array<SubsErr>;
    /**
     * 为业务添加的额外信息。参数名作key，参数值作value。
  mysql选填参数：ProcessXA-是否处理XA事务，为true处理，其他不处理。
  mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream。
     */
    ExtraAttr?: Array<KeyValuePairOption>;
    /**
     * 数据订阅版本, 当前支持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;
    /**
     * 到期时间，格式为"yyyy-mm-dd hh:mm:ss"
     */
    ExpireTime?: string;
    /**
     * 下线时间，格式为"yyyy-mm-dd hh:mm:ss"
     */
    OfflineTime?: string;
    /**
     * 隔离时间，格式为"yyyy-mm-dd hh:mm:ss"
     */
    IsolateTime?: string;
    /**
     * 下线原因
     */
    OfflineReason?: string;
    /**
     * 隔离原因
     */
    IsolateReason?: string;
    /**
     * 付费类型，包括：postpay(后付费)、prepay(预付费)
     */
    PayType?: string;
    /**
     * 任务计费类型，包括：billing(计费)、notBilling(不计费)、 promotions(促销活动中)
     */
    BillingType?: string;
}
/**
 * mongodb数据不一致性详情
 */
export interface DifferenceDataDetail {
    /**
     * 总数
     */
    TotalCount?: number;
    /**
     * mongo数据不一致详细列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Items?: Array<DifferenceData>;
}
/**
 * StartSyncCompare返回参数结构体
 */
export interface StartSyncCompareResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteConsumerGroup请求参数结构体
 */
export interface DeleteConsumerGroupRequest {
    /**
     * 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
  
     */
    SubscribeId: string;
    /**
     * 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
  请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
     */
    ConsumerGroupName: string;
    /**
     * 账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。
  请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
     */
    AccountName: string;
}
/**
 * ModifySubscribeAutoRenewFlag请求参数结构体
 */
export interface ModifySubscribeAutoRenewFlagRequest {
    /**
     * 订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
     */
    SubscribeId: string;
    /**
     * 自动续费标识。1-自动续费，0-不自动续费
     */
    AutoRenewFlag: number;
}
/**
 * CompleteMigrateJob请求参数结构体
 */
export interface CompleteMigrateJobRequest {
    /**
     * 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
  
     */
    JobId: string;
    /**
     * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成，不会等待主从差距一致。默认为waitForSync
     */
    CompleteMode?: string;
}
/**
 * CreateConsumerGroup返回参数结构体
 */
export interface CreateConsumerGroupResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopCompare请求参数结构体
 */
export interface StopCompareRequest {
    /**
     * 迁移任务 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;
    /**
     * 是否强制停止。默认值为false，表示不强制停止；如果填true，同步任务增量阶段会跳过一致性校验产生的binlog，达到快速恢复任务的效果
     */
    ForceStop?: boolean;
}
/**
 * 数据同步配置多节点数据库的节点信息。多节点数据库，如tdsqlmysql使用该结构；单节点数据库，如mysql使用Endpoint。
 */
export interface SyncDBEndpointInfos {
    /**
     * 数据库所在地域
     */
    Region: string;
    /**
     * 实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路
     */
    AccessType: string;
    /**
     * 实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等
     */
    DatabaseType: string;
    /**
     * 数据库信息。注意：如果数据库类型为tdsqlmysql，此处Endpoint数组的顺序应满足规则：proxy节点放在set节点之前。如果SrcConnectType选择proxy接入则只需要填写proxy节点即可。如果选择set接入，数组中第一个set节点必须是shardkey范围起始为0的分片
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Info: Array<Endpoint>;
}
/**
 * StartModifySyncJob请求参数结构体
 */
export interface StartModifySyncJobRequest {
    /**
     * 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
  
     */
    JobId: string;
}
/**
 * DescribeCheckSyncJobResult返回参数结构体
 */
export interface DescribeCheckSyncJobResultResponse {
    /**
     * 校验任务执行状态，如：notStarted(未开始)、running(校验中)、failed(校验任务失败)、success(任务成功)
     */
    Status?: string;
    /**
     * 步骤总数
     */
    StepCount?: number;
    /**
     * 当前所在步骤
     */
    StepCur?: number;
    /**
     * 总体进度，范围为[0,100]
     */
    Progress?: number;
    /**
     * 步骤信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StepInfos?: Array<StepInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopSyncJob返回参数结构体
 */
export interface StopSyncJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 迁移选项，描述任务如何执行迁移等一系列配置信息
 */
export interface MigrateOption {
    /**
     * <p>迁移对象选项，需要告知迁移服务迁移哪些库表对象</p>
     */
    DatabaseTable: DatabaseTableObject;
    /**
     * <p>迁移类型，full(全量迁移)，structure(结构迁移)，fullAndIncrement(全量加增量迁移)， 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。</p>
     */
    MigrateType?: string;
    /**
     * <p>数据一致性校验选项， 默认为不开启一致性校验</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Consistency?: ConsistencyOption;
    /**
     * <p>是否迁移账号，true(迁移账号)，false(不迁移账号)</p>
     */
    IsMigrateAccount?: boolean;
    /**
     * <p>是否用源库Root账户覆盖目标库，值包括：false-不覆盖，true-覆盖，选择库表或者结构迁移时应该为false，注意只对旧版迁移有效</p>
     */
    IsOverrideRoot?: boolean;
    /**
     * <p>是否在迁移时设置目标库只读(仅对mysql有效)，true(设置只读)、false(不设置只读，默认此值)</p>
     */
    IsDstReadOnly?: boolean;
    /**
     * <p>其他附加信息，对于特定库可设置额外参数，Redis可定义如下的参数:<br>[&quot;DstWriteMode&quot;:normal,     目标库写入模式,可取值clearData(清空目标实例数据)、overwri