{ "name": "dts", "display_name": "数据传输服务", "description": "介绍如何快速使用API对数据传输服务进行数据迁移、数据同步、数据订阅操作。", "domain": "database", "api_version": "2021-12-06", "endpoint": "dts.tencentcloudapi.com", "actions": [ { "name": "CompleteMigrateJob", "description": "本接口（CompleteMigrateJob）用于完成数据迁移任务。 选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。 通过DescribeMigrationJobs接口查询到任务的状态为准备完成（Status=\"readyComplete\"）时，此时可以调用本接口完成迁移任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" }, { "name": "CompleteMode", "type": "string", "required": false, "description": "完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成，不会等待主从差距一致。默认为waitForSync", "example": "waitForSync" } ], "required": [ "JobId" ] }, { "name": "ConfigureSubscribeJob", "description": "本接口(ConfigureSubscribeJob)用于配置数据订阅实例。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "subs-xxxxxx" }, { "name": "SubscribeMode", "type": "string", "required": true, "description": "数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合", "example": "dmlAndDdl" }, { "name": "AccessType", "type": "string", "required": true, "description": "源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力", "example": "cdb" }, { "name": "Endpoints", "type": "array", "required": true, "description": "数据库节点信息", "example": "无", "item_type": "object", "children": [ { "name": "DatabaseRegion", "type": "string", "required": true, "description": "源库所在地域。如果 AccessType 为 ccn，请填vpc所在地域，因为此时不知道源库在哪个地域。其他接入方式，请填订阅任务所在地域，因为确保订阅任务与源库在同一地域是最优的网络方案。", "example": "ap-guangzhou" }, { "name": "User", "type": "string", "required": true, "description": "用户名", "example": "dts_user" }, { "name": "Password", "type": "string", "required": true, "description": "密码。作为入参时必填，作为出参时为空。", "example": "qJ3e1Wd~" }, { "name": "InstanceId", "type": "string", "required": false, "description": "目标实例ID。如果 AccessType 为 cdb，此项必填。配置InstanceId时会查询并校验实例信息。mysql的查询接口经过了鉴权，请确保子用户有 cdb:DescribeDBInstances 的接口权限。", "example": "cdb-xxxxxx" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "云主机ID。如果 AccessType 为 cvm，此项必填。", "example": "ins-xxxxxx" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID。如果 AccessType 为 dcg，此项必填。", "example": "dcg-xxxxxx" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网ID。如果 AccessType 为 ccn，此项必填。", "example": "ccn-xxxxxx" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "vpn网关ID。如果 AccessType 为 vpncloud，此项必填。", "example": "vpngw-xxxxxx" }, { "name": "VpcId", "type": "string", "required": false, "description": "VpcID。如果 AccessType 为 dcg\\ccn\\vpncloud\\vpc，此项必填。", "example": "vpc-xxxxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID。如果 AccessType 为 dcg\\ccn\\vpncloud\\vpc，此项必填。", "example": "subnet-xxxxxx" }, { "name": "HostName", "type": "string", "required": false, "description": "数据库地址，支持域名与IP。如果 AccessType 为 dcg\\ccn\\vpncloud\\vpc\\extranet\\intranet，此项必填。", "example": "9.223.70.88" }, { "name": "Port", "type": "integer", "required": false, "description": "数据库端口。如果 AccessType 为 dcg\\ccn\\vpncloud\\vpc\\extranet\\intranet\\cvm，此项必填。", "example": "3306" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输，枚举值：UnEncrypted-不加密，Encrypted-加密。只有mysql支持，不填默认不加密，其他产品不填。", "example": "Encrypted" }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库网络环境。如果 AccessType 为 ccn 此项必填。枚举值：UserIDC-自建idc，TencentVPC-腾讯云，Aws-aws，AliYun-阿里云，Others-其他。", "example": "TencentVPC" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "云联网网关所属的主账号uin、跨账号云联网需要。", "example": "700000294281" }, { "name": "ExtraAttr", "type": "array", "required": false, "description": "为业务添加的额外信息。参数名作key，参数值作value。 tdpg必填参数：PgDatabase-订阅的库名； mongo选填参数：InstanceType-实例类型：replicaset-副本集，cluster-分片集，主要用于控制台跳转到mongo实例页面，如不填不影响任务运行； 全业务选填参数：EngineVersion-内核版本。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] }, { "name": "ChildInstanceId", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID", "example": "cynos-ins-xxxx" }, { "name": "ChildInstanceType", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、例如：只读实例传ro、读写实例传rw", "example": "ro" } ] }, { "name": "KafkaConfig", "type": "object", "required": true, "description": "Kafka配置", "example": "无", "children": [ { "name": "NumberOfPartitions", "type": "integer", "required": true, "description": "kafka分区数量，枚举值为1，4，8", "example": "8" }, { "name": "DistributeRules", "type": "array", "required": false, "description": "分区规则。当NumberOfPartitions \u003e 1时，该项必填。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型。非mongo产品的枚举值为: table-按表名分区，pk-按表名+主键分区，cols-按列名分区。mongo的枚举值为：collection-按集合名分区、collectionAndObjectId-按集合+主键分区。", "example": "table" }, { "name": "DbPattern", "type": "string", "required": true, "description": "库名匹配规则，请填写正则表达式", "example": "db_*" }, { "name": "TablePattern", "type": "string", "required": true, "description": "表名匹配规则，如果 DatabaseType 为 mongodb，则匹配集合名", "example": "tabl_*" }, { "name": "Columns", "type": "array", "required": false, "description": "列名。如果 RuleType 为 cols，此项必填。订阅任务会用该列的值计算分区。mongo没有按列分区，因此也不用传这个字段。", "example": "[\"id\"]", "item_type": "string" } ] }, { "name": "DefaultRuleType", "type": "string", "required": false, "description": "默认分区策略。当NumberOfPartitions \u003e 1时，该项必填。不满足DistributeRules中正则表达式的数据，将按照默认分区策略计算分区。 非mongo产品的枚举值为: table-按表名分区，pk-按表名+主键分区。mongo的枚举值为：collection-按集合名分区。 该字段与DistributeRules搭配使用，如果配置了该字段，视为配置了一条DistributeRules。", "example": "table" } ] }, { "name": "SubscribeObjects", "type": "array", "required": false, "description": "订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数", "example": "无", "item_type": "object", "children": [ { "name": "ObjectType", "type": "string", "required": true, "description": "订阅数据的类型，枚举值：database-数据库，table-数据库的表(如果 DatabaseType 为 mongodb，则表示集合)", "example": "table" }, { "name": "Database", "type": "string", "required": true, "description": "订阅的数据库名称", "example": "db_1" }, { "name": "Tables", "type": "array", "required": false, "description": "订阅数据库中表的名称。如果 DatabaseType 为 mongodb，填集合名。mongodb只支持订阅单库或者单集合。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"tabl_1\"]", "item_type": "string" } ] }, { "name": "Protocol", "type": "string", "required": false, "description": "订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档", "example": "protobuf" }, { "name": "PipelineInfo", "type": "array", "required": false, "description": "mongo选填参数：输出聚合设置。", "example": "无", "item_type": "object", "children": [ { "name": "AggOp", "type": "string", "required": false, "description": "聚合运算符：$addFields、$match、$project、$replaceRoot、$redact、$replaceWith、$set、$unset。其中 $replaceWith、$set、$unset 只有当订阅实例是4.2及以上版本可选。", "example": "$addFields" }, { "name": "AggCmd", "type": "string", "required": false, "description": "聚合表达式。必须是json格式", "example": "{\"a\":\"\"}" } ] }, { "name": "ExtraAttr", "type": "array", "required": false, "description": "为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] }, { "name": "ConsumerVpcId", "type": "string", "required": false, "description": "vpc id", "example": "vpc-2hfu26a7" }, { "name": "ConsumerSubnetId", "type": "string", "required": false, "description": "subnet id", "example": "subnet-3gnpluam" } ], "required": [ "SubscribeId", "SubscribeMode", "AccessType", "Endpoints", "KafkaConfig" ] }, { "name": "ConfigureSyncJob", "description": "配置一个同步任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步实例id（即标识一个同步作业），形如sync-werwfs23，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" }, { "name": "SrcAccessType", "type": "string", "required": true, "description": "源端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路", "example": "cdb" }, { "name": "DstAccessType", "type": "string", "required": true, "description": "目标端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路", "example": "extranet" }, { "name": "Objects", "type": "object", "required": true, "description": "同步库表对象信息", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "同步对象类型 Partial(部分对象)", "example": "Partial" }, { "name": "Databases", "type": "array", "required": false, "description": "同步对象，当 Mode 为 Partial 时，不为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": false, "description": "需要迁移或同步的库名，当ObjectMode为Partial时，此项必填", "example": "db1" }, { "name": "NewDbName", "type": "string", "required": false, "description": "迁移或同步后的库名，默认与源库相同", "example": "db1_new" }, { "name": "DbMode", "type": "string", "required": false, "description": "DB选择模式: All(为当前对象下的所有对象)，Partial(部分对象)，当Mode为Partial时，此项必填。注意，高级对象的同步不依赖此值，如果整库同步此处应该为All。", "example": "All" }, { "name": "SchemaName", "type": "string", "required": false, "description": "迁移或同步的 schema", "example": "sch1" }, { "name": "NewSchemaName", "type": "string", "required": false, "description": "迁移或同步后的 schema name", "example": "sch1_new" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: All(为当前对象下的所有对象)，Partial(部分对象)，当DBMode为Partial时此项必填，如果整库同步此处应该为All。", "example": "All" }, { "name": "Tables", "type": "array", "required": false, "description": "表图对象集合，当 TableMode 为 Partial 时，此项需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名", "example": "t1" }, { "name": "NewTableName", "type": "string", "required": false, "description": "新表名", "example": "t1_new" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "where id \u003e 100" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "是否同步表中所有列，All：当前表下的所有列,Partial(ModifySyncJobConfig接口里的对应字段ColumnMode暂不支持Partial)：当前表下的部分列，通过填充Columns字段详细表信息", "example": "All" }, { "name": "Columns", "type": "array", "required": false, "description": "同步的列信息，当ColumnMode为Partial时，必填", "example": "无", "item_type": "string" }, { "name": "TmpTables", "type": "array", "required": false, "description": "同步临时表，注意此配置与NewTableName互斥，只能使用其中一种。当配置的同步对象为表级别且TableEditMode为pt时此项有意义，针对pt-osc等工具在同步过程中产生的临时表进行同步，需要提前将可能的临时表配置在这里，否则不会同步任何临时表。示例，如要对t1进行pt-osc操作，此项配置应该为[\"\\_t1\\_new\",\"\\_t1\\_old\"]；如要对t1进行gh-ost操作，此项配置应该为[\"\\_t1\\_ghc\",\"\\_t1\\_gho\",\"\\_t1\\_del\"...", "example": "[\"_t1_old\",_t1_new\"]", "item_type": "string" }, { "name": "TableEditMode", "type": "string", "required": false, "description": "编辑表类型，rename(表映射)，pt(同步附加表)", "example": "pt" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: All 为当前对象下的所有视图对象,Partial 为部分视图对象，如果整库同步此处应该为All。", "example": "All" }, { "name": "Views", "type": "array", "required": false, "description": "视图对象集合，当 ViewMode 为 Partial 时， 此项需要填写", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "view名", "example": "v1" }, { "name": "NewViewName", "type": "string", "required": false, "description": "预留字段、目前暂时不支持view的重命名", "example": "v1_new" } ] }, { "name": "FunctionMode", "type": "string", "required": false, "description": "选择要同步的模式，Partial为部分，All为整选，如果整库同步此处应该为All。", "example": "All" }, { "name": "Functions", "type": "array", "required": false, "description": "FunctionMode取值为Partial时需要填写", "example": "[\"func_1\"]", "item_type": "string" }, { "name": "ProcedureMode", "type": "string", "required": false, "description": "选择要同步的模式，Partial为部分，All为整选，如果整库同步此处应该为All。", "example": "All" }, { "name": "Procedures", "type": "array", "required": false, "description": "ProcedureMode取值为Partial时需要填写", "example": "[\"proc_1\"]", "item_type": "string" }, { "name": "TriggerMode", "type": "string", "required": false, "description": "触发器迁移模式，All(为当前对象下的所有对象)，Partial(部分对象)，如果整库同步此处应该为All。数据同步暂不支持此高级对象。", "example": "Partial" }, { "name": "Triggers", "type": "array", "required": false, "description": "当TriggerMode为partial，指定要迁移的触发器名称", "example": "[\"trigger_1\"]", "item_type": "string" }, { "name": "EventMode", "type": "string", "required": false, "description": "事件迁移模式，All(为当前对象下的所有对象)，Partial(部分对象)，如果整库同步此处应该为All。数据同步暂不支持此高级对象。", "example": "Partial" }, { "name": "Events", "type": "array", "required": false, "description": "当EventMode为partial，指定要迁移的事件名称", "example": "[\"event_1\"]", "item_type": "string" } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，如function、procedure。注意：如果要迁移同步高级对象，此配置中应该包含对应的高级对象类型。当需要同步高级对象时，初始化类型必须包含结构初始化类型，即任务的Options.InitType字段值为Structure或Full", "example": "[\"function\"]", "item_type": "string" }, { "name": "OnlineDDL", "type": "object", "required": false, "description": "OnlineDDL类型，冗余字段不做配置用途", "example": "无", "children": [ { "name": "Status", "type": "string", "required": true, "description": "状态，ON-启用，OFF-不启用。", "example": "ON" } ] }, { "name": "DatabasesOpFilter", "type": "array", "required": false, "description": "库/表/视图级 DML/DDL 白名单", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "规则生效的库名", "example": "je***" }, { "name": "OpFilter", "type": "object", "required": false, "description": "库级 DDL/DML 过滤规则", "example": "无", "children": [ { "name": "OpTypes", "type": "array", "required": false, "description": "DML 白名单", "example": "[\"Insert\"]", "item_type": "string" }, { "name": "DdlOptions", "type": "array", "required": false, "description": "DDL 白名单", "example": "无", "item_type": "string" } ] }, { "name": "Tables", "type": "array", "required": false, "description": "表级 DDL/DML 过滤信息", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": true, "description": "规则生效的表名", "example": "order_details" }, { "name": "OpFilter", "type": "object", "required": false, "description": "表级 DDL/DML 过滤规则", "example": "无" } ] }, { "name": "Views", "type": "array", "required": false, "description": "视图级 DDL/DML 过滤信息", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": true, "description": "规则生效的视图名", "example": "order_full_details" }, { "name": "OpFilter", "type": "object", "required": false, "description": "视图级 DDL/DML 过滤规则", "example": "无" } ] } ] } ] }, { "name": "JobName", "type": "string", "required": false, "description": "同步任务名称", "example": "sync-werwfs23" }, { "name": "JobMode", "type": "string", "required": false, "description": "枚举值是 liteMode 和 fullMode ，分别对应精简模式或正常模式", "example": "fullMode" }, { "name": "RunMode", "type": "string", "required": false, "description": "运行模式，取值如：Immediate(表示立即运行，默认为此项值)、Timed(表示定时运行)", "example": "Immediate" }, { "name": "ExpectRunTime", "type": "string", "required": false, "description": "期待启动时间，当RunMode取值为Timed时，此值必填，形如：\"2006-01-02 15:04:05\"", "example": "2022-12-06 00:00:00" }, { "name": "SrcConnectType", "type": "string", "required": false, "description": "源端tdsql连接方式：proxy-通过tdsql proxy主机访问各个set节点，注意只有在自研上云的网络环境下才能通过这种方式连接，SrcInfos中只需要提供proxy主机信息。set-直连set节点，如选择直连set方式，需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。", "example": "proxy" }, { "name": "SrcInfo", "type": "object", "required": false, "description": "源端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域英文名，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Role", "type": "string", "required": false, "description": "节点类型，proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填", "example": "proxy" }, { "name": "DbKernel", "type": "string", "required": false, "description": "数据库内核类型，tdsql中用于区分不同内核：percona,mariadb,mysql。注意TDSQL-C MySQL、TDSQL PostgreSQL无需填写此项值。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q", "example": "cdb-wew23ed" }, { "name": "Ip", "type": "string", "required": false, "description": "实例的IP地址，接入类型为非cdb时此项必填", "example": "192.168.1.12" }, { "name": "Port", "type": "integer", "required": false, "description": "实例端口，接入类型为非cdb时此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "用户名，对于访问需要用户名密码认证的实例必填", "example": "user" }, { "name": "Password", "type": "string", "required": false, "description": "密码，对于访问需要用户名密码认证的实例必填", "example": "password_123" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名，数据库为cdwpg时，需要提供", "example": "postgress" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：vpc-92jblxto", "example": "vpc-23rwfdg" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：subnet-3paxmkdz", "example": "subnet-tke9sfg" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要传递此字段", "example": "ins-9emwf2d" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，对于专线接入类型此项必填，格式如：dcg-0rxtqqxb", "example": "dcg-9sdfksk" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，对于vpn接入类型此项必填，格式如：vpngw-9ghexg7q", "example": "vpngw-3dsfwf2" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网ID，对于云联网接入类型此项必填，如：ccn-afp6kltc", "example": "ccn-afp6kltc" }, { "name": "Supplier", "type": "string", "required": false, "description": "云厂商类型，当实例为RDS实例时，填写为aliyun, 其他情况均填写others，默认为others", "example": "aliyun" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，其他实例忽略，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号，如果为跨账号实例此项必填", "example": "700000123456" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)", "example": "other" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号同步时的角色，只允许[a-zA-Z0-9-_]+，如果为跨账号实例此项必填", "example": "dts test_role" }, { "name": "RoleExternalId", "type": "string", "required": false, "description": "外部角色id", "example": "roleId" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "AKID5XXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "2qZDXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "JOqqCXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "数据库为跨账号云联网下的实例时、表示云联网所属主账号", "example": "700000123456" }, { "name": "ChildInstanceId", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID", "example": "cynos-ins-xxxx" }, { "name": "ChildInstanceType", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、例如：只读实例传ro、读写实例传rw", "example": "ro" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1(s1)" } ] }, { "name": "SrcInfos", "type": "object", "required": false, "description": "源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "数据库所在地域", "example": "ap-guangzhou" }, { "name": "AccessType", "type": "string", "required": true, "description": "实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路", "example": "cdb" }, { "name": "DatabaseType", "type": "string", "required": true, "description": "实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等", "example": "tdsqlmysql" }, { "name": "Info", "type": "array", "required": true, "description": "数据库信息。注意：如果数据库类型为tdsqlmysql，此处Endpoint数组的顺序应满足规则：proxy节点放在set节点之前。如果SrcConnectType选择proxy接入则只需要填写proxy节点即可。如果选择set接入，数组中第一个set节点必须是shardkey范围起始为0的分片 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域英文名，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Role", "type": "string", "required": false, "description": "节点类型，proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填", "example": "proxy" }, { "name": "DbKernel", "type": "string", "required": false, "description": "数据库内核类型，tdsql中用于区分不同内核：percona,mariadb,mysql。注意TDSQL-C MySQL、TDSQL PostgreSQL无需填写此项值。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q", "example": "cdb-wew23ed" }, { "name": "Ip", "type": "string", "required": false, "description": "实例的IP地址，接入类型为非cdb时此项必填", "example": "192.168.1.12" }, { "name": "Port", "type": "integer", "required": false, "description": "实例端口，接入类型为非cdb时此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "用户名，对于访问需要用户名密码认证的实例必填", "example": "user" }, { "name": "Password", "type": "string", "required": false, "description": "密码，对于访问需要用户名密码认证的实例必填", "example": "password_123" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名，数据库为cdwpg时，需要提供", "example": "postgress" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：vpc-92jblxto", "example": "vpc-23rwfdg" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：subnet-3paxmkdz", "example": "subnet-tke9sfg" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要传递此字段", "example": "ins-9emwf2d" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，对于专线接入类型此项必填，格式如：dcg-0rxtqqxb", "example": "dcg-9sdfksk" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，对于vpn接入类型此项必填，格式如：vpngw-9ghexg7q", "example": "vpngw-3dsfwf2" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网ID，对于云联网接入类型此项必填，如：ccn-afp6kltc", "example": "ccn-afp6kltc" }, { "name": "Supplier", "type": "string", "required": false, "description": "云厂商类型，当实例为RDS实例时，填写为aliyun, 其他情况均填写others，默认为others", "example": "aliyun" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，其他实例忽略，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号，如果为跨账号实例此项必填", "example": "700000123456" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)", "example": "other" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号同步时的角色，只允许[a-zA-Z0-9-_]+，如果为跨账号实例此项必填", "example": "dts test_role" }, { "name": "RoleExternalId", "type": "string", "required": false, "description": "外部角色id", "example": "roleId" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "AKID5XXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "2qZDXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "JOqqCXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "数据库为跨账号云联网下的实例时、表示云联网所属主账号", "example": "700000123456" }, { "name": "ChildInstanceId", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID", "example": "cynos-ins-xxxx" }, { "name": "ChildInstanceType", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、例如：只读实例传ro、读写实例传rw", "example": "ro" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1(s1)" } ] } ] }, { "name": "SrcNodeType", "type": "string", "required": false, "description": "枚举值：cluster、single。源库为单节点数据库使用single，多节点使用cluster", "example": "cluster" }, { "name": "DstInfo", "type": "object", "required": false, "description": "目标端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域英文名，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Role", "type": "string", "required": false, "description": "节点类型，proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填", "example": "proxy" }, { "name": "DbKernel", "type": "string", "required": false, "description": "数据库内核类型，tdsql中用于区分不同内核：percona,mariadb,mysql。注意TDSQL-C MySQL、TDSQL PostgreSQL无需填写此项值。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q", "example": "cdb-wew23ed" }, { "name": "Ip", "type": "string", "required": false, "description": "实例的IP地址，接入类型为非cdb时此项必填", "example": "192.168.1.12" }, { "name": "Port", "type": "integer", "required": false, "description": "实例端口，接入类型为非cdb时此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "用户名，对于访问需要用户名密码认证的实例必填", "example": "user" }, { "name": "Password", "type": "string", "required": false, "description": "密码，对于访问需要用户名密码认证的实例必填", "example": "password_123" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名，数据库为cdwpg时，需要提供", "example": "postgress" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：vpc-92jblxto", "example": "vpc-23rwfdg" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：subnet-3paxmkdz", "example": "subnet-tke9sfg" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要传递此字段", "example": "ins-9emwf2d" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，对于专线接入类型此项必填，格式如：dcg-0rxtqqxb", "example": "dcg-9sdfksk" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，对于vpn接入类型此项必填，格式如：vpngw-9ghexg7q", "example": "vpngw-3dsfwf2" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网ID，对于云联网接入类型此项必填，如：ccn-afp6kltc", "example": "ccn-afp6kltc" }, { "name": "Supplier", "type": "string", "required": false, "description": "云厂商类型，当实例为RDS实例时，填写为aliyun, 其他情况均填写others，默认为others", "example": "aliyun" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，其他实例忽略，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号，如果为跨账号实例此项必填", "example": "700000123456" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)", "example": "other" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号同步时的角色，只允许[a-zA-Z0-9-_]+，如果为跨账号实例此项必填", "example": "dts test_role" }, { "name": "RoleExternalId", "type": "string", "required": false, "description": "外部角色id", "example": "roleId" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "AKID5XXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "2qZDXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "JOqqCXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "数据库为跨账号云联网下的实例时、表示云联网所属主账号", "example": "700000123456" }, { "name": "ChildInstanceId", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID", "example": "cynos-ins-xxxx" }, { "name": "ChildInstanceType", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、例如：只读实例传ro、读写实例传rw", "example": "ro" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1(s1)" } ] }, { "name": "DstInfos", "type": "object", "required": false, "description": "目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "数据库所在地域", "example": "ap-guangzhou" }, { "name": "AccessType", "type": "string", "required": true, "description": "实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路", "example": "cdb" }, { "name": "DatabaseType", "type": "string", "required": true, "description": "实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等", "example": "tdsqlmysql" }, { "name": "Info", "type": "array", "required": true, "description": "数据库信息。注意：如果数据库类型为tdsqlmysql，此处Endpoint数组的顺序应满足规则：proxy节点放在set节点之前。如果SrcConnectType选择proxy接入则只需要填写proxy节点即可。如果选择set接入，数组中第一个set节点必须是shardkey范围起始为0的分片 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": false, "description": "地域英文名，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Role", "type": "string", "required": false, "description": "节点类型，proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填", "example": "proxy" }, { "name": "DbKernel", "type": "string", "required": false, "description": "数据库内核类型，tdsql中用于区分不同内核：percona,mariadb,mysql。注意TDSQL-C MySQL、TDSQL PostgreSQL无需填写此项值。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q", "example": "cdb-wew23ed" }, { "name": "Ip", "type": "string", "required": false, "description": "实例的IP地址，接入类型为非cdb时此项必填", "example": "192.168.1.12" }, { "name": "Port", "type": "integer", "required": false, "description": "实例端口，接入类型为非cdb时此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "用户名，对于访问需要用户名密码认证的实例必填", "example": "user" }, { "name": "Password", "type": "string", "required": false, "description": "密码，对于访问需要用户名密码认证的实例必填", "example": "password_123" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库名，数据库为cdwpg时，需要提供", "example": "postgress" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：vpc-92jblxto", "example": "vpc-23rwfdg" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，对于私有网络、专线、VPN的接入方式此项必填，格式如：subnet-3paxmkdz", "example": "subnet-tke9sfg" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要传递此字段", "example": "ins-9emwf2d" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，对于专线接入类型此项必填，格式如：dcg-0rxtqqxb", "example": "dcg-9sdfksk" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，对于vpn接入类型此项必填，格式如：vpngw-9ghexg7q", "example": "vpngw-3dsfwf2" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网ID，对于云联网接入类型此项必填，如：ccn-afp6kltc", "example": "ccn-afp6kltc" }, { "name": "Supplier", "type": "string", "required": false, "description": "云厂商类型，当实例为RDS实例时，填写为aliyun, 其他情况均填写others，默认为others", "example": "aliyun" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，其他实例忽略，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号，如果为跨账号实例此项必填", "example": "700000123456" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)", "example": "other" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号同步时的角色，只允许[a-zA-Z0-9-_]+，如果为跨账号实例此项必填", "example": "dts test_role" }, { "name": "RoleExternalId", "type": "string", "required": false, "description": "外部角色id", "example": "roleId" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "AKID5XXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "2qZDXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号同步文档(https://cloud.tencent.com/document/product/571/68729)第4节中关于角色的定义。", "example": "JOqqCXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "数据库为跨账号云联网下的实例时、表示云联网所属主账号", "example": "700000123456" }, { "name": "ChildInstanceId", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的ID", "example": "cynos-ins-xxxx" }, { "name": "ChildInstanceType", "type": "string", "required": false, "description": "数据库为cynos、且是cynos集群内的一个子数据库实例时、该参数为该子实例的类型、例如：只读实例传ro、读写实例传rw", "example": "ro" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1(s1)" } ] } ] }, { "name": "DstNodeType", "type": "string", "required": false, "description": "枚举值：cluster、single。目标库为单节点数据库使用single，多节点使用cluster", "example": "single" }, { "name": "Options", "type": "object", "required": false, "description": "同步任务选项；该字段下的RateLimitOption暂时无法生效、如果需要修改限速、可通过ModifySyncRateLimit接口完成限速", "example": "无", "children": [ { "name": "InitType", "type": "string", "required": false, "description": "同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。", "example": "Full" }, { "name": "DealOfExistSameTable", "type": "string", "required": false, "description": "同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)", "example": "ReportErrorAfterCheck" }, { "name": "ConflictHandleType", "type": "string", "required": false, "description": "冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)", "example": "ReportError" }, { "name": "AddAdditionalColumn", "type": "boolean", "required": false, "description": "是否添加附加列", "example": "false" }, { "name": "OpTypes", "type": "array", "required": false, "description": "所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"Insert\",\"Update\",\"Delete\",\"DDL\"]", "item_type": "string" }, { "name": "ConflictHandleOption", "type": "object", "required": false, "description": "冲突处理的详细选项，如条件覆盖中的条件行和条件操作", "example": "无", "children": [ { "name": "ConditionColumn", "type": "string", "required": false, "description": "条件覆盖的列", "example": "c1" }, { "name": "ConditionOperator", "type": "string", "required": false, "description": "条件覆盖操作，目前仅支持\u003e", "example": "\u003e" }, { "name": "ConditionOrderInSrcAndDst", "type": "string", "required": false, "description": "条件覆盖优先级处理，支持类型有\u003e,\u003c,=", "example": "\u003e" } ] }, { "name": "DdlOptions", "type": "array", "required": false, "description": "DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DdlObject", "type": "string", "required": false, "description": "ddl类型，如Database,Table,View,Index等", "example": "Database" }, { "name": "DdlValue", "type": "array", "required": false, "description": "ddl具体值，对于Database可取值[Create,Drop,Alter]对于Table可取值[Create,Drop,Alter,Truncate,Rename]对于View可取值[Create,Drop]对于Index可取值[Create,Drop] 注意：此字段可能返回 null，表示取不到有效值。", "example": "Alter", "item_type": "string" } ] }, { "name": "KafkaOption", "type": "object", "required": false, "description": "kafka同步选项", "example": "无", "children": [ { "name": "DataType", "type": "string", "required": false, "description": "投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json,debezium", "example": "Avro,Json" }, { "name": "TopicType", "type": "string", "required": false, "description": "同步topic策略，如Single（集中投递到单topic）,Multi (自定义topic名称)", "example": "Single（集中投递到单topic）,Multi (自定义topic名称)" }, { "name": "DDLTopicName", "type": "string", "required": false, "description": "用于存储ddl的topic", "example": "topic-ddl" }, { "name": "TopicRules", "type": "array", "required": false, "description": "单topic和自定义topic的描述", "example": "无", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": false, "description": "topic名。单topic时，所有的TopicName必须相同", "example": "topicName" }, { "name": "PartitionType", "type": "string", "required": false, "description": "topic分区策略，自定义topic时支持：Random（随机投递），集中投递到单Topic时支持：AllInPartitionZero（全部投递至partition0）、PartitionByTable(按表名分区)、PartitionByTableAndKey(按表名加主键分区)、PartitionByCols(按列分区)", "example": "Random（自定义topic时使用），AllInPartitionZero（全部投递至partition0）， PartitionByTable（按表名分区），PartitionByTableAndKey（按表名加主键分区）， PartitionByCols（按列名分区）" }, { "name": "DbMatchMode", "type": "string", "required": false, "description": "库名匹配规则，如Regular（正则匹配）, Default(不符合匹配规则的剩余库)，数组中最后一项必须为‘Default’", "example": "Regular（正则匹配）, Default(不符合匹配规则的剩余库)" }, { "name": "DbName", "type": "string", "required": false, "description": "库名，DbMatchMode=Regular时生效", "example": "db1" }, { "name": "TableMatchMode", "type": "string", "required": false, "description": "表名匹配规则，如Regular（正则匹配）, Default(不符合匹配规则的剩余表)，数组中最后一项必须为‘Default’", "example": "Regular（正则匹配）, Default(不符合匹配规则的剩余表)" }, { "name": "TableName", "type": "string", "required": false, "description": "表名，仅TableMatchMode=Regular时生效", "example": "tb1" }, { "name": "Columns", "type": "array", "required": false, "description": "按列分区时需要选择配置列名，可以选择多列 注意：此字段可能返回 null，表示取不到有效值。", "example": "c1", "item_type": "string" } ] }, { "name": "DataOption", "type": "array", "required": false, "description": "其他附加信息，对于特定数据类型可设置额外参数，比如针对Canal兼容的功能支持：\"canalOfficialFormat\":\"on\"表示打开Canal兼容功能，默认不带。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] } ] }, { "name": "RateLimitOption", "type": "object", "required": false, "description": "任务限速信息", "example": "无", "children": [ { "name": "CurrentDumpThread", "type": "integer", "required": true, "description": "当前生效的全量导出线程数，配置任务时可调整该字段值，注意：如果不设置或设置为0则表示保持当前值，最大值为16", "example": "8" }, { "name": "DefaultDumpThread", "type": "integer", "required": true, "description": "默认的全量导出线程数，该字段仅在出参有意义", "example": "8" }, { "name": "CurrentDumpRps", "type": "integer", "required": true, "description": "当前生效的全量导出Rps，配置任务时可调整该字段值，注意：如果不设置或设置为0则表示保持当前值，最大值为50000000", "example": "400000" }, { "name": "DefaultDumpRps", "type": "integer", "required": true, "description": "默认的全量导出Rps，该字段仅在出参有意义", "example": "400000" }, { "name": "CurrentLoadThread", "type": "integer", "required": true, "description": "当前生效的全量导入线程数，配置任务时可调整该字段值，注意：如果不设置或设置为0则表示保持当前值，最大值为16", "example": "8" }, { "name": "DefaultLoadThread", "type": "integer", "required": true, "description": "默认的全量导入线程数，该字段仅在出参有意义", "example": "8" }, { "name": "CurrentLoadRps", "type": "integer", "required": true, "description": "当前生效的全量导入Rps，配置任务时可调整该字段值，注意：如果不设置或设置为0则表示保持当前值，最大值为50000000", "example": "400000" }, { "name": "DefaultLoadRps", "type": "integer", "required": true, "description": "默认的全量导入Rps，该字段仅在出参有意义", "example": "400000" }, { "name": "CurrentSinkerThread", "type": "integer", "required": true, "description": "当前生效的增量导入线程数，配置任务时可调整该字段值，注意：如果不设置或设置为0则表示保持当前值，最大值为128", "example": "32" }, { "name": "DefaultSinkerThread", "type": "integer", "required": true, "description": "默认的增量导入线程数，该字段仅在出参有意义", "example": "32" }, { "name": "HasUserSetRateLimit", "type": "string", "required": true, "description": "enum:\"no\"/\"yes\"、no表示用户未设置过限速、yes表示设置过限速，该字段仅在出参有意义", "example": "no" } ] }, { "name": "AutoRetryTimeRangeMinutes", "type": "integer", "required": false, "description": "自动重试的时间窗口设置", "example": "20" }, { "name": "StartPosition", "type": "string", "required": false, "description": "同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。", "example": "2023-12-20T19:24:23+08:00" }, { "name": "FilterBeginCommit", "type": "boolean", "required": false, "description": "同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持", "example": "false" }, { "name": "FilterCheckpoint", "type": "boolean", "required": false, "description": "同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持", "example": "false" } ] }, { "name": "AutoRetryTimeRangeMinutes", "type": "integer", "required": false, "description": "自动重试的时间段、可设置5至720分钟、0表示不重试", "example": "5" } ], "required": [ "JobId", "SrcAccessType", "DstAccessType", "Objects" ] }, { "name": "ContinueMigrateJob", "description": "恢复一个暂停中的迁移任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-xxxxxxxx" } ], "required": [ "JobId" ] }, { "name": "ContinueSyncJob", "description": "恢复处于已暂停状态的数据同步任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-xxxxxx" } ], "required": [ "JobId" ] }, { "name": "CreateCheckSyncJob", "description": "校验同步任务，检查必要参数和周边配置。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-n8deuq7e" } ], "required": [ "JobId" ] }, { "name": "CreateCompareTask", "description": "本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartCompare启动一致性校验任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-p1sposne" }, { "name": "TaskName", "type": "string", "required": false, "description": "数据对比任务名称，若为空则默认给CompareTaskId相同值", "example": "compare_test" }, { "name": "ObjectMode", "type": "string", "required": false, "description": "数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)，custom(自定义模式)", "example": "sameAsMigrate" }, { "name": "Objects", "type": "object", "required": false, "description": "数据对比对象，当ObjectMode为custom时，此项需要填写。", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "对象模式 整实例-all,部分对象-partial", "example": "all" }, { "name": "ObjectItems", "type": "array", "required": false, "description": "对象列表", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "DbMode", "type": "string", "required": true, "description": "数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象", "example": "all" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象", "example": "all" }, { "name": "Tables", "type": "array", "required": false, "description": "用于一致性校验的表配置，当 TableMode 为 partial 时，需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "t1" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "column 模式，all 为全部，partial 表示部分(该参数仅对数据同步任务有效)", "example": "all" }, { "name": "Columns", "type": "array", "required": false, "description": "当 ColumnMode 为 partial 时必填(该参数仅对数据同步任务有效)", "example": "无", "item_type": "string" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "id\u003e10" }, { "name": "FilterTimeZone", "type": "string", "required": false, "description": "时区选择。如 \"+08:00\", \"-08:00\", \"+00:00\"（空值等价于\"+00:00\"）", "example": "+08:00" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象(一致性校验不校验视图，当前参数未启作用)", "example": "all" }, { "name": "Views", "type": "array", "required": false, "description": "用于一致性校验的视图配置，当 ViewMode 为 partial 时， 需要填写(一致性校验不校验视图，当前参数未启作用) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "视图名", "example": "view1" } ] } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，目前只支持mongodb链路。如index(索引),shardkey(片键),schema(库表) 注意：此字段可能返回 null，表示取不到有效值。", "example": "index", "item_type": "string" } ] }, { "name": "Options", "type": "object", "required": false, "description": "一致性校验选项", "example": "无", "children": [ { "name": "Method", "type": "string", "required": false, "description": "对比方式：dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比), 默认为dataCheck", "example": "dataCheck" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "抽样比例;范围0,100。默认为100", "example": "100" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数，取值1-8，默认为1", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "对比类型：builtin（内置校验）、independent（独立校验）。默认为builtin，mongodb及redis链路不支持独立校验。", "example": "builtin" }, { "name": "CompareMode", "type": "array", "required": false, "description": "校验类型，枚举值：structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验，Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"full\",\"increment\"]", "item_type": "string" }, { "name": "ReCheckTime", "type": "integer", "required": false, "description": "复检次数", "example": "3" }, { "name": "ReCheckInterval", "type": "integer", "required": false, "description": "复检时间间隔，单位为分钟，取值 1-60", "example": "5" } ] } ], "required": [ "JobId" ] }, { "name": "CreateConsumerGroup", "description": "为订阅实例创建消费者组。 只有状态为运行中的实例支持创建消费组。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例id，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-jvxbbos7c0" }, { "name": "ConsumerGroupName", "type": "string", "required": true, "description": "消费组名称，以数字、字母(大小写)或者_ - .开头，以数字、字母(大小写)结尾。实际生成的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}", "example": "group-1" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名称。以数字、字母(大小写)或者_ - .开头，以数字、字母(大小写)结尾。实际生成的账户全称形如：account-#{SubscribeId}-#{AccountName}", "example": "jason" }, { "name": "Password", "type": "string", "required": true, "description": "消费组密码，长度必须大于3", "example": "qJ3e1Wd~" }, { "name": "Description", "type": "string", "required": false, "description": "消费组备注", "example": "binlog订阅" } ], "required": [ "SubscribeId", "ConsumerGroupName", "AccountName", "Password" ] }, { "name": "CreateMigrateCheckJob", "description": "创建校验迁移任务， 在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看， 校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" } ], "required": [ "JobId" ] }, { "name": "CreateMigrationService", "description": "购买迁移任务。购买成功后会返回随机生成的迁移任务id列表，也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意，一旦购买成功后源及目标数据库类型，源及目标实例地域不可修改。", "status": "online", "parameters": [ { "name": "SrcDatabaseType", "type": "string", "required": true, "description": "源实例数据库类型，如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)", "example": "mysql" }, { "name": "DstDatabaseType", "type": "string", "required": true, "description": "目标实例数据库类型，如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)", "example": "mysql" }, { "name": "SrcRegion", "type": "string", "required": true, "description": "源实例地域，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "DstRegion", "type": "string", "required": true, "description": "目标实例地域，如：ap-guangzhou。注意，目标地域必须和API请求地域保持一致。", "example": "ap-guangzhou" }, { "name": "InstanceClass", "type": "string", "required": true, "description": "实例规格，包括：small、medium、large、xlarge、2xlarge。当前未计费链路仅支持medium字段值。不同规格类型参考[计费概述](https://cloud.tencent.com/document/product/571/18736)", "example": "large" }, { "name": "Count", "type": "integer", "required": false, "description": "购买数量，范围为[1,15]，默认为1", "example": "1" }, { "name": "JobName", "type": "string", "required": false, "description": "迁移服务名称，最大长度128", "example": "migrate_test" }, { "name": "Tags", "type": "array", "required": false, "description": "标签信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] } ], "required": [ "SrcDatabaseType", "DstDatabaseType", "SrcRegion", "DstRegion", "InstanceClass" ] }, { "name": "CreateModifyCheckSyncJob", "description": "在修改同步任务的配置后、通过该接口校验当前任务是否支持修改对象操作", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-cxsasdaq" } ], "required": [ "JobId" ] }, { "name": "CreateSubscribe", "description": "本接口(CreateSubscribe)用于创建一个数据订阅任务。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "订阅的数据库类型，目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)", "example": "mysql" }, { "name": "PayType", "type": "integer", "required": true, "description": "付费方式，枚举值：0-包年包月，1-按量计费", "example": "0" }, { "name": "Duration", "type": "integer", "required": false, "description": "购买时长。当 payType 为包年包月时，该项需要填，单位为月，最小值为 1，最大值为 120。不填默认1", "example": "1" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "是否自动续费。当 payType 为包年包月时，该项需要填。枚举值：0-不自动续费，1-自动续费。默认不自动续费。按量计费设置该标识无效。", "example": "0" }, { "name": "Count", "type": "integer", "required": false, "description": "购买数量,默认为1，最大为10", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "实例资源标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] }, { "name": "Name", "type": "string", "required": false, "description": "任务名，自定义", "example": "binlog订阅" }, { "name": "InstanceClass", "type": "string", "required": false, "description": "订阅实例规格，当前仅支持small、medium、large", "example": "small" } ], "required": [ "Product", "PayType" ] }, { "name": "CreateSubscribeCheckJob", "description": "本接口(CreateSubscribeCheckJob)用于创建一个订阅校验任务。任务必须已经成功调用ConfigureSubscribeJob接口配置了所有的必要信息才能启动校验。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-xxxxxx" } ], "required": [ "SubscribeId" ] }, { "name": "CreateSyncCompareTask", "description": "本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartSyncCompare启动一致性校验任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-p1sposne" }, { "name": "TaskName", "type": "string", "required": false, "description": "数据对比任务名称，若为空则默认给CompareTaskId相同值", "example": "compare_test" }, { "name": "ObjectMode", "type": "string", "required": false, "description": "数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)，custom(自定义模式)", "example": "sameAsMigrate" }, { "name": "Objects", "type": "object", "required": false, "description": "对比对象，当ObjectMode值为custom时，此项需要填写", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "对象模式 整实例-all,部分对象-partial", "example": "all" }, { "name": "ObjectItems", "type": "array", "required": false, "description": "对象列表", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "DbMode", "type": "string", "required": true, "description": "数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象", "example": "all" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象", "example": "all" }, { "name": "Tables", "type": "array", "required": false, "description": "用于一致性校验的表配置，当 TableMode 为 partial 时，需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "t1" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "column 模式，all 为全部，partial 表示部分(该参数仅对数据同步任务有效)", "example": "all" }, { "name": "Columns", "type": "array", "required": false, "description": "当 ColumnMode 为 partial 时必填(该参数仅对数据同步任务有效)", "example": "无", "item_type": "string" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "id\u003e10" }, { "name": "FilterTimeZone", "type": "string", "required": false, "description": "时区选择。如 \"+08:00\", \"-08:00\", \"+00:00\"（空值等价于\"+00:00\"）", "example": "+08:00" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象(一致性校验不校验视图，当前参数未启作用)", "example": "all" }, { "name": "Views", "type": "array", "required": false, "description": "用于一致性校验的视图配置，当 ViewMode 为 partial 时， 需要填写(一致性校验不校验视图，当前参数未启作用) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "视图名", "example": "view1" } ] } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，目前只支持mongodb链路。如index(索引),shardkey(片键),schema(库表) 注意：此字段可能返回 null，表示取不到有效值。", "example": "index", "item_type": "string" } ] }, { "name": "Options", "type": "object", "required": false, "description": "一致性校验选项", "example": "无", "children": [ { "name": "Method", "type": "string", "required": false, "description": "对比方式：dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比), 默认为dataCheck", "example": "dataCheck" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "抽样比例;范围0,100。默认为100", "example": "100" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数，取值1-8，默认为1", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "对比类型：builtin（内置校验）、independent（独立校验）。默认为builtin，mongodb及redis链路不支持独立校验。", "example": "builtin" }, { "name": "CompareMode", "type": "array", "required": false, "description": "校验类型，枚举值：structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验，Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"full\",\"increment\"]", "item_type": "string" }, { "name": "ReCheckTime", "type": "integer", "required": false, "description": "复检次数", "example": "3" }, { "name": "ReCheckInterval", "type": "integer", "required": false, "description": "复检时间间隔，单位为分钟，取值 1-60", "example": "5" } ] } ], "required": [ "JobId" ] }, { "name": "CreateSyncJob", "description": "创建一个同步任务", "status": "online", "parameters": [ { "name": "PayMode", "type": "string", "required": true, "description": "付款类型, 如：PrePay(表示包年包月)、PostPay(表示按时按量)", "example": "PrePay" }, { "name": "SrcDatabaseType", "type": "string", "required": true, "description": "源端数据库类型,如mysql,mariadb,percona,postgresql,cynosdbmysql(表示TDSQL-C MySQL),tdpg(TDSQL PostgreSQL版),tdsqlmysql,tdstore(表示TDSQL TDStore版)等。", "example": "mysql" }, { "name": "SrcRegion", "type": "string", "required": true, "description": "源端数据库所在地域,如ap-guangzhou", "example": "ap-guangzhou" }, { "name": "DstDatabaseType", "type": "string", "required": true, "description": "目标端数据库类型,如mysql,mariadb,percona,cynosdbmysql(表示TDSQL-C MySQL),tdpg(TDSQL PostgreSQL版),tdsqlmysql,kafka,tdstore(表示TDSQL TDStore版)等。", "example": "mysql" }, { "name": "DstRegion", "type": "string", "required": true, "description": "目标端数据库所在地域,如ap-guangzhou", "example": "ap-guangzhou" }, { "name": "Specification", "type": "string", "required": false, "description": "同步任务规格，Standard:标准版，目前仅支持Standard规格。", "example": "Standard" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "购买时长（单位：月），当PayMode值为PrePay则此项配置有意义，默认为1月，取值范围为[1,100]", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] }, { "name": "Count", "type": "integer", "required": false, "description": "一次购买的同步任务数量，取值范围为[1, 10]，默认为1", "example": "1" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "自动续费标识，当PayMode值为PrePay则此项配置有意义，取值为：1（表示自动续费）、0（不自动续费，默认为此值）", "example": "1" }, { "name": "InstanceClass", "type": "string", "required": false, "description": "同步链路规格，如micro,small,medium,large，默认为medium", "example": "large" }, { "name": "JobName", "type": "string", "required": false, "description": "同步任务名称", "example": "test_job" }, { "name": "ExistedJobId", "type": "string", "required": false, "description": "创建类似任务的现有任务Id", "example": "sync-1dd3rjvt" } ], "required": [ "PayMode", "SrcDatabaseType", "SrcRegion", "DstDatabaseType", "DstRegion" ] }, { "name": "DeleteCompareTask", "description": "删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-8yv4w2i1" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9。可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-8yv4w2i1-cmp-37skmii9" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "DeleteConsumerGroup", "description": "本接口(DeleteConsumerGroup)用于删除一个订阅任务的消费组。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "ConsumerGroupName", "type": "string", "required": true, "description": "消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "consumer-grp-subs-9jyki7hniw-test" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "account-subs-9jyki7hniw-test" } ], "required": [ "SubscribeId", "ConsumerGroupName", "AccountName" ] }, { "name": "DeleteSyncCompareTask", "description": "删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "无" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9", "example": "无" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "DescribeCheckSyncJobResult", "description": "查询同步校验任务结果，检查必要参数和周边配置", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "同步实例id（即标识一个同步作业），形如sync-werwfs23，此值必填，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" } ], "required": [] }, { "name": "DescribeCompareReport", "description": "查询一致性校验任务详情", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-amm1jw5q" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "校验任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-amm1jw5q-cmp-bmuum7jk" }, { "name": "DifferenceLimit", "type": "integer", "required": false, "description": "校验不一致结果的 limit", "example": "10" }, { "name": "DifferenceOffset", "type": "integer", "required": false, "description": "不一致的 Offset", "example": "0" }, { "name": "DifferenceDB", "type": "string", "required": false, "description": "搜索条件，不一致的库名", "example": "db1" }, { "name": "DifferenceTable", "type": "string", "required": false, "description": "搜索条件，不一致的表名", "example": "t1" }, { "name": "SkippedLimit", "type": "integer", "required": false, "description": "未校验的 Limit", "example": "10" }, { "name": "SkippedOffset", "type": "integer", "required": false, "description": "未校验的 Offset", "example": "0" }, { "name": "SkippedDB", "type": "string", "required": false, "description": "搜索条件，未校验的库名", "example": "db1" }, { "name": "SkippedTable", "type": "string", "required": false, "description": "搜索条件，未校验的表名", "example": "t1" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "DescribeCompareTasks", "description": "查询一致性校验任务列表。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。", "example": "dts-e7ukka6g" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页设置，表示每页显示多少条任务，默认为 20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "CompareTaskId", "type": "string", "required": false, "description": "校验任务 ID", "example": "dts-5ftw8366-compare-n0pee6pc" }, { "name": "Status", "type": "array", "required": false, "description": "任务状态过滤，可能的值：created - 创建完成；readyRun - 等待运行；running - 运行中；success - 成功；stopping - 结束中；failed - 失败；canceled - 已终止", "example": "[\"running\"]", "item_type": "string" } ], "required": [ "JobId" ] }, { "name": "DescribeConsumerGroups", "description": "本接口(DescribeConsumerGroups)用于获取订阅实例配置的消费者组详情。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例id，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-47damshnra" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回记录的起始偏移量。默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次返回的记录数量。默认10", "example": "1" } ], "required": [ "SubscribeId" ] }, { "name": "DescribeMigrateDBInstances", "description": "本接口用于查询支持迁移的云数据库实例", "status": "online", "parameters": [ { "name": "DatabaseType", "type": "string", "required": true, "description": "数据库类型，如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。", "example": "mysql" }, { "name": "MigrateRole", "type": "string", "required": false, "description": "实例作为迁移的源还是目标,src(表示源)，dst(表示目标)", "example": "dst" }, { "name": "InstanceId", "type": "string", "required": false, "description": "云数据库实例ID，可通过对应业务实例列表获取实例信息。", "example": "cdb-ktexpqjo" }, { "name": "InstanceName", "type": "string", "required": false, "description": "云数据库名称，可通过对应业务实例列表获取实例信息。", "example": "cdb-name1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量限制", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空值或self(表示本账号内资源)、other(表示其他账户资源)", "example": "self" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "AKIDXXXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "vobJXXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "MvIVXXXXXX" } ], "required": [ "DatabaseType" ] }, { "name": "DescribeMigrationCheckJob", "description": "本接口用于创建校验后,获取校验的结果. 能查询到当前校验的状态和进度. 若通过校验, 则可调用'StartMigrateJob' 开始迁移. 若未通过校验, 则能查询到校验失败的原因. 请按照报错, 通过'ModifyMigrationJob'修改迁移配置或是调整源/目标实例的相关参数.", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1ewjspuw" } ], "required": [ "JobId" ] }, { "name": "DescribeMigrationDetail", "description": "查询某个迁移任务详情", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-amm1jw5q" } ], "required": [ "JobId" ] }, { "name": "DescribeMigrationJobs", "description": "查询数据迁移任务列表", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "数据迁移任务ID，如：dts-amm1jw5q", "example": "dts-amm1jw5q" }, { "name": "JobName", "type": "string", "required": false, "description": "数据迁移任务名称", "example": "dts-amm1jw5q" }, { "name": "Status", "type": "array", "required": false, "description": "数据迁移任务状态，可取值包括：created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)", "example": "[\"running\"]", "item_type": "string" }, { "name": "SrcInstanceId", "type": "string", "required": false, "description": "源实例ID，格式如：cdb-c1nl9rpv", "example": "cdb-c1nl9rpv" }, { "name": "SrcRegion", "type": "string", "required": false, "description": "源实例地域，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "SrcDatabaseType", "type": "array", "required": false, "description": "源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql", "example": "[\"mysql\"]", "item_type": "string" }, { "name": "SrcAccessType", "type": "array", "required": false, "description": "源实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)", "example": "[\"cdb\"]", "item_type": "string" }, { "name": "DstInstanceId", "type": "string", "required": false, "description": "目标实例ID，格式如：cdb-c1nl9rpv", "example": "cdb-c1nl9rpv" }, { "name": "DstRegion", "type": "string", "required": false, "description": "目标实例地域，如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "DstDatabaseType", "type": "array", "required": false, "description": "目标源实例数据库类型，如：sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql", "example": "[\"mysql\"]", "item_type": "string" }, { "name": "DstAccessType", "type": "array", "required": false, "description": "目标实例接入类型，值包括：extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)", "example": "[\"cdb\"]", "item_type": "string" }, { "name": "RunMode", "type": "string", "required": false, "description": "任务运行模式，值包括：immediate(立即运行)，timed(定时运行)", "example": "immediate" }, { "name": "OrderSeq", "type": "string", "required": false, "description": "排序方式，可能取值为asc、desc，默认按照创建时间倒序", "example": "desc" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回实例数量，默认20，有效区间[1,100]", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "TagFilters", "type": "array", "required": false, "description": "标签过滤", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键值", "example": "key" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "[value1, value2]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeModifyCheckSyncJobResult", "description": "在创建修改对象的校验任务后、通过该接口查看校验任务的结果", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-csasweee" } ], "required": [ "JobId" ] }, { "name": "DescribeOffsetByTime", "description": "本接口(DescribeOffsetByTime)查询KafkaTopic中指定时间前最近的offset。 接口输出的offset是离这个时间最近的offset。 如果输入时间比当前时间晚的多，相当于输出的就是最新的offset； 如果输入时间比当前时间早的多，相当于输出的就是最老的offset； 如果输入空，默认0时间，也就是查询最老的offset。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "Time", "type": "string", "required": true, "description": "时间点，格式为：Y-m-d h:m:s。如果输入时间比当前时间晚的多，相当于查询最新offset；如果输入时间比当前时间早的多，相当于查询最老offset；如果输入空，默认0时间，等价于查询最老offset。", "example": "2023-05-15 16:31:33" } ], "required": [ "SubscribeId", "Time" ] }, { "name": "DescribeSubscribeCheckJob", "description": "本接口(DescribeSubscribeCheckJob)用于查询订阅校验任务结果。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "subs-l4d3a7izai" } ], "required": [ "SubscribeId" ] }, { "name": "DescribeSubscribeDetail", "description": "本接口(DescribeSubscribeDetail)获取数据订阅实例的配置信息。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-xxxxxx" } ], "required": [ "SubscribeId" ] }, { "name": "DescribeSubscribeJobs", "description": "本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": false, "description": "订阅 ID 筛选，精确匹配", "example": "subs-9jyki7hniw" }, { "name": "SubscribeIds", "type": "array", "required": false, "description": "订阅 ID 筛选，精确匹配", "example": "[\"subs-9jyki7hniw\",\"subs-31adyjj41f\"]\"]", "item_type": "string" }, { "name": "SubscribeName", "type": "string", "required": false, "description": "订阅名称，前缀模糊匹配", "example": "binlog订阅" }, { "name": "InstanceId", "type": "string", "required": false, "description": "订阅的云上数据库实例的 ID，精确匹配", "example": "cdb-kdxona7h" }, { "name": "Topic", "type": "string", "required": false, "description": "订阅的topicName", "example": "topic-subs-g9k9ct7gmc--6itdltb8" }, { "name": "PayType", "type": "integer", "required": false, "description": "计费模式筛选，可能的值：0-包年包月，1-按量计费", "example": "1" }, { "name": "Product", "type": "string", "required": false, "description": "订阅的数据库产品，目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)", "example": "mysql" }, { "name": "Status", "type": "array", "required": false, "description": "数据订阅生命周期状态，可能的值为：正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining，按量转包年包月中 post2PrePayIng", "example": "normal", "item_type": "string" }, { "name": "SubsStatus", "type": "array", "required": false, "description": "数据订阅状态，可能的值为：未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error", "example": "running", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回记录的起始偏移量。默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次返回的记录数量。默认20，最大100", "example": "20" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方向，可选的值为\"DESC\"和\"ASC\"，默认为\"DESC\"，按创建时间逆序排序", "example": "ASC" }, { "name": "TagFilters", "type": "array", "required": false, "description": "tag 过滤条件，多个 TagFilter 之间关系为且", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键值", "example": "key" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "[value1, value2]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeSubscribeReturnable", "description": "本接口(DescribeSubscribeReturnable)用于查询订阅任务是否可以销毁和退货。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" } ], "required": [ "SubscribeId" ] }, { "name": "DescribeSyncCompareReport", "description": "查询一致性校验任务详情", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-amm1jw5q" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "校验任务 Id", "example": "sync-amm1jw5q-cmp-bmuum7jk" }, { "name": "DifferenceLimit", "type": "integer", "required": false, "description": "校验不一致结果的 limit", "example": "10" }, { "name": "DifferenceOffset", "type": "integer", "required": false, "description": "不一致的 Offset", "example": "0" }, { "name": "DifferenceDB", "type": "string", "required": false, "description": "搜索条件，不一致的库名", "example": "db1" }, { "name": "DifferenceTable", "type": "string", "required": false, "description": "搜索条件，不一致的表名", "example": "t1" }, { "name": "SkippedLimit", "type": "integer", "required": false, "description": "未校验的 Limit", "example": "10" }, { "name": "SkippedOffset", "type": "integer", "required": false, "description": "未校验的 Offset", "example": "0" }, { "name": "SkippedDB", "type": "string", "required": false, "description": "搜索条件，未校验的库名", "example": "db1" }, { "name": "SkippedTable", "type": "string", "required": false, "description": "搜索条件，未校验的表名", "example": "t1" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "DescribeSyncCompareTasks", "description": "查询一致性校验任务列表。通过该接口可查看改任务下所有一致性校验任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-e7ukka6g" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页设置，表示每页显示多少条任务，默认为 20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "CompareTaskId", "type": "string", "required": false, "description": "校验任务 ID", "example": "sync-5ftw8366-compare-n0pee6pc" }, { "name": "Status", "type": "array", "required": false, "description": "任务状态过滤，可能的值：created - 创建完成；readyRun - 等待运行；running - 运行中；success - 成功；stopping - 结束中；failed - 失败；canceled - 已终止", "example": "[\"running\"]", "item_type": "string" } ], "required": [ "JobId" ] }, { "name": "DescribeSyncJobs", "description": "查询同步任务信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "同步任务id，如sync-werwfs23，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-n3gh7md9" }, { "name": "JobIds", "type": "array", "required": false, "description": "同步任务id列表，如[\"sync-n3gh7md9\"]", "example": "[\"sync-n3gh7md9\"]", "item_type": "string" }, { "name": "JobName", "type": "string", "required": false, "description": "同步任务名", "example": "sync-n3gh7md9" }, { "name": "Order", "type": "string", "required": false, "description": "排序字段，目前仅支持CreateTime字段排序", "example": "CreateTime" }, { "name": "OrderSeq", "type": "string", "required": false, "description": "排序方式，升序为ASC，降序为DESC，默认为CreateTime降序", "example": "DESC" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回同步任务实例数量，默认20，有效区间[1,100]", "example": "2" }, { "name": "Status", "type": "array", "required": false, "description": "状态集合，如Initialized(初始化),CheckPass(校验通过),Running(运行中),ResumableErr(恢复中),Stopped(已结束)", "example": "[\"Running\"]", "item_type": "string" }, { "name": "RunMode", "type": "string", "required": false, "description": "运行模式，如Immediate:立即运行，Timed:定时运行", "example": "Immediate" }, { "name": "JobType", "type": "string", "required": false, "description": "任务类型，如mysql2mysql：msyql同步到mysql;可取值有mysql2mysql、mysql2kafka、tdsqlmysql2kafka、tdsqlmysql2tdsqlmysql、tdsqlmysql2mysql、mysql2tdsqlmysql、mysql2mariadb、mariadb2mariadb、mariadb2kafka、cynosdbmysql2kafka、cynosdbmysql2cynosdbmysql、cynosdbmysql2mysql、mysql2cynosdbmysql、mariadb2tdsqlmysql、tdsqlmysql2cynosdbmysql、cynosdbmysql2tdsqlmysql、tdstore2mysql、tdstore2percona、tdstore2mariadb、tdstore2cynosdbmysql、cynosdbmysql2mariadb、mariadb2cynosdb...", "example": "mysql2mysql" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费类型，PrePay：预付费，PostPay：后付费", "example": "PostPay" }, { "name": "TagFilters", "type": "array", "required": false, "description": "tag", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键值", "example": "key" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签值", "example": "[value1, value2]", "item_type": "string" } ] }, { "name": "SrcInfoPattern", "type": "string", "required": false, "description": "源端数据库连接信息，可以输入实例ID或者IP等", "example": "cdb-jk09iy6a" }, { "name": "DstInfoPattern", "type": "string", "required": false, "description": "目标端数据库连接信息，可以输入实例ID或者IP等", "example": "cdb-jk09iy6a" } ], "required": [] }, { "name": "DestroyIsolatedSubscribe", "description": "本接口（DestroyIsolatedSubscribe）用于下线已隔离的数据订阅实例", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" } ], "required": [ "SubscribeId" ] }, { "name": "DestroyMigrateJob", "description": "下线数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口，且只有是**已隔离**状态下，才能调用此接口销毁任务。对于不计费任务，调用隔离(IsolateMigrateJob)接口删除任务操作。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-j7bt5sid" } ], "required": [] }, { "name": "DestroySyncJob", "description": "下线同步任务，任务在已隔离状态下可以通过此操作进行任务下线，即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态，此操作成功后无法看到此任务表示下线成功。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" } ], "required": [ "JobId" ] }, { "name": "IsolateMigrateJob", "description": "隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务，在任务隔离后可进行解除隔离(RecoverMigrateJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务，调用此接口会直接销毁任务，无法进行恢复操作。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-amm1jw5q" } ], "required": [ "JobId" ] }, { "name": "IsolateSubscribe", "description": "本接口（IsolateSubscribe）用于隔离订阅任务。调用后，订阅任务将不能使用。按量计费的任务会停止计费，包年包月的任务会自动退费", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" } ], "required": [ "SubscribeId" ] }, { "name": "IsolateSyncJob", "description": "隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" } ], "required": [ "JobId" ] }, { "name": "ModifyCompareTask", "description": "修改一致性校验任务，在任务创建后启动之前，可修改一致性校验参数", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-45jhpmjh" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-45jhpmjh-cmp-k7uhq1v3" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称", "example": "初始校验任务" }, { "name": "ObjectMode", "type": "string", "required": false, "description": "数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)、custom(自定义)，注意自定义对比对象必须是迁移对象的子集", "example": "sameAsMigrate" }, { "name": "Objects", "type": "object", "required": false, "description": "对比对象，若CompareObjectMode取值为custom，则此项必填", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "对象模式 整实例-all,部分对象-partial", "example": "all" }, { "name": "ObjectItems", "type": "array", "required": false, "description": "对象列表", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "DbMode", "type": "string", "required": true, "description": "数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象", "example": "all" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象", "example": "all" }, { "name": "Tables", "type": "array", "required": false, "description": "用于一致性校验的表配置，当 TableMode 为 partial 时，需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "t1" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "column 模式，all 为全部，partial 表示部分(该参数仅对数据同步任务有效)", "example": "all" }, { "name": "Columns", "type": "array", "required": false, "description": "当 ColumnMode 为 partial 时必填(该参数仅对数据同步任务有效)", "example": "无", "item_type": "string" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "id\u003e10" }, { "name": "FilterTimeZone", "type": "string", "required": false, "description": "时区选择。如 \"+08:00\", \"-08:00\", \"+00:00\"（空值等价于\"+00:00\"）", "example": "+08:00" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象(一致性校验不校验视图，当前参数未启作用)", "example": "all" }, { "name": "Views", "type": "array", "required": false, "description": "用于一致性校验的视图配置，当 ViewMode 为 partial 时， 需要填写(一致性校验不校验视图，当前参数未启作用) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "视图名", "example": "view1" } ] } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，目前只支持mongodb链路。如index(索引),shardkey(片键),schema(库表) 注意：此字段可能返回 null，表示取不到有效值。", "example": "index", "item_type": "string" } ] }, { "name": "Options", "type": "object", "required": false, "description": "一致性校验选项", "example": "无", "children": [ { "name": "Method", "type": "string", "required": false, "description": "对比方式：dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比), 默认为dataCheck", "example": "dataCheck" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "抽样比例;范围0,100。默认为100", "example": "100" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数，取值1-8，默认为1", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "对比类型：builtin（内置校验）、independent（独立校验）。默认为builtin，mongodb及redis链路不支持独立校验。", "example": "builtin" }, { "name": "CompareMode", "type": "array", "required": false, "description": "校验类型，枚举值：structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验，Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"full\",\"increment\"]", "item_type": "string" }, { "name": "ReCheckTime", "type": "integer", "required": false, "description": "复检次数", "example": "3" }, { "name": "ReCheckInterval", "type": "integer", "required": false, "description": "复检时间间隔，单位为分钟，取值 1-60", "example": "5" } ] } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "ModifyCompareTaskName", "description": "修改一致性校验任务名称", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-8yv4w2i1" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-8yv4w2i1-cmp-37skmii9" }, { "name": "TaskName", "type": "string", "required": true, "description": "一致性校验任务名称", "example": "cmp_test" } ], "required": [ "JobId", "CompareTaskId", "TaskName" ] }, { "name": "ModifyConsumerGroupDescription", "description": "本接口(ModifyConsumerGroupDescription)用于修改指定订阅消费组备注。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "ConsumerGroupName", "type": "string", "required": true, "description": "消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "consumer-grp-subs-9jyki7hniw-group-1" }, { "name": "AccountName", "type": "string", "required": true, "description": "账户名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "account-subs-9jyki7hniw-jason" }, { "name": "Description", "type": "string", "required": true, "description": "修改之后的消费组描述", "example": "binlog订阅" } ], "required": [ "SubscribeId", "ConsumerGroupName", "AccountName", "Description" ] }, { "name": "ModifyConsumerGroupPassword", "description": "本接口(ModifyConsumerGroupPassword)用于修改指定订阅消费组密码。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "account-subs-9jyki7hniw-jason" }, { "name": "ConsumerGroupName", "type": "string", "required": true, "description": "消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。", "example": "consumer-grp-subs-9jyki7hniw-group-1" }, { "name": "NewPassword", "type": "string", "required": true, "description": "新密码。字符长度不小于3，不大于32", "example": "dliasyud" } ], "required": [ "SubscribeId", "AccountName", "ConsumerGroupName", "NewPassword" ] }, { "name": "ModifyMigrateJobSpec", "description": "调整实例规格，此接口只支持按量计费任务的调整，且仅在计费或者待计费状态下支持修改。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-j7bt5sid" }, { "name": "NewInstanceClass", "type": "string", "required": true, "description": "新实例规格大小，包括：micro、small、medium、large、xlarge、2xlarge", "example": "xlarge" } ], "required": [ "JobId", "NewInstanceClass" ] }, { "name": "ModifyMigrateName", "description": "修改迁移任务名", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-7itt1j4w" }, { "name": "JobName", "type": "string", "required": true, "description": "修改后的迁移任务名", "example": "userDefine" } ], "required": [ "JobId", "JobName" ] }, { "name": "ModifyMigrateRateLimit", "description": "用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率；此操作仅在任务运行中可执行。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-saasxa" }, { "name": "DumpThread", "type": "integer", "required": false, "description": "迁移任务全量导出线程数、有效值为 1-16", "example": "8" }, { "name": "DumpRps", "type": "integer", "required": false, "description": "迁移全量导出的 Rps 限制、需要大于 0", "example": "400000" }, { "name": "LoadThread", "type": "integer", "required": false, "description": "迁移任务全量导入线程数、有效值为 1-16", "example": "8" }, { "name": "SinkerThread", "type": "integer", "required": false, "description": "迁移任务增量导入线程数、有效值为 1-128", "example": "32" }, { "name": "LoadRps", "type": "integer", "required": false, "description": "全量导入Rps限制", "example": "400000" } ], "required": [ "JobId" ] }, { "name": "ModifyMigrateRuntimeAttribute", "description": "修改任务运行时属性，此接口不同于配置类接口，不会进行状态机判断。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-7itt1j4w" }, { "name": "OtherOptions", "type": "array", "required": true, "description": "需要修改的属性，此结构设计为通用结构，用于屏蔽多个业务的定制属性。例如对于Redis:{ \"Key\": \"DstWriteMode\", //目标库写入模式 \"Value\": \"normal\" //clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样，不做额外动作，默认为此值) },{ \"Key\": \"IsDstReadOnly\", //是否在迁移时设置目标库只读 \"Value\": \"true\" //true(设置只读)、false(不设置只读) }", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] } ], "required": [ "JobId", "OtherOptions" ] }, { "name": "ModifyMigrationJob", "description": "配置迁移服务，配置成功后可通过`CreateMigrateCheckJob` 创建迁移校验任务接口发起校验任务，只有校验通过才能启动迁移任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，可通过DescribeMigrationJobs接口获取。", "example": "dts-1ewjspuw" }, { "name": "RunMode", "type": "string", "required": true, "description": "运行模式，取值如：immediate(表示立即运行)、timed(表示定时运行)", "example": "immediate" }, { "name": "MigrateOption", "type": "object", "required": true, "description": "迁移任务配置选项，描述任务如何执行迁移等一系列配置信息；字段下的RateLimitOption不可配置、如果需要修改任务的限速信息、请在任务运行后通过ModifyMigrateRateLimit接口修改", "example": "无", "children": [ { "name": "DatabaseTable", "type": "object", "required": true, "description": "迁移对象选项，需要告知迁移服务迁移哪些库表对象", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "迁移对象类型 all(全实例)，partial(部分对象)", "example": "partial" }, { "name": "Databases", "type": "array", "required": false, "description": "迁移对象，当 ObjectMode 为 partial 时，不为空", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": false, "description": "需要迁移或同步的库名，当ObjectMode为partial时，此项必填", "example": "db1" }, { "name": "NewDbName", "type": "string", "required": false, "description": "迁移或同步后的库名，默认与源库相同", "example": "db1_new" }, { "name": "SchemaName", "type": "string", "required": false, "description": "迁移或同步的 schema", "example": "schema1" }, { "name": "NewSchemaName", "type": "string", "required": false, "description": "迁移或同步后的 schema name", "example": "schema1_new" }, { "name": "DBMode", "type": "string", "required": false, "description": "DB选择模式: all(为当前对象下的所有对象)，partial(部分对象)，当ObjectMode为partial时，此项必填", "example": "all" }, { "name": "SchemaMode", "type": "string", "required": false, "description": "schema选择模式: all(为当前对象下的所有对象)，partial(部分对象)", "example": "all" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: all(为当前对象下的所有对象)，partial(部分对象)，当DBMode为partial时此项必填", "example": "all" }, { "name": "Tables", "type": "array", "required": false, "description": "表图对象集合，当 TableMode 为 partial 时，此项需要填写", "example": "无", "item_type": "string" }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象", "example": "all" }, { "name": "Views", "type": "array", "required": false, "description": "视图对象集合，当 ViewMode 为 partial 时， 此项需要填写", "example": "无", "item_type": "string" }, { "name": "RoleMode", "type": "string", "required": false, "description": "postgresql独有参数，角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象", "example": "all" }, { "name": "Roles", "type": "array", "required": false, "description": "postgresql独有参数，当 RoleMode 为 partial 时， 此项需要填写", "example": "无", "item_type": "string" }, { "name": "FunctionMode", "type": "string", "required": false, "description": "选择要同步的模式，partial为部分，all为整选", "example": "all" }, { "name": "TriggerMode", "type": "string", "required": false, "description": "选择要同步的模式，partial为部分，all为整选", "example": "all" }, { "name": "EventMode", "type": "string", "required": false, "description": "选择要同步的模式，partial为部分，all为整选", "example": "all" }, { "name": "ProcedureMode", "type": "string", "required": false, "description": "选择要同步的模式，partial为部分，all为整选", "example": "all" }, { "name": "Functions", "type": "array", "required": false, "description": "FunctionMode取值为partial时需要填写", "example": "[\"function_name\"]", "item_type": "string" }, { "name": "Procedures", "type": "array", "required": false, "description": "ProcedureMode取值为partial时需要填写", "example": "[\"procedure_name\"]", "item_type": "string" }, { "name": "Events", "type": "array", "required": false, "description": "EventMode取值为partial时需要填写", "example": "[\"event_name\"]", "item_type": "string" }, { "name": "Triggers", "type": "array", "required": false, "description": "TriggerMode取值为partial时需要填写", "example": "[\"trigger_name\"]", "item_type": "string" } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，如trigger(触发器)、function(函数)、procedure(存储过程)、event(事件)。注意：如果要迁移同步高级对象，此配置中应该包含对应的高级对象类型。 \u003e 当前支持高级对象迁移的场景为MySQL、TDSQL-CMySQL、MariaDB、Percona之间的数据迁移。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"trigger\"]", "item_type": "string" } ] }, { "name": "MigrateType", "type": "string", "required": false, "description": "迁移类型，full(全量迁移)，structure(结构迁移)，fullAndIncrement(全量加增量迁移)， 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。", "example": "fullAndIncrement" }, { "name": "Consistency", "type": "object", "required": false, "description": "数据一致性校验选项， 默认为不开启一致性校验 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "一致性检测类型: full(全量检测迁移对象)、noCheck(不检测)、notConfigured(未配置)", "example": "noCheck" }, { "name": "ObjectMode", "type": "string", "required": false, "description": "校验对象选择。枚举值：sameAsMigrate-与迁移同步任务相同、custom-用户自定义，搭配Objects操作", "example": "custom" }, { "name": "Objects", "type": "object", "required": false, "description": "校验对象 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "迁移对象类型 all(全实例)，partial(部分对象)", "example": "partial" }, { "name": "Databases", "type": "array", "required": false, "description": "迁移对象，当 ObjectMode 为 partial 时，不为空", "example": "无", "item_type": "string" }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，如trigger(触发器)、function(函数)、procedure(存储过程)、event(事件)。注意：如果要迁移同步高级对象，此配置中应该包含对应的高级对象类型。 \u003e 当前支持高级对象迁移的场景为MySQL、TDSQL-CMySQL、MariaDB、Percona之间的数据迁移。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"trigger\"]", "item_type": "string" } ] }, { "name": "Options", "type": "object", "required": false, "description": "校验配置", "example": "无", "children": [ { "name": "Method", "type": "string", "required": false, "description": "对比方式：dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比), 默认为dataCheck", "example": "dataCheck" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "抽样比例;范围0,100。默认为100", "example": "100" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数，取值1-8，默认为1", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "对比类型：builtin（内置校验）、independent（独立校验）。默认为builtin，mongodb及redis链路不支持独立校验。", "example": "builtin" }, { "name": "CompareMode", "type": "array", "required": false, "description": "校验类型，枚举值：structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验，Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"full\",\"increment\"]", "item_type": "string" }, { "name": "ReCheckTime", "type": "integer", "required": false, "description": "复检次数", "example": "3" }, { "name": "ReCheckInterval", "type": "integer", "required": false, "description": "复检时间间隔，单位为分钟，取值 1-60", "example": "5" } ] } ] }, { "name": "IsMigrateAccount", "type": "boolean", "required": false, "description": "是否迁移账号，true(迁移账号)，false(不迁移账号)", "example": "false" }, { "name": "IsOverrideRoot", "type": "boolean", "required": false, "description": "是否用源库Root账户覆盖目标库，值包括：false-不覆盖，true-覆盖，选择库表或者结构迁移时应该为false，注意只对旧版迁移有效", "example": "false" }, { "name": "IsDstReadOnly", "type": "boolean", "required": false, "description": "是否在迁移时设置目标库只读(仅对mysql有效)，true(设置只读)、false(不设置只读，默认此值)", "example": "false" }, { "name": "ExtraAttr", "type": "array", "required": false, "description": "其他附加信息，对于特定库可设置额外参数，Redis可定义如下的参数: [\"DstWriteMode\":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(要求目标端为空，否则校验不通过) ，不显示指定默认以覆盖写的方式执行任务 \"IsDstReadOnly\":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) \"ClientOutputBufferHardLimit\":512, 从机缓冲区\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] }, { "name": "MigrateWay", "type": "string", "required": false, "description": "pgsql迁移分类：logical(逻辑迁移)、physical(物理迁移)", "example": "logical" } ] }, { "name": "SrcInfo", "type": "object", "required": true, "description": "源实例信息", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "实例所在地域", "example": "ap-guangzhou" }, { "name": "AccessType", "type": "string", "required": true, "description": "实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云服务器自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路", "example": "cdb" }, { "name": "DatabaseType", "type": "string", "required": true, "description": "实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等", "example": "mysql" }, { "name": "NodeType", "type": "string", "required": true, "description": "节点类型，simple表示普通节点、cluster表示集群节点； 对于mongo业务，取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)； 对于redis实例，simple(单节点)、cluster-cache(直连集群)、cluster-proxy(代理集群)；", "example": "simple" }, { "name": "Info", "type": "array", "required": true, "description": "实例具体的连接信息，如ip、port、接入方式等", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": false, "description": "表示节点角色，针对分布式数据库，如mongodb中的mongos节点。tdsqlmysql的可选项：proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填。", "example": "mongos" }, { "name": "DbKernel", "type": "string", "required": false, "description": "内核版本，针对mariadb的不同内核版本等", "example": "mysql" }, { "name": "Host", "type": "string", "required": false, "description": "实例的IP地址，对于公网、专线、VPN、云联网、自研上云、VPC等接入方式此项必填", "example": "192.2.3.4" }, { "name": "Port", "type": "integer", "required": false, "description": "实例的端口，对于公网、云主机自建、专线、VPN、云联网、自研上云、VPC等接入方式此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "实例的用户名", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "实例的密码", "example": "password" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8；与云服务器控制台页面显示的实例ID相同；如果接入类型为云主机自建的方式，此项必填", "example": "ins-olgl39y8" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，格式如：vpngw-9ghexg7q；如果接入类型为vpncloud的方式，此项必填", "example": "vpngw-9ghexg7q" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，格式如：dcg-0rxtqqxb；如果接入类型为专线接入的方式，此项必填", "example": "dcg-0rxtqqxb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q；如果接入类型为云数据库的方式，此项必填", "example": "cdb-powiqx8q" }, { "name": "CcnGwId", "type": "string", "required": false, "description": "云联网ID，如：ccn-afp6kltc 注意：此字段可能返回 null，表示取不到有效值。", "example": "ccn-afp6kltc" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，格式如：vpc-92jblxto；如果接入类型为vpc、vpncloud、ccn、dcg的方式，此项必填", "example": "vpc-92jblxto" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，格式如：subnet-3paxmkdz；如果接入类型为vpc、vpncloud、ccn、dcg的方式，此项必填", "example": "subnet-3paxmkdz" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号", "example": "700000123456" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号迁移时的角色,只允许[a-zA-Z0-9-_]+", "example": "role" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示其他账户资源)", "example": "self" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "AKIDXXXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "2qZDsXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "NRUkuXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1" } ] }, { "name": "Supplier", "type": "string", "required": false, "description": "实例服务提供商，如:\"others\",\"aliyun\",\"aws\"", "example": "others" }, { "name": "ExtraAttr", "type": "array", "required": false, "description": "此参数为数组类型，可以传多个键值对结构对象。 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表示迁移\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "ConnectType", "type": "string", "required": false, "description": "tdsql连接方式：proxy-通过tdsql proxy主机访问各个set节点，注意只有在自研上云的网络环境下才能通过这种方式连接，Info中只需要提供proxy主机信息。set-直连set节点，如选择直连set方式，Info中需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。", "example": "proxy" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "云联网网关所属账号，如果云联网网关为其他账号资源需要填写", "example": "212221111" } ] }, { "name": "DstInfo", "type": "object", "required": true, "description": "目标实例信息", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "实例所在地域", "example": "ap-guangzhou" }, { "name": "AccessType", "type": "string", "required": true, "description": "实例网络接入类型，如：extranet(外网)、ipv6(公网ipv6)、cvm(云服务器自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等，注意具体可选值依赖当前链路", "example": "cdb" }, { "name": "DatabaseType", "type": "string", "required": true, "description": "实例数据库类型，如：mysql,redis,mongodb,postgresql,mariadb,percona 等", "example": "mysql" }, { "name": "NodeType", "type": "string", "required": true, "description": "节点类型，simple表示普通节点、cluster表示集群节点； 对于mongo业务，取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)； 对于redis实例，simple(单节点)、cluster-cache(直连集群)、cluster-proxy(代理集群)；", "example": "simple" }, { "name": "Info", "type": "array", "required": true, "description": "实例具体的连接信息，如ip、port、接入方式等", "example": "无", "item_type": "object", "children": [ { "name": "Role", "type": "string", "required": false, "description": "表示节点角色，针对分布式数据库，如mongodb中的mongos节点。tdsqlmysql的可选项：proxy表示节点类型为主机，set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填。", "example": "mongos" }, { "name": "DbKernel", "type": "string", "required": false, "description": "内核版本，针对mariadb的不同内核版本等", "example": "mysql" }, { "name": "Host", "type": "string", "required": false, "description": "实例的IP地址，对于公网、专线、VPN、云联网、自研上云、VPC等接入方式此项必填", "example": "192.2.3.4" }, { "name": "Port", "type": "integer", "required": false, "description": "实例的端口，对于公网、云主机自建、专线、VPN、云联网、自研上云、VPC等接入方式此项必填", "example": "3306" }, { "name": "User", "type": "string", "required": false, "description": "实例的用户名", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "实例的密码", "example": "password" }, { "name": "CvmInstanceId", "type": "string", "required": false, "description": "CVM实例短ID，格式如：ins-olgl39y8；与云服务器控制台页面显示的实例ID相同；如果接入类型为云主机自建的方式，此项必填", "example": "ins-olgl39y8" }, { "name": "UniqVpnGwId", "type": "string", "required": false, "description": "VPN网关ID，格式如：vpngw-9ghexg7q；如果接入类型为vpncloud的方式，此项必填", "example": "vpngw-9ghexg7q" }, { "name": "UniqDcgId", "type": "string", "required": false, "description": "专线网关ID，格式如：dcg-0rxtqqxb；如果接入类型为专线接入的方式，此项必填", "example": "dcg-0rxtqqxb" }, { "name": "InstanceId", "type": "string", "required": false, "description": "数据库实例ID，格式如：cdb-powiqx8q；如果接入类型为云数据库的方式，此项必填", "example": "cdb-powiqx8q" }, { "name": "CcnGwId", "type": "string", "required": false, "description": "云联网ID，如：ccn-afp6kltc 注意：此字段可能返回 null，表示取不到有效值。", "example": "ccn-afp6kltc" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID，格式如：vpc-92jblxto；如果接入类型为vpc、vpncloud、ccn、dcg的方式，此项必填", "example": "vpc-92jblxto" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络下的子网ID，格式如：subnet-3paxmkdz；如果接入类型为vpc、vpncloud、ccn、dcg的方式，此项必填", "example": "subnet-3paxmkdz" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "数据库版本，当实例为RDS实例时才有效，格式如：5.6或者5.7，默认为5.6", "example": "5.6" }, { "name": "Account", "type": "string", "required": false, "description": "实例所属账号", "example": "700000123456" }, { "name": "AccountRole", "type": "string", "required": false, "description": "跨账号迁移时的角色,只允许[a-zA-Z0-9-_]+", "example": "role" }, { "name": "AccountMode", "type": "string", "required": false, "description": "资源所属账号 为空或self(表示本账号内资源)、other(表示其他账户资源)", "example": "self" }, { "name": "TmpSecretId", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "AKIDXXXXXX" }, { "name": "TmpSecretKey", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "2qZDsXXXXX" }, { "name": "TmpToken", "type": "string", "required": false, "description": "临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。", "example": "NRUkuXXXXX" }, { "name": "EncryptConn", "type": "string", "required": false, "description": "是否走加密传输、UnEncrypted表示不走加密传输，Encrypted表示走加密传输，默认UnEncrypted", "example": "UnEncrypted" }, { "name": "SetId", "type": "string", "required": false, "description": "tdsql的分片id。如节点类型为set必填。", "example": "set_1693279393_1" } ] }, { "name": "Supplier", "type": "string", "required": false, "description": "实例服务提供商，如:\"others\",\"aliyun\",\"aws\"", "example": "others" }, { "name": "ExtraAttr", "type": "array", "required": false, "description": "此参数为数组类型，可以传多个键值对结构对象。 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表示迁移\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] }, { "name": "DatabaseNetEnv", "type": "string", "required": false, "description": "数据库所属网络环境，AccessType为云联网(ccn)时必填， UserIDC表示用户IDC、TencentVPC表示腾讯云VPC；", "example": "TencentVPC" }, { "name": "ConnectType", "type": "string", "required": false, "description": "tdsql连接方式：proxy-通过tdsql proxy主机访问各个set节点，注意只有在自研上云的网络环境下才能通过这种方式连接，Info中只需要提供proxy主机信息。set-直连set节点，如选择直连set方式，Info中需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。", "example": "proxy" }, { "name": "CcnOwnerUin", "type": "string", "required": false, "description": "云联网网关所属账号，如果云联网网关为其他账号资源需要填写", "example": "212221111" } ] }, { "name": "JobName", "type": "string", "required": false, "description": "迁移任务名称，最大长度128", "example": "migrate_test" }, { "name": "ExpectRunTime", "type": "string", "required": false, "description": "期待启动时间，当RunMode取值为timed时，此值必填，形如：\u0026quot;2006-01-02 15:04:05\u0026quot;", "example": "2022-07-11 17:20:56" }, { "name": "Tags", "type": "array", "required": false, "description": "标签信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value" } ] }, { "name": "AutoRetryTimeRangeMinutes", "type": "integer", "required": false, "description": "自动重试的时间段、可设置5至720分钟、0表示不重试", "example": "5" } ], "required": [ "JobId", "RunMode", "MigrateOption", "SrcInfo", "DstInfo" ] }, { "name": "ModifySubscribeAutoRenewFlag", "description": "修改订阅实例自动续费标识。只有包年包月的任务修改才有意义，按量计费任务修改后无影响。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "自动续费标识。1-自动续费，0-不自动续费", "example": "1" } ], "required": [ "SubscribeId", "AutoRenewFlag" ] }, { "name": "ModifySubscribeName", "description": "本接口(ModifySubscribeName)用于修改数据订阅实例的名称", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "SubscribeName", "type": "string", "required": true, "description": "修改后的数据订阅实例的名称，长度限制为[1,60]", "example": "binlog订阅" } ], "required": [ "SubscribeId", "SubscribeName" ] }, { "name": "ModifySubscribeObjects", "description": "本接口(ModifySubscribeObjects)用于修改数据订阅对象和kafka分区规则，如果是mongo订阅，还可以修改输出聚合规则。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" }, { "name": "SubscribeObjectType", "type": "integer", "required": true, "description": "数据订阅的类型，非mongo任务的枚举值：0-全实例更新；1-数据更新；2-结构更新；3-数据更新+结构更新。mongo任务的枚举值：0-全实例更新；4-订阅单库；5-订阅单集合", "example": "0" }, { "name": "Objects", "type": "array", "required": false, "description": "修改后的订阅数据库表信息。会覆盖原来的订阅对象，所以除非 SubscribeObjectType = 0或2，否则该字段必填。", "example": "无", "item_type": "object", "children": [ { "name": "ObjectsType", "type": "integer", "required": true, "description": "订阅对象的类型，枚举值为：0-库，1-表(该值对于mongo任务来说，是集合) 。 注意：mongo只支持全实例、单库或者单集合订阅，因此该字段不要与SubscribeObjectType冲突。如：SubscribeObjectType=4，表示mongo单库订阅，那么该字段应该传0。", "example": "1" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "订阅数据库的名称", "example": "db_1" }, { "name": "TableNames", "type": "array", "required": false, "description": "订阅数据库中表(或集合)的名称。如果 ObjectsType 为 1，那么此字段为必填，且不为空；", "example": "[\"tabl_1\"]", "item_type": "string" } ] }, { "name": "DistributeRules", "type": "array", "required": false, "description": "kafka分区策略。如果不填，默认不修改。如果填了，会覆盖原来的策略。", "example": "无", "item_type": "object", "children": [ { "name": "RuleType", "type": "string", "required": true, "description": "规则类型。非mongo产品的枚举值为: table-按表名分区，pk-按表名+主键分区，cols-按列名分区。mongo的枚举值为：collection-按集合名分区、collectionAndObjectId-按集合+主键分区。", "example": "table" }, { "name": "DbPattern", "type": "string", "required": true, "description": "库名匹配规则，请填写正则表达式", "example": "db_*" }, { "name": "TablePattern", "type": "string", "required": true, "description": "表名匹配规则，如果 DatabaseType 为 mongodb，则匹配集合名", "example": "tabl_*" }, { "name": "Columns", "type": "array", "required": false, "description": "列名。如果 RuleType 为 cols，此项必填。订阅任务会用该列的值计算分区。mongo没有按列分区，因此也不用传这个字段。", "example": "[\"id\"]", "item_type": "string" } ] }, { "name": "DefaultRuleType", "type": "string", "required": false, "description": "默认分区策略。不满足DistributeRules中正则表达式的数据，将按照默认分区策略计算分区。 非mongo产品支持的默认策略: table-按表名分区，pk-按表名+主键分区。mongo的默认策略仅支持：collection-按集合名分区。 该字段与DistributeRules搭配使用。如果配置了DistributeRules，该字段也必填。如果配置了该字段，视为配置了一条DistributeRules，原来的分区策略也会被覆盖。", "example": "table" }, { "name": "PipelineInfo", "type": "array", "required": false, "description": "mongo输出聚合设置，mongo任务可选。如果不填，默认不修改。", "example": "无", "item_type": "object", "children": [ { "name": "AggOp", "type": "string", "required": false, "description": "聚合运算符：$addFields、$match、$project、$replaceRoot、$redact、$replaceWith、$set、$unset。其中 $replaceWith、$set、$unset 只有当订阅实例是4.2及以上版本可选。", "example": "$addFields" }, { "name": "AggCmd", "type": "string", "required": false, "description": "聚合表达式。必须是json格式", "example": "{\"a\":\"\"}" } ] } ], "required": [ "SubscribeId", "SubscribeObjectType" ] }, { "name": "ModifySyncCompareTask", "description": "修改一致性校验任务，在任务创建后启动之前，可修改一致性校验参数", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "无" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9", "example": "无" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称", "example": "无" }, { "name": "ObjectMode", "type": "string", "required": false, "description": "数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)、custom(自定义)，注意自定义对比对象必须是迁移对象的子集", "example": "无" }, { "name": "Objects", "type": "object", "required": false, "description": "对比对象，若CompareObjectMode取值为custom，则此项必填", "example": "无", "children": [ { "name": "ObjectMode", "type": "string", "required": true, "description": "对象模式 整实例-all,部分对象-partial", "example": "all" }, { "name": "ObjectItems", "type": "array", "required": false, "description": "对象列表", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "DbMode", "type": "string", "required": true, "description": "数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象", "example": "all" }, { "name": "SchemaName", "type": "string", "required": false, "description": "schema名称", "example": "schema1" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象", "example": "all" }, { "name": "Tables", "type": "array", "required": false, "description": "用于一致性校验的表配置，当 TableMode 为 partial 时，需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名称", "example": "t1" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "column 模式，all 为全部，partial 表示部分(该参数仅对数据同步任务有效)", "example": "all" }, { "name": "Columns", "type": "array", "required": false, "description": "当 ColumnMode 为 partial 时必填(该参数仅对数据同步任务有效)", "example": "无", "item_type": "string" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "id\u003e10" }, { "name": "FilterTimeZone", "type": "string", "required": false, "description": "时区选择。如 \"+08:00\", \"-08:00\", \"+00:00\"（空值等价于\"+00:00\"）", "example": "+08:00" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象(一致性校验不校验视图，当前参数未启作用)", "example": "all" }, { "name": "Views", "type": "array", "required": false, "description": "用于一致性校验的视图配置，当 ViewMode 为 partial 时， 需要填写(一致性校验不校验视图，当前参数未启作用) 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "视图名", "example": "view1" } ] } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，目前只支持mongodb链路。如index(索引),shardkey(片键),schema(库表) 注意：此字段可能返回 null，表示取不到有效值。", "example": "index", "item_type": "string" } ] }, { "name": "Options", "type": "object", "required": false, "description": "一致性校验选项", "example": "无", "children": [ { "name": "Method", "type": "string", "required": false, "description": "对比方式：dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比), 默认为dataCheck", "example": "dataCheck" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "抽样比例;范围0,100。默认为100", "example": "100" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数，取值1-8，默认为1", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "对比类型：builtin（内置校验）、independent（独立校验）。默认为builtin，mongodb及redis链路不支持独立校验。", "example": "builtin" }, { "name": "CompareMode", "type": "array", "required": false, "description": "校验类型，枚举值：structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验，Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"full\",\"increment\"]", "item_type": "string" }, { "name": "ReCheckTime", "type": "integer", "required": false, "description": "复检次数", "example": "3" }, { "name": "ReCheckInterval", "type": "integer", "required": false, "description": "复检时间间隔，单位为分钟，取值 1-60", "example": "5" } ] } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "ModifySyncCompareTaskName", "description": "修改同步一致性校验任务名称", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-8yv4w2i1" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9", "example": "sync-8yv4w2i1-cmp-37skmii9" }, { "name": "TaskName", "type": "string", "required": true, "description": "一致性校验任务名称", "example": "cmp_test" } ], "required": [ "JobId", "CompareTaskId", "TaskName" ] }, { "name": "ModifySyncJobConfig", "description": "该接口支持在同步任务启动后修改任务的配置 修改同步配置的完整流程：修改同步任务配置-\u003e创建修改同步任务配置的校验任务-\u003e查询修改配置的校验任务的结果-\u003e启动修改配置任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-adasasww" }, { "name": "DynamicObjects", "type": "object", "required": false, "description": "修改后的同步对象", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "同步对象类型 Partial(部分对象)", "example": "Partial" }, { "name": "Databases", "type": "array", "required": false, "description": "同步对象，当 Mode 为 Partial 时，不为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": false, "description": "需要迁移或同步的库名，当ObjectMode为Partial时，此项必填", "example": "db1" }, { "name": "NewDbName", "type": "string", "required": false, "description": "迁移或同步后的库名，默认与源库相同", "example": "db1_new" }, { "name": "DbMode", "type": "string", "required": false, "description": "DB选择模式: All(为当前对象下的所有对象)，Partial(部分对象)，当Mode为Partial时，此项必填。注意，高级对象的同步不依赖此值，如果整库同步此处应该为All。", "example": "All" }, { "name": "SchemaName", "type": "string", "required": false, "description": "迁移或同步的 schema", "example": "sch1" }, { "name": "NewSchemaName", "type": "string", "required": false, "description": "迁移或同步后的 schema name", "example": "sch1_new" }, { "name": "TableMode", "type": "string", "required": false, "description": "表选择模式: All(为当前对象下的所有对象)，Partial(部分对象)，当DBMode为Partial时此项必填，如果整库同步此处应该为All。", "example": "All" }, { "name": "Tables", "type": "array", "required": false, "description": "表图对象集合，当 TableMode 为 Partial 时，此项需要填写", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": false, "description": "表名", "example": "t1" }, { "name": "NewTableName", "type": "string", "required": false, "description": "新表名", "example": "t1_new" }, { "name": "FilterCondition", "type": "string", "required": false, "description": "过滤条件", "example": "where id \u003e 100" }, { "name": "ColumnMode", "type": "string", "required": false, "description": "是否同步表中所有列，All：当前表下的所有列,Partial(ModifySyncJobConfig接口里的对应字段ColumnMode暂不支持Partial)：当前表下的部分列，通过填充Columns字段详细表信息", "example": "All" }, { "name": "Columns", "type": "array", "required": false, "description": "同步的列信息，当ColumnMode为Partial时，必填", "example": "无", "item_type": "string" }, { "name": "TmpTables", "type": "array", "required": false, "description": "同步临时表，注意此配置与NewTableName互斥，只能使用其中一种。当配置的同步对象为表级别且TableEditMode为pt时此项有意义，针对pt-osc等工具在同步过程中产生的临时表进行同步，需要提前将可能的临时表配置在这里，否则不会同步任何临时表。示例，如要对t1进行pt-osc操作，此项配置应该为[\"\\_t1\\_new\",\"\\_t1\\_old\"]；如要对t1进行gh-ost操作，此项配置应该为[\"\\_t1\\_ghc\",\"\\_t1\\_gho\",\"\\_t1\\_del\"...", "example": "[\"_t1_old\",_t1_new\"]", "item_type": "string" }, { "name": "TableEditMode", "type": "string", "required": false, "description": "编辑表类型，rename(表映射)，pt(同步附加表)", "example": "pt" } ] }, { "name": "ViewMode", "type": "string", "required": false, "description": "视图选择模式: All 为当前对象下的所有视图对象,Partial 为部分视图对象，如果整库同步此处应该为All。", "example": "All" }, { "name": "Views", "type": "array", "required": false, "description": "视图对象集合，当 ViewMode 为 Partial 时， 此项需要填写", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": false, "description": "view名", "example": "v1" }, { "name": "NewViewName", "type": "string", "required": false, "description": "预留字段、目前暂时不支持view的重命名", "example": "v1_new" } ] }, { "name": "FunctionMode", "type": "string", "required": false, "description": "选择要同步的模式，Partial为部分，All为整选，如果整库同步此处应该为All。", "example": "All" }, { "name": "Functions", "type": "array", "required": false, "description": "FunctionMode取值为Partial时需要填写", "example": "[\"func_1\"]", "item_type": "string" }, { "name": "ProcedureMode", "type": "string", "required": false, "description": "选择要同步的模式，Partial为部分，All为整选，如果整库同步此处应该为All。", "example": "All" }, { "name": "Procedures", "type": "array", "required": false, "description": "ProcedureMode取值为Partial时需要填写", "example": "[\"proc_1\"]", "item_type": "string" }, { "name": "TriggerMode", "type": "string", "required": false, "description": "触发器迁移模式，All(为当前对象下的所有对象)，Partial(部分对象)，如果整库同步此处应该为All。数据同步暂不支持此高级对象。", "example": "Partial" }, { "name": "Triggers", "type": "array", "required": false, "description": "当TriggerMode为partial，指定要迁移的触发器名称", "example": "[\"trigger_1\"]", "item_type": "string" }, { "name": "EventMode", "type": "string", "required": false, "description": "事件迁移模式，All(为当前对象下的所有对象)，Partial(部分对象)，如果整库同步此处应该为All。数据同步暂不支持此高级对象。", "example": "Partial" }, { "name": "Events", "type": "array", "required": false, "description": "当EventMode为partial，指定要迁移的事件名称", "example": "[\"event_1\"]", "item_type": "string" } ] }, { "name": "AdvancedObjects", "type": "array", "required": false, "description": "高级对象类型，如function、procedure。注意：如果要迁移同步高级对象，此配置中应该包含对应的高级对象类型。当需要同步高级对象时，初始化类型必须包含结构初始化类型，即任务的Options.InitType字段值为Structure或Full", "example": "[\"function\"]", "item_type": "string" }, { "name": "OnlineDDL", "type": "object", "required": false, "description": "OnlineDDL类型，冗余字段不做配置用途", "example": "无", "children": [ { "name": "Status", "type": "string", "required": true, "description": "状态，ON-启用，OFF-不启用。", "example": "ON" } ] }, { "name": "DatabasesOpFilter", "type": "array", "required": false, "description": "库/表/视图级 DML/DDL 白名单", "example": "无", "item_type": "object", "children": [ { "name": "DbName", "type": "string", "required": true, "description": "规则生效的库名", "example": "je***" }, { "name": "OpFilter", "type": "object", "required": false, "description": "库级 DDL/DML 过滤规则", "example": "无", "children": [ { "name": "OpTypes", "type": "array", "required": false, "description": "DML 白名单", "example": "[\"Insert\"]", "item_type": "string" }, { "name": "DdlOptions", "type": "array", "required": false, "description": "DDL 白名单", "example": "无", "item_type": "string" } ] }, { "name": "Tables", "type": "array", "required": false, "description": "表级 DDL/DML 过滤信息", "example": "无", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": true, "description": "规则生效的表名", "example": "order_details" }, { "name": "OpFilter", "type": "object", "required": false, "description": "表级 DDL/DML 过滤规则", "example": "无" } ] }, { "name": "Views", "type": "array", "required": false, "description": "视图级 DDL/DML 过滤信息", "example": "无", "item_type": "object", "children": [ { "name": "ViewName", "type": "string", "required": true, "description": "规则生效的视图名", "example": "order_full_details" }, { "name": "OpFilter", "type": "object", "required": false, "description": "视图级 DDL/DML 过滤规则", "example": "无" } ] } ] } ] }, { "name": "DynamicOptions", "type": "object", "required": false, "description": "修改后的同步任务选项", "example": "无", "children": [ { "name": "OpTypes", "type": "array", "required": true, "description": "所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)，PartialDDL(自定义,和DdlOptions一起起作用 )；必填、dts会用该值覆盖原有的值", "example": "[\"Insert\"]", "item_type": "string" }, { "name": "DdlOptions", "type": "array", "required": true, "description": "DDL同步选项，具体描述要同步哪些DDL; 当OpTypes取值PartialDDL时、字段不能为空；必填、dts会用该值覆盖原有的值", "example": "无", "item_type": "object", "children": [ { "name": "DdlObject", "type": "string", "required": false, "description": "ddl类型，如Database,Table,View,Index等", "example": "Database" }, { "name": "DdlValue", "type": "array", "required": false, "description": "ddl具体值，对于Database可取值[Create,Drop,Alter]对于Table可取值[Create,Drop,Alter,Truncate,Rename]对于View可取值[Create,Drop]对于Index可取值[Create,Drop] 注意：此字段可能返回 null，表示取不到有效值。", "example": "Alter", "item_type": "string" } ] }, { "name": "ConflictHandleType", "type": "string", "required": false, "description": "冲突处理选项，ReportError(报错)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖); 目前目标端为kafka的链路不支持修改该配置", "example": "ReportError" }, { "name": "ConflictHandleOption", "type": "object", "required": false, "description": "冲突处理的详细选项，如条件覆盖中的条件行和条件操作；不能部分更新该选项的内部字段；有更新时、需要全量更新该字段", "example": "无", "children": [ { "name": "ConditionColumn", "type": "string", "required": false, "description": "条件覆盖的列", "example": "c1" }, { "name": "ConditionOperator", "type": "string", "required": false, "description": "条件覆盖操作，目前仅支持\u003e", "example": "\u003e" }, { "name": "ConditionOrderInSrcAndDst", "type": "string", "required": false, "description": "条件覆盖优先级处理，支持类型有\u003e,\u003c,=", "example": "\u003e" } ] }, { "name": "KafkaOption", "type": "object", "required": false, "description": "同步到kafka链路的kafka配置", "example": "无", "children": [ { "name": "DataType", "type": "string", "required": false, "description": "投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json,debezium", "example": "Avro,Json" }, { "name": "TopicType", "type": "string", "required": false, "description": "同步topic策略，如Single（集中投递到单topic）,Multi (自定义topic名称)", "example": "Single（集中投递到单topic）,Multi (自定义topic名称)" }, { "name": "DDLTopicName", "type": "string", "required": false, "description": "用于存储ddl的topic", "example": "topic-ddl" }, { "name": "TopicRules", "type": "array", "required": false, "description": "单topic和自定义topic的描述", "example": "无", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": false, "description": "topic名。单topic时，所有的TopicName必须相同", "example": "topicName" }, { "name": "PartitionType", "type": "string", "required": false, "description": "topic分区策略，自定义topic时支持：Random（随机投递），集中投递到单Topic时支持：AllInPartitionZero（全部投递至partition0）、PartitionByTable(按表名分区)、PartitionByTableAndKey(按表名加主键分区)、PartitionByCols(按列分区)", "example": "Random（自定义topic时使用），AllInPartitionZero（全部投递至partition0）， PartitionByTable（按表名分区），PartitionByTableAndKey（按表名加主键分区）， PartitionByCols（按列名分区）" }, { "name": "DbMatchMode", "type": "string", "required": false, "description": "库名匹配规则，如Regular（正则匹配）, Default(不符合匹配规则的剩余库)，数组中最后一项必须为‘Default’", "example": "Regular（正则匹配）, Default(不符合匹配规则的剩余库)" }, { "name": "DbName", "type": "string", "required": false, "description": "库名，DbMatchMode=Regular时生效", "example": "db1" }, { "name": "TableMatchMode", "type": "string", "required": false, "description": "表名匹配规则，如Regular（正则匹配）, Default(不符合匹配规则的剩余表)，数组中最后一项必须为‘Default’", "example": "Regular（正则匹配）, Default(不符合匹配规则的剩余表)" }, { "name": "TableName", "type": "string", "required": false, "description": "表名，仅TableMatchMode=Regular时生效", "example": "tb1" }, { "name": "Columns", "type": "array", "required": false, "description": "按列分区时需要选择配置列名，可以选择多列 注意：此字段可能返回 null，表示取不到有效值。", "example": "c1", "item_type": "string" } ] }, { "name": "DataOption", "type": "array", "required": false, "description": "其他附加信息，对于特定数据类型可设置额外参数，比如针对Canal兼容的功能支持：\"canalOfficialFormat\":\"on\"表示打开Canal兼容功能，默认不带。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "选项key", "example": "AuthMechanism" }, { "name": "Value", "type": "string", "required": false, "description": "选项value", "example": "SCRAM-SHA-1" } ] } ] }, { "name": "FilterBeginCommit", "type": "boolean", "required": false, "description": "同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持", "example": "false" }, { "name": "FilterCheckpoint", "type": "boolean", "required": false, "description": "同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持", "example": "false" }, { "name": "DealOfExistSameTable", "type": "string", "required": false, "description": "同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)", "example": "ReportErrorAfterCheck" }, { "name": "StartPosition", "type": "string", "required": false, "description": "仅增量任务重新设置指定位点", "example": "2025-03-10 11:11:11" } ] } ], "required": [ "JobId" ] }, { "name": "ModifySyncRateLimit", "description": "用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-saasxa" }, { "name": "DumpThread", "type": "integer", "required": false, "description": "同步任务全量导出线程数、有效值为 1-16", "example": "8" }, { "name": "DumpRps", "type": "integer", "required": false, "description": "同步任务全量导出的 Rps 限制、需要大于 0;对于mongodb最大值为20000，其他数据库最大值为50000000", "example": "20000" }, { "name": "LoadThread", "type": "integer", "required": false, "description": "同步任务全量导入线程数、有效值为 1-16", "example": "8" }, { "name": "SinkerThread", "type": "integer", "required": false, "description": "同步任务增量导入线程数、有效值为 1-128", "example": "32" }, { "name": "LoadRps", "type": "integer", "required": false, "description": "同步任务全量导入的Rps", "example": "8" } ], "required": [ "JobId" ] }, { "name": "PauseMigrateJob", "description": "暂停一个迁移任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-xxxxxxxx" } ], "required": [ "JobId" ] }, { "name": "PauseSyncJob", "description": "暂停处于同步中的数据同步任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-xxxxxx" } ], "required": [ "JobId" ] }, { "name": "RecoverMigrateJob", "description": "解除隔离数据迁移任务，用户手动发起隔离后的手动解隔离，只有任务状态为已隔离(手动操作)状态下才能触发此操作。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-7o16y2qy" } ], "required": [ "JobId" ] }, { "name": "RecoverSyncJob", "description": "解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。注意，此接口只支持按量计费实例。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步实例id（即标识一个同步作业），形如sync-werwfs23，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" } ], "required": [ "JobId" ] }, { "name": "ResetConsumerGroupOffset", "description": "本接口(ResetConsumerGroupOffset)用于重置订阅消费组的offset。调用DescribeConsumerGroups接口查询消费组状态，只有消费组状态为 Dead 或 Empty 才可以执行重置该操作。否则重置不会生效，接口也不会报错。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "订阅实例id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "subs-7l2ly86kao" }, { "name": "TopicName", "type": "string", "required": true, "description": "订阅的kafka topic，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "topic-subs-7l2ly86kao-cdb-5jr9ms95" }, { "name": "ConsumerGroupName", "type": "string", "required": true, "description": "消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/api/571/102947)接口获取。", "example": "consumer-grp-subs-7l2ly86kao-group-1" }, { "name": "PartitionNos", "type": "array", "required": true, "description": "需要修改offset的分区编号，可通过[DescribeOffsetByTime](https://cloud.tencent.com/document/api/571/102946)接口获取。", "example": "[0,1,2,3]", "item_type": "integer" }, { "name": "ResetMode", "type": "string", "required": true, "description": "重置方式。枚举值为 earliest-从最开始位置开始消费；latest-从最新位置开始消费；datetime-从指定时间前最近的checkpoint开始消费", "example": "earliest" }, { "name": "ResetDatetime", "type": "string", "required": false, "description": "当 ResetMode 为 datetime 时，该项需要填，格式为：Y-m-d h:m:s。如果不填，默认用0时间，效果与earliest相同。", "example": "2022-04-01 11:00:00" } ], "required": [ "SubscribeId", "TopicName", "ConsumerGroupName", "PartitionNos", "ResetMode" ] }, { "name": "ResetSubscribe", "description": "本接口(ResetSubscribe)用于重置订阅实例，重置后，可以重新配置订阅任务。 可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时，表示重置成功。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" } ], "required": [ "SubscribeId" ] }, { "name": "ResetSyncJob", "description": "重置已经结束的同步任务，重置后可以重新配置启动任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "需要重置的同步任务ID。", "example": "sync-4ftuz3d2" } ], "required": [ "JobId" ] }, { "name": "ResizeSyncJob", "description": "调整同步任务规格，此接口只支持按量计费任务的调整，调用此接口后不会立即生效，后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs，获取变配后的状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" }, { "name": "NewInstanceClass", "type": "string", "required": true, "description": "任务规格，可选值包括micro,small,medium,large", "example": "small" } ], "required": [ "JobId", "NewInstanceClass" ] }, { "name": "ResumeMigrateJob", "description": "重试数据迁移任务，针对异常情况可进行重试，对于redis在失败时也可重试。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" }, { "name": "ResumeOption", "type": "string", "required": false, "description": "恢复任务的模式，目前的取值有：clearData 清空目标实例数据，overwrite 以覆盖写的方式执行任务，normal 跟正常流程一样，不做额外动作；注意，clearData、overwrite仅对redis生效，normal仅针对非redis链路生效", "example": "overwrite" } ], "required": [ "JobId" ] }, { "name": "ResumeSubscribe", "description": "本接口(ResumeSubscribe) 用于恢复报错的订阅任务。当订阅任务的状态为error时，可通过本接口尝试对任务进行恢复。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-9jyki7hniw" } ], "required": [ "SubscribeId" ] }, { "name": "ResumeSyncJob", "description": "重试同步任务，部分可恢复报错情况下，可通过该接口重试同步任务，可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-09vy1os1" } ], "required": [ "JobId" ] }, { "name": "SkipCheckItem", "description": "本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" }, { "name": "StepIds", "type": "array", "required": true, "description": "需要跳过校验项的步骤id，需要通过[DescribeMigrationCheckJob](https://cloud.tencent.com/document/product/571/82086)接口返回StepInfo[i].StepId字段获取，例如：[\"OptimizeCheck\"]", "example": "[\"OptimizeCheck\"]", "item_type": "string" }, { "name": "ForeignKeyFlag", "type": "string", "required": false, "description": "当出现外键依赖检查导致校验不通过时、可以通过该字段选择是否迁移外键依赖，当StepIds包含ConstraintCheck且该字段值为shield时表示不迁移外键依赖、当StepIds包含ConstraintCheck且值为migrate时表示迁移外键依赖", "example": "shield" } ], "required": [ "JobId", "StepIds" ] }, { "name": "SkipSyncCheckItem", "description": "本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务id，如：sync-4ddgid2，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-4ddgid2" }, { "name": "StepIds", "type": "array", "required": true, "description": "需要跳过校验项的步骤id，需要通过`DescribeCheckSyncJobResult`接口返回StepInfos[i].StepId字段获取，例如：[\"OptimizeCheck\"]", "example": "[\"OptimizeCheck\"]", "item_type": "string" } ], "required": [ "JobId", "StepIds" ] }, { "name": "StartCompare", "description": "启动一致性校验任务，启动之前需要先通过接口 [CreateCompareTask](https://cloud.tencent.com/document/product/571/82093) 创建一致性校验任务，启动后可通过接口 [DescribeCompareTasks](https://cloud.tencent.com/document/product/571/82088) 查询一致性校验任务列表来获得启动后的状态", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 ID，可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。", "example": "dts-8yv4w2i1" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。", "example": "dts-8yv4w2i1-cmp-37skmii9" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "StartMigrateJob", "description": "本接口（StartMigrateJob）用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" } ], "required": [ "JobId" ] }, { "name": "StartModifySyncJob", "description": "在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-csasssww" } ], "required": [ "JobId" ] }, { "name": "StartSubscribe", "description": "本接口(StartSubscribe)用于启动一个kafka版本的数据订阅实例。只有当订阅任务的状态为checkPass时，才能调用本接口。", "status": "online", "parameters": [ { "name": "SubscribeId", "type": "string", "required": true, "description": "数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。", "example": "subs-xxxxxx" } ], "required": [ "SubscribeId" ] }, { "name": "StartSyncCompare", "description": "启动一致性校验任务，启动之前需要先通过接口`CreateSyncCompareTask` 创建一致性校验任务，启动后可通过接口`DescribeSyncCompareTasks` 查询一致性校验任务列表来获得启动后的状态", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-8yv4w2i1" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9", "example": "sync-8yv4w2i1-cmp-37skmii9" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "StartSyncJob", "description": "启动同步任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": false, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-werwfs23" } ], "required": [] }, { "name": "StopCompare", "description": "终止一致性校验任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-amm1jw5q" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-8yv4w2i1-cmp-37skmii9" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否强制停止。默认值为false，表示不强制停止；如果填true，同步任务增量阶段会跳过一致性校验产生的binlog，达到快速恢复任务的效果", "example": "true" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "StopMigrateJob", "description": "本接口（StopMigrateJob）用于终止数据迁移任务。当任务状态为运行中、准备运行、准备完成、错误、暂停、未知等状态时可调用此接口终止任务。 调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。", "example": "dts-1kl0iy0v" } ], "required": [ "JobId" ] }, { "name": "StopSyncCompare", "description": "终止一致性校验任务", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "任务 Id", "example": "sync-amm1jw5q" }, { "name": "CompareTaskId", "type": "string", "required": true, "description": "对比任务 ID，形如：sync-8yv4w2i1-cmp-37skmii9", "example": "sync-8yv4w2i1-cmp-37skmii9" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否强制停止。如果填true，迁移任务增量阶段会跳过一致性校验产生的binlog，达到快速恢复任务的效果", "example": "true" } ], "required": [ "JobId", "CompareTaskId" ] }, { "name": "StopSyncJob", "description": "结束同步任务，操作后可通过查询同步任务信息接口DescribeSyncJobs，获取操作后的状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。", "example": "sync-n8deuq7e" } ], "required": [ "JobId" ] } ] }