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

腾讯云 API NODEJS SDK

/**
 * DescribeMigrateJobs返回参数结构体
 */
export interface DescribeMigrateJobsResponse {
    /**
     * 任务数目
     */
    TotalCount?: number;
    /**
     * 任务详情数组
     */
    JobList?: Array<MigrateJobInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 迁移中的步骤信息
 */
export interface MigrateStepDetailInfo {
    /**
     * 步骤序列
     */
    StepNo?: number;
    /**
     * 步骤展现名称
     */
    StepName?: string;
    /**
     * 步骤英文标识
     */
    StepId?: string;
    /**
     * 步骤状态:0-默认值,1-成功,2-失败,3-执行中,4-未执行
     */
    Status?: number;
    /**
     * 当前步骤开始的时间，格式为"yyyy-mm-dd hh:mm:ss"，该字段不存在或者为空是无意义
     */
    StartTime?: string;
}
/**
 * DeleteMigrateJob返回参数结构体
 */
export interface DeleteMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateMigrateCheckJob请求参数结构体
 */
export interface CreateMigrateCheckJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
}
/**
 * ModifySubscribeVipVport请求参数结构体
 */
export interface ModifySubscribeVipVportRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
    /**
     * 指定目的子网，如果传此参数，DstIp必须在目的子网内
     */
    DstUniqSubnetId?: string;
    /**
     * 目标IP，与DstPort至少传一个
     */
    DstIp?: string;
    /**
     * 目标PORT，支持范围为：[1025-65535]
     */
    DstPort?: number;
}
/**
 * ModifySubscribeName返回参数结构体
 */
export interface ModifySubscribeNameResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigrateCheckJob请求参数结构体
 */
export interface DescribeMigrateCheckJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
}
/**
 * IsolateSubscribe返回参数结构体
 */
export interface IsolateSubscribeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifySubscribeObjects返回参数结构体
 */
export interface ModifySubscribeObjectsResponse {
    /**
     * 异步任务的ID
     */
    AsyncRequestId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateMigrateJob请求参数结构体
 */
export interface CreateMigrateJobRequest {
    /**
     * 数据迁移任务名称
     */
    JobName: string;
    /**
     * 迁移任务配置选项
     */
    MigrateOption: MigrateOption;
    /**
     * 源实例数据库类型，目前支持：mysql，redis，mongodb，postgresql，mariadb，percona，sqlserver 不同地域数据库类型的具体支持情况，请参考控制台创建迁移页面。
     */
    SrcDatabaseType: string;
    /**
     * 源实例接入类型，值包括：extranet(外网),cvm(CVM自建实例),dcg(专线接入的实例),vpncloud(云VPN接入的实例),cdb(腾讯云数据库实例),ccn(云联网实例)
     */
    SrcAccessType: string;
    /**
     * 源实例信息，具体内容跟迁移任务类型相关
     */
    SrcInfo: SrcInfo;
    /**
     * 目标实例数据库类型，目前支持：mysql，redis，mongodb，postgresql，mariadb，percona，sqlserver，cynosdbmysql。不同地域数据库类型的具体支持情况，请参考控制台创建迁移页面。
     */
    DstDatabaseType: string;
    /**
     * 目标实例接入类型，目前支持：cdb（腾讯云数据库实例）
     */
    DstAccessType: string;
    /**
     * 目标实例信息
     */
    DstInfo: DstInfo;
    /**
     * 需要迁移的源数据库表信息，用json格式的字符串描述。当MigrateOption.MigrateObject配置为2（指定库表迁移）时必填。
  对于database-table两级结构的数据库：
  [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
  对于database-schema-table三级结构：
  [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
     */
    DatabaseInfo?: string;
    /**
     * 迁移实例的tag
     */
    Tags?: Array<TagItem>;
    /**
     * 源实例类型: ""或者"simple":主从节点，"cluster": 集群节点
     */
    SrcNodeType?: string;
    /**
     * 源实例信息，具体内容跟迁移任务类型相关
     */
    SrcInfoMulti?: Array<SrcInfo>;
}
/**
 * ModifySubscribeName请求参数结构体
 */
export interface ModifySubscribeNameRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
    /**
     * 数据订阅实例的名称，长度限制为[1,60]
     */
    SubscribeName: string;
}
/**
 * ModifySubscribeConsumeTime返回参数结构体
 */
export interface ModifySubscribeConsumeTimeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 目的实例信息，具体内容跟迁移任务类型相关
 */
export interface DstInfo {
    /**
     * 目标实例地域，如ap-guangzhou
     */
    Region: string;
    /**
     * 目标实例ID，如cdb-jd92ijd8
     */
    InstanceId?: string;
    /**
     * 目标实例vip。已废弃，无需填写
     */
    Ip?: string;
    /**
     * 目标实例vport。已废弃，无需填写
     */
    Port?: number;
    /**
     * 目前只对MySQL有效。当为整实例迁移时，1-只读，0-可读写。
     */
    ReadOnly?: number;
    /**
     * 目标数据库账号
     */
    User?: string;
    /**
     * 目标数据库密码
     */
    Password?: string;
}
/**
 * DescribeSubscribeConf返回参数结构体
 */
export interface DescribeSubscribeConfResponse {
    /**
     * 订阅实例ID
     */
    SubscribeId?: string;
    /**
     * 订阅实例名称
     */
    SubscribeName?: string;
    /**
     * 订阅通道
     */
    ChannelId?: string;
    /**
     * 订阅数据库类型
     */
    Product?: string;
    /**
     * 被订阅的实例
     */
    InstanceId?: string;
    /**
     * 被订阅的实例的状态，可能的值有running,offline,isolate
     */
    InstanceStatus?: string;
    /**
     * 订阅实例状态，可能的值有unconfigure-未配置，configuring-配置中，configured-已配置
     */
    SubsStatus?: string;
    /**
     * 订阅实例生命周期状态，可能的值有：normal-正常，isolating-隔离中，isolated-已隔离，offlining-下线中
     */
    Status?: string;
    /**
     * 订阅实例创建时间
     */
    CreateTime?: string;
    /**
     * 订阅实例被隔离时间
     */
    IsolateTime?: string;
    /**
     * 订阅实例到期时间
     */
    ExpireTime?: string;
    /**
     * 订阅实例下线时间
     */
    OfflineTime?: string;
    /**
     * 订阅实例消费时间起点。
     */
    ConsumeStartTime?: string;
    /**
     * 订阅实例计费类型，1-小时计费，0-包年包月
     */
    PayType?: number;
    /**
     * 订阅通道Vip
     */
    Vip?: string;
    /**
     * 订阅通道Port
     */
    Vport?: number;
    /**
     * 订阅通道所在VpcId
     */
    UniqVpcId?: string;
    /**
     * 订阅通道所在SubnetId
     */
    UniqSubnetId?: string;
    /**
     * 当前SDK消费时间位点
     */
    SdkConsumedTime?: string;
    /**
     * 订阅SDK IP地址
     */
    SdkHost?: string;
    /**
     * 订阅对象类型0-全实例订阅，1-DDL数据订阅，2-DML结构订阅，3-DDL数据订阅+DML结构订阅
     */
    SubscribeObjectType?: number;
    /**
     * 订阅对象，当SubscribeObjectType 为0时，此字段为空数组
     */
    SubscribeObjects?: Array<SubscribeObject>;
    /**
     * 修改时间
     */
    ModifyTime?: string;
    /**
     * 地域
     */
    Region?: string;
    /**
     * 订阅实例的标签
     */
    Tags?: Array<TagItem>;
    /**
     * 自动续费标识,0-不自动续费，1-自动续费
     */
    AutoRenewFlag?: number;
    /**
     * 数据订阅版本。老版订阅填txdts，kafka版填kafka
     */
    SubscribeVersion?: string;
    /**
     * 错误信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Errors?: Array<SubsErr>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAsyncRequestInfo请求参数结构体
 */
export interface DescribeAsyncRequestInfoRequest {
    /**
     * 任务 ID
     */
    AsyncRequestId: string;
}
/**
 * 源实例信息
 */
export interface SrcInfo {
    /**
     * 阿里云AccessKey。源库是阿里云RDS5.6适用
     */
    AccessKey?: string;
    /**
     * 实例的IP地址
     */
    Ip?: string;
    /**
     * 实例的端口
     */
    Port?: number;
    /**
     * 实例的用户名
     */
    User?: string;
    /**
     * 实例的密码
     */
    Password?: string;
    /**
     * 阿里云RDS实例ID。源库是阿里云RDS5.6/5.6适用
     */
    RdsInstanceId?: string;
    /**
     * CVM实例短ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要传递此字段
     */
    CvmInstanceId?: string;
    /**
     * 专线网关ID，格式如：dcg-0rxtqqxb
     */
    UniqDcgId?: string;
    /**
     * 私有网络ID，格式如：vpc-92jblxto
     */
    VpcId?: string;
    /**
     * 私有网络下的子网ID，格式如：subnet-3paxmkdz
     */
    SubnetId?: string;
    /**
     * VPN网关ID，格式如：vpngw-9ghexg7q
     */
    UniqVpnGwId?: string;
    /**
     * 数据库实例ID，格式如：cdb-powiqx8q
     */
    InstanceId?: string;
    /**
     * 地域英文名，如：ap-guangzhou
     */
    Region?: string;
    /**
     * 当实例为RDS实例时，填写为aliyun, 其他情况均填写others
     */
    Supplier?: string;
    /**
     * 云联网ID，如：ccn-afp6kltc
     */
    CcnId?: string;
    /**
     * 数据库版本，当实例为RDS实例时才有效，格式如：5.6或者5.7，默认为5.6
     */
    EngineVersion?: string;
}
/**
 * 抽样检验时的抽样参数
 */
export interface ConsistencyParams {
    /**
     * 数据内容检测参数。表中选出用来数据对比的行，占表的总行数的百分比。取值范围是整数[1-100]
     */
    SelectRowsPerTable: number;
    /**
     * 数据内容检测参数。迁移库表中，要进行数据内容检测的表，占所有表的百分比。取值范围是整数[1-100]
     */
    TablesSelectAll: number;
    /**
     * 数据数量检测，检测表行数是否一致。迁移库表中，要进行数据数量检测的表，占所有表的百分比。取值范围是整数[1-100]
     */
    TablesSelectCount: number;
}
/**
 * ModifyMigrateJob请求参数结构体
 */
export interface ModifyMigrateJobRequest {
    /**
     * 待修改的数据迁移任务ID
     */
    JobId: string;
    /**
     * 数据迁移任务名称
     */
    JobName?: string;
    /**
     * 迁移任务配置选项
     */
    MigrateOption?: MigrateOption;
    /**
     * 源实例接入类型，值包括：extranet(外网),cvm(CVM自建实例),dcg(专线接入的实例),vpncloud(云VPN接入的实例),cdb(云上CDB实例)
     */
    SrcAccessType?: string;
    /**
     * 源实例信息，具体内容跟迁移任务类型相关
     */
    SrcInfo?: SrcInfo;
    /**
     * 目标实例接入类型，值包括：extranet(外网),cvm(CVM自建实例),dcg(专线接入的实例),vpncloud(云VPN接入的实例)，cdb(云上CDB实例). 目前只支持cdb.
     */
    DstAccessType?: string;
    /**
     * 目标实例信息, 其中目标实例地域不允许修改.
     */
    DstInfo?: DstInfo;
    /**
     * 当选择'指定库表'迁移的时候, 需要设置待迁移的源数据库表信息,用符合json数组格式的字符串描述, 如下所例。
  
  对于database-table两级结构的数据库：
  [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
  对于database-schema-table三级结构：
  [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
  
  如果是'整个实例'的迁移模式,不需设置该字段
     */
    DatabaseInfo?: string;
    /**
     * 源实例类型: ""或者"simple":主从节点，"cluster": 集群节点
     */
    SrcNodeType?: string;
    /**
     * 源实例信息，具体内容跟迁移任务类型相关
     */
    SrcInfoMulti?: Array<SrcInfo>;
}
/**
 * CreateSubscribe请求参数结构体
 */
export interface CreateSubscribeRequest {
    /**
     * 订阅的数据库类型，目前支持的有 mysql
     */
    Product: string;
    /**
     * 实例付费类型，1小时计费，0包年包月
     */
    PayType: number;
    /**
     * 购买时长。PayType为0时必填。单位为月，最大支持120
     */
    Duration?: number;
    /**
     * 购买数量,默认为1，最大为10
     */
    Count?: number;
    /**
     * 是否自动续费，0表示不自动续费，1表示自动续费，默认为0。小时计费实例设置该标识无效。
     */
    AutoRenew?: number;
    /**
     * 实例资源标签
     */
    Tags?: Array<TagItem>;
    /**
     * 用户自定义实例名
     */
    Name?: string;
}
/**
 * CreateMigrateCheckJob返回参数结构体
 */
export interface CreateMigrateCheckJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifySubscribeObjects请求参数结构体
 */
export interface ModifySubscribeObjectsRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
    /**
     * 数据订阅的类型，可选的值有：0 - 全实例订阅；1 - 数据订阅；2 - 结构订阅；3 - 数据订阅+结构订阅
     */
    SubscribeObjectType: number;
    /**
     * 订阅的数据库表信息
     */
    Objects?: Array<SubscribeObject>;
}
/**
 * DescribeMigrateCheckJob返回参数结构体
 */
export interface DescribeMigrateCheckJobResponse {
    /**
     * 校验任务状态：unavailable(当前不可用), starting(开始中)，running(校验中)，finished(校验完成)
     */
    Status: string;
    /**
     * 任务的错误码
     */
    ErrorCode: number;
    /**
     * 任务的错误信息
     */
    ErrorMessage: string;
    /**
     * Check任务总进度,如："30"表示30%
     */
    Progress: string;
    /**
     * 校验是否通过,0-未通过，1-校验通过, 3-未校验
     */
    CheckFlag: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ActivateSubscribe请求参数结构体
 */
export interface ActivateSubscribeRequest {
    /**
     * 订阅实例ID。
     */
    SubscribeId: string;
    /**
     * 数据库实例ID
     */
    InstanceId: string;
    /**
     * 数据订阅类型0-全实例订阅，1数据订阅，2结构订阅，3数据订阅与结构订阅
     */
    SubscribeObjectType: number;
    /**
     * 订阅对象
     */
    Objects?: SubscribeObject;
    /**
     * 数据订阅服务所在子网。默认为数据库实例所在的子网内。
     */
    UniqSubnetId?: string;
    /**
     * 订阅服务端口；默认为7507
     */
    Vport?: number;
}
/**
 * OfflineIsolatedSubscribe请求参数结构体
 */
export interface OfflineIsolatedSubscribeRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
}
/**
 * OfflineIsolatedSubscribe返回参数结构体
 */
export interface OfflineIsolatedSubscribeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ResetSubscribe返回参数结构体
 */
export interface ResetSubscribeResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSubscribes返回参数结构体
 */
export interface DescribeSubscribesResponse {
    /**
     * 符合查询条件的实例总数
     */
    TotalCount?: number;
    /**
     * 数据订阅实例的信息列表
     */
    Items?: Array<SubscribeInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifySubscribeConsumeTime请求参数结构体
 */
export interface ModifySubscribeConsumeTimeRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
    /**
     * 消费时间起点，也即是指定订阅数据的时间起点，时间格式如：Y-m-d h:m:s，取值范围为过去24小时之内
     */
    ConsumeStartTime: string;
}
/**
 * 描述详细迁移过程
 */
export interface MigrateDetailInfo {
    /**
     * 总步骤数
     */
    StepAll?: number;
    /**
     * 当前步骤
     */
    StepNow?: number;
    /**
     * 总进度,如："10"
     */
    Progress?: string;
    /**
     * 当前步骤进度,如:"1"
     */
    CurrentStepProgress?: string;
    /**
     * 主从差距，MB；在增量同步阶段有效，目前支持产品为：redis和mysql
     */
    MasterSlaveDistance?: number;
    /**
     * 主从差距，秒；在增量同步阶段有效，目前支持产品为：mysql
     */
    SecondsBehindMaster?: number;
    /**
     * 步骤信息
     */
    StepInfo?: Array<MigrateStepDetailInfo>;
}
/**
 * StopMigrateJob请求参数结构体
 */
export interface StopMigrateJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
}
/**
 * DescribeAsyncRequestInfo返回参数结构体
 */
export interface DescribeAsyncRequestInfoResponse {
    /**
     * 任务执行结果信息
     */
    Info?: string;
    /**
     * 任务执行状态，可能的值有：success，failed，running
     */
    Status?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 订阅实例信息
 */
export interface SubscribeInfo {
    /**
     * 数据订阅的实例ID
     */
    SubscribeId?: string;
    /**
     * 数据订阅实例的名称
     */
    SubscribeName?: string;
    /**
     * 数据订阅实例绑定的通道ID。kafka版订阅就是kafka topic
     */
    ChannelId?: string;
    /**
     * 订阅实例的类型，目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
     */
    Product?: string;
    /**
     * 数据订阅实例绑定的数据库实例ID
     */
    InstanceId?: string;
    /**
     * 云数据库状态：running 运行中，isolated 已隔离，offline 已下线。如果不是云上，此值为空
     */
    InstanceStatus?: string;
    /**
     * 数据订阅状态，可能的值为：未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
     */
    SubsStatus?: string;
    /**
     * 上次修改时间，时间格式如：Y-m-d h:m:s
     */
    ModifyTime?: string;
    /**
     * 创建时间
     */
    CreateTime?: string;
    /**
     * 隔离时间，时间格式如：Y-m-d h:m:s
     */
    IsolateTime?: string;
    /**
     * 包年包月任务的到期时间，时间格式如：Y-m-d h:m:s。默认：0000-00-00 00:00:00
     */
    ExpireTime?: string;
    /**
     * 下线时间
     */
    OfflineTime?: string;
    /**
     * 最近一次修改的消费时间起点，如果从未修改则为零值
     */
    ConsumeStartTime?: string;
    /**
     * 自动续费标识。只有当 PayType=0，该值才有意义。枚举值：0-不自动续费，1-自动续费
     */
    AutoRenewFlag?: number;
    /**
     * 数据订阅实例所属地域
     */
    Region?: string;
    /**
     * 计费方式，0 - 包年包月，1 - 按量计费
     */
    PayType?: number;
    /**
     * 旧版订阅通道的vip
     */
    Vip?: string;
    /**
     * 数据订阅实例的Vport
     */
    Vport?: number;
    /**
     * 数据订阅实例Vip所在VPC的唯一ID
     */
    UniqVpcId?: string;
    /**
     * 数据订阅实例Vip所在子网的唯一ID
     */
    UniqSubnetId?: string;
    /**
     * 数据订阅生命周期状态，可能的值为：正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
     */
    Status?: string;
    /**
     * SDK最后一条确认消息的时间戳，如果SDK一直消费，也可以作为SDK当前消费时间点
     */
    SdkConsumedTime?: string;
    /**
     * 标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Tags?: Array<TagItem>;
    /**
     * 订阅实例版本；txdts-旧版数据订阅,kafka-kafka版本数据订阅
     */
    SubscribeVersion?: string;
}
/**
 * ResetSubscribe请求参数结构体
 */
export interface ResetSubscribeRequest {
    /**
     * 数据订阅实例的ID
     */
    SubscribeId: string;
}
/**
 * 标签
 */
export interface TagItem {
    /**
     * 标签键值
     */
    TagKey: string;
    /**
     * 标签值
     */
    TagValue?: string;
}
/**
 * 标签过滤
 */
export interface TagFilter {
    /**
     * 标签键值
     */
    TagKey: string;
    /**
     * 标签值
     */
    TagValue?: Array<string>;
}
/**
 * ModifyMigrateJob返回参数结构体
 */
export interface ModifyMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMigrateJobs请求参数结构体
 */
export interface DescribeMigrateJobsRequest {
    /**
     * 数据迁移任务ID
     */
    JobId?: string;
    /**
     * 数据迁移任务名称
     */
    JobName?: string;
    /**
     * 排序字段，可以取值为JobId、Status、JobName、MigrateType、RunMode、CreateTime
     */
    Order?: string;
    /**
     * 排序方式，升序为ASC，降序为DESC
     */
    OrderSeq?: string;
    /**
     * 偏移量，默认为0
     */
    Offset?: number;
    /**
     * 返回实例数量，默认20，有效区间[1,100]
     */
    Limit?: number;
    /**
     * 标签过滤条件
     */
    TagFilters?: Array<TagFilter>;
}
/**
 * ModifySubscribeAutoRenewFlag返回参数结构体
 */
export interface ModifySubscribeAutoRenewFlagResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopMigrateJob返回参数结构体
 */
export interface StopMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * IsolateSubscribe请求参数结构体
 */
export interface IsolateSubscribeRequest {
    /**
     * 订阅实例ID
     */
    SubscribeId: string;
}
/**
 * ModifySubscribeAutoRenewFlag请求参数结构体
 */
export interface ModifySubscribeAutoRenewFlagRequest {
    /**
     * 订阅实例ID，例如：subs-8uey736k
     */
    SubscribeId: string;
    /**
     * 自动续费标识。1-自动续费，0-不自动续费
     */
    AutoRenewFlag: number;
}
/**
 * CompleteMigrateJob请求参数结构体
 */
export interface CompleteMigrateJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
    /**
     * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成，不会等待主从差距一致。默认为waitForSync
     */
    CompleteMode?: string;
}
/**
 * 迁移任务详情
 */
export interface MigrateJobInfo {
    /**
     * 数据迁移任务ID
     */
    JobId?: string;
    /**
     * 数据迁移任务名称
     */
    JobName?: string;
    /**
     * 迁移任务配置选项
     */
    MigrateOption?: MigrateOption;
    /**
     * 源实例数据库类型:mysql，redis，mongodb，postgresql，mariadb，percona
     */
    SrcDatabaseType?: string;
    /**
     * 源实例接入类型，值包括：extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),cdb(腾讯云数据库实例),ccn(云联网实例)
     */
    SrcAccessType?: string;
    /**
     * 源实例信息，具体内容跟迁移任务类型相关
     */
    SrcInfo?: SrcInfo;
    /**
     * 目标实例数据库类型:mysql，redis，mongodb，postgresql，mariadb，percona
     */
    DstDatabaseType?: string;
    /**
     * 目标实例接入类型，目前支持：cdb(腾讯云数据库实例)
     */
    DstAccessType?: string;
    /**
     * 目标实例信息
     */
    DstInfo?: DstInfo;
    /**
     * 需要迁移的源数据库表信息，如果需要迁移的是整个实例，该字段为[]
     */
    DatabaseInfo?: string;
    /**
     * 任务创建(提交)时间
     */
    CreateTime?: string;
    /**
     * 任务开始执行时间
     */
    StartTime?: string;
    /**
     * 任务执行结束时间
     */
    EndTime?: string;
    /**
     * 任务状态,取值为：1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过（CheckNotPass）,7-任务运行(Running),8-准备完成（ReadyComplete）,9-任务成功（Success）,10-任务失败（Failed）,11-撤销中（Stopping）,12-完成中（Completing）,23-未知状态（Unknown）
     */
    Status?: number;
    /**
     * 任务详情
     */
    Detail?: MigrateDetailInfo;
    /**
     * 任务错误信息提示，当任务发生错误时，不为null或者空值
     */
    ErrorInfo?: Array<ErrorInfo>;
    /**
     * 标签
     */
    Tags?: Array<TagItem>;
    /**
     * 源实例为集群时且接入为非cdb时源实例信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SrcInfoMulti?: Array<SrcInfo>;
}
/**
 * DescribeSubscribes请求参数结构体
 */
export interface DescribeSubscribesRequest {
    /**
     * 数据订阅的实例ID
     */
    SubscribeId?: string;
    /**
     * 数据订阅的实例名称
     */
    SubscribeName?: string;
    /**
     * 绑定数据库实例的ID
     */
    InstanceId?: string;
    /**
     * 数据订阅实例的通道ID
     */
    ChannelId?: string;
    /**
     * 计费模式筛选，可能的值：0-包年包月，1-按量计费
     */
    PayType?: string;
    /**
     * 订阅的数据库产品，如mysql
     */
    Product?: string;
    /**
     * 数据订阅实例的状态，creating - 创建中，normal - 正常运行，isolating - 隔离中，isolated - 已隔离，offlining - 下线中
     */
    Status?: Array<string>;
    /**
     * 数据订阅实例的配置状态，unconfigure - 未配置， configuring - 配置中，configured - 已配置
     */
    SubsStatus?: Array<string>;
    /**
     * 返回记录的起始偏移量，默认为0。请输入非负整数
     */
    Offset?: number;
    /**
     * 单次返回的记录数量，默认20。请输入1到100的整数
     */
    Limit?: number;
    /**
     * 排序方向，可选的值为"DESC"和"ASC"，默认为"DESC"，按创建时间逆序排序
     */
    OrderDirection?: string;
    /**
     * 标签过滤条件
     */
    TagFilters?: Array<TagFilter>;
    /**
     * 订阅实例版本;txdts-旧版数据订阅，kafka-kafka版本数据订阅
     */
    SubscribeVersion?: string;
}
/**
 * CompleteMigrateJob返回参数结构体
 */
export interface CompleteMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据订阅的对象
 */
export interface SubscribeObject {
    /**
     * 数据订阅对象的类型，0-数据库，1-数据库内的表
     */
    ObjectsType: number;
    /**
     * 订阅数据库的名称
     */
    DatabaseName: string;
    /**
     * 订阅数据库中表名称数组
     */
    TableNames?: Array<string>;
}
/**
 * CreateMigrateJob返回参数结构体
 */
export interface CreateMigrateJobResponse {
    /**
     * 数据迁移任务ID
     */
    JobId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSubscribeConf请求参数结构体
 */
export interface DescribeSubscribeConfRequest {
    /**
     * 订阅实例ID
     */
    SubscribeId: string;
}
/**
 * ModifySubscribeVipVport返回参数结构体
 */
export interface ModifySubscribeVipVportResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteMigrateJob请求参数结构体
 */
export interface DeleteMigrateJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
}
/**
 * ActivateSubscribe返回参数结构体
 */
export interface ActivateSubscribeResponse {
    /**
     * 配置数据订阅任务ID。
     */
    AsyncRequestId: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateSubscribe返回参数结构体
 */
export interface CreateSubscribeResponse {
    /**
     * 数据订阅实例的ID数组
     */
    SubscribeIds?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 迁移任务配置选项
 */
export interface MigrateOption {
    /**
     * 任务运行模式，值包括：1-立即执行，2-定时执行
     */
    RunMode: number;
    /**
     * 期望执行时间，当runMode=2时，该字段必填，时间格式：yyyy-mm-dd hh:mm:ss
     */
    ExpectTime?: string;
    /**
     * 数据迁移类型，值包括：1-结构迁移,2-全量迁移,3-全量+增量迁移
     */
    MigrateType?: number;
    /**
     * 迁移对象，1-整个实例，2-指定库表
     */
    MigrateObject?: number;
    /**
     * 抽样数据一致性检测参数，1-未配置,2-全量检测,3-抽样检测, 4-仅校验不一致表,5-不检测
     */
    ConsistencyType?: number;
    /**
     * 是否用源库Root账户覆盖目标库，值包括：0-不覆盖，1-覆盖，选择库表或者结构迁移时应该为0
     */
    IsOverrideRoot?: number;
    /**
     * 不同数据库用到的额外参数.以JSON格式描述.
  Redis可定义如下的参数:
  {
      "ClientOutputBufferHardLimit":512, 	从机缓冲区的硬性容量限制(MB)
      "ClientOutputBufferSoftLimit":512, 	从机缓冲区的软性容量限制(MB)
      "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒)
      "ReplBacklogSize":512, 	环形缓冲区容量限制(MB)
      "ReplTimeout":120，		复制超时时间(秒)
  }
  MongoDB可定义如下的参数:
  {
      'SrcAuthDatabase':'admin',
      'SrcAuthFlag': "1",
      'SrcAuthMechanism':"SCRAM-SHA-1"
  }
  MySQL暂不支持额外参数设置。
     */
    ExternParams?: string;
    /**
     * 仅用于“抽样数据一致性检测”，ConsistencyType配置为抽样检测时，必选
     */
    ConsistencyParams?: ConsistencyParams;
}
/**
 * 查询订阅配置的错误信息
 */
export interface SubsErr {
    /**
     * 错误信息
     */
    Message?: string;
}
/**
 * 迁移任务错误信息及提示
 */
export interface ErrorInfo {
    /**
     * 具体的报错日志, 包含错误码和错误信息
     */
    ErrorLog?: string;
    /**
     * 报错对应的帮助文档Ur
     */
    HelpDoc?: string;
}
/**
 * StartMigrateJob返回参数结构体
 */
export interface StartMigrateJobResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartMigrateJob请求参数结构体
 */
export interface StartMigrateJobRequest {
    /**
     * 数据迁移任务ID
     */
    JobId: string;
}