tencentcloud-sdk-dts 3.0.1139 → 3.0.1149

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20180330/client.rb +1 -1
  4. data/lib/v20180330/models.rb +6 -6
  5. data/lib/v20211206/client.rb +6 -5
  6. data/lib/v20211206/models.rb +55 -54
  7. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1e08aafed3e855724d2b9a12b9485c95bd6812a8
4
- data.tar.gz: 60d3765ce2f2801ff2b3adc7287ad7243c2ce399
3
+ metadata.gz: 6d9346e3945d94b9fec8b73d172f38bc260b701d
4
+ data.tar.gz: 5ac4a9207e14ede87c2ea5c8cc5779d54004a267
5
5
  SHA512:
6
- metadata.gz: 4ae45c38f415aab050c4a58b3db8e01041f4806596dd7f1e99de5ea3b4fa28cb6777476762eec4f369461b1db587f967ffed62942f8316367902ce7342431bf1
7
- data.tar.gz: 2b79a60d4a994c5aff9df50c83586cbc8afed00d5ec6897a9d2f11b9b6315a6b9751437ac17cb03f834d37e7f6a072ed58332f263a706aa1b7a665e323398339
6
+ metadata.gz: 1caa70923643b412e0545594356d8f05edf538281652ebba4e4c961342aee39caef2a406555087dd078ecac6b17c36a45c06b252610b3bf09c02876a8f0b7c98
7
+ data.tar.gz: 843e29dfd72fa501cdd73208d236067a1695993f9e53ca2476fb6b45299fda441373c2e61d3ba7390ff8072b909a51b5ff83b845de6de195daac32647162839c
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1139
1
+ 3.0.1149
data/lib/v20180330/client.rb CHANGED
@@ -523,7 +523,7 @@ module TencentCloud
523
523
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
524
524
  end
525
525
 
526
- # 本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。
526
+ # 本接口（StartMigrateJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。
527
527
  # 调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
528
528
 
529
529
  # @param request: Request instance for StartMigrateJob.
data/lib/v20180330/models.rb CHANGED
@@ -78,7 +78,7 @@ module TencentCloud
78
78
 
79
79
  # CompleteMigrateJob请求参数结构体
80
80
  class CompleteMigrateJobRequest < TencentCloud::Common::AbstractModel
81
- # @param JobId: 数据迁移任务ID
81
+ # @param JobId: 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
82
82
  # @type JobId: String
83
83
  # @param CompleteMode: 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成，不会等待主从差距一致。默认为waitForSync
84
84
  # @type CompleteMode: String
@@ -831,10 +831,10 @@ module TencentCloud
831
831
 
832
832
  attr_accessor :Region, :InstanceId, :Ip, :Port, :ReadOnly, :User, :Password
833
833
  extend Gem::Deprecate
834
- deprecate :Ip, :none, 2025, 7
835
- deprecate :Ip=, :none, 2025, 7
836
- deprecate :Port, :none, 2025, 7
837
- deprecate :Port=, :none, 2025, 7
834
+ deprecate :Ip, :none, 2025, 9
835
+ deprecate :Ip=, :none, 2025, 9
836
+ deprecate :Port, :none, 2025, 9
837
+ deprecate :Port=, :none, 2025, 9
838
838
 
839
839
  def initialize(region=nil, instanceid=nil, ip=nil, port=nil, readonly=nil, user=nil, password=nil)
840
840
  @Region = region
@@ -1604,7 +1604,7 @@ module TencentCloud
1604
1604
 
1605
1605
  # StartMigrateJob请求参数结构体
1606
1606
  class StartMigrateJobRequest < TencentCloud::Common::AbstractModel
1607
- # @param JobId: 数据迁移任务ID
1607
+ # @param JobId: 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1608
1608
  # @type JobId: String
1609
1609
 
1610
1610
  attr_accessor :JobId
data/lib/v20211206/client.rb CHANGED
@@ -199,7 +199,8 @@ module TencentCloud
199
199
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
200
200
  end
201
201
 
202
- # 为订阅实例创建消费者组
202
+ # 为订阅实例创建消费者组。
203
+ # 只有状态为运行中的实例支持创建消费组。
203
204
 
204
205
  # @param request: Request instance for CreateConsumerGroup.
205
206
  # @type request: :class:`Tencentcloud::dts::V20211206::CreateConsumerGroupRequest`
@@ -223,7 +224,7 @@ module TencentCloud
223
224
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
224
225
  end
225
226
 
226
- # 校验迁移任务，
227
+ # 创建校验迁移任务，
227
228
  # 在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看，
228
229
  # 校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移
229
230
 
@@ -903,7 +904,7 @@ module TencentCloud
903
904
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
904
905
  end
905
906
 
906
- # 隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。
907
+ # 隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。
907
908
 
908
909
  # @param request: Request instance for IsolateSyncJob.
909
910
  # @type request: :class:`Tencentcloud::dts::V20211206::IsolateSyncJobRequest`
@@ -1336,7 +1337,7 @@ module TencentCloud
1336
1337
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1337
1338
  end
1338
1339
 
1339
- # 解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
1340
+ # 解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。注意，此接口只支持按量计费实例。
1340
1341
 
1341
1342
  # @param request: Request instance for RecoverSyncJob.
1342
1343
  # @type request: :class:`Tencentcloud::dts::V20211206::RecoverSyncJobRequest`
@@ -1385,7 +1386,7 @@ module TencentCloud
1385
1386
  end
1386
1387
 
1387
1388
  # 本接口(ResetSubscribe)用于重置订阅实例，重置后，可以重新配置订阅任务。
1388
- # 可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时，表示重置成功。
1389
+ # 可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时，表示重置成功。
1389
1390
 
1390
1391
  # @param request: Request instance for ResetSubscribe.
1391
1392
  # @type request: :class:`Tencentcloud::dts::V20211206::ResetSubscribeRequest`
data/lib/v20211206/models.rb CHANGED
@@ -682,11 +682,11 @@ module TencentCloud
682
682
 
683
683
  # ConfigureSyncJob请求参数结构体
684
684
  class ConfigureSyncJobRequest < TencentCloud::Common::AbstractModel
685
- # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23
685
+ # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
686
686
  # @type JobId: String
687
- # @param SrcAccessType: 源端接入类型，cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
687
+ # @param SrcAccessType: 源端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
688
688
  # @type SrcAccessType: String
689
- # @param DstAccessType: 目标端接入类型，cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
689
+ # @param DstAccessType: 目标端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
690
690
  # @type DstAccessType: String
691
691
  # @param Objects: 同步库表对象信息
692
692
  # @type Objects: :class:`Tencentcloud::Dts.v20211206.models.Objects`
@@ -702,13 +702,13 @@ module TencentCloud
702
702
  # @type SrcConnectType: String
703
703
  # @param SrcInfo: 源端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。
704
704
  # @type SrcInfo: :class:`Tencentcloud::Dts.v20211206.models.Endpoint`
705
- # @param SrcInfos: 源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
705
+ # @param SrcInfos: 源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。
706
706
  # @type SrcInfos: :class:`Tencentcloud::Dts.v20211206.models.SyncDBEndpointInfos`
707
707
  # @param SrcNodeType: 枚举值：cluster、single。源库为单节点数据库使用single，多节点使用cluster
708
708
  # @type SrcNodeType: String
709
709
  # @param DstInfo: 目标端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。
710
710
  # @type DstInfo: :class:`Tencentcloud::Dts.v20211206.models.Endpoint`
711
- # @param DstInfos: 目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
711
+ # @param DstInfos: 目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。
712
712
  # @type DstInfos: :class:`Tencentcloud::Dts.v20211206.models.SyncDBEndpointInfos`
713
713
  # @param DstNodeType: 枚举值：cluster、single。目标库为单节点数据库使用single，多节点使用cluster
714
714
  # @type DstNodeType: String
@@ -836,7 +836,7 @@ module TencentCloud
836
836
 
837
837
  # ContinueMigrateJob请求参数结构体
838
838
  class ContinueMigrateJobRequest < TencentCloud::Common::AbstractModel
839
- # @param JobId: 数据迁移任务ID
839
+ # @param JobId: 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
840
840
  # @type JobId: String
841
841
 
842
842
  attr_accessor :JobId
@@ -868,7 +868,7 @@ module TencentCloud
868
868
 
869
869
  # ContinueSyncJob请求参数结构体
870
870
  class ContinueSyncJobRequest < TencentCloud::Common::AbstractModel
871
- # @param JobId: 同步任务id
871
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
872
872
  # @type JobId: String
873
873
 
874
874
  attr_accessor :JobId
@@ -900,7 +900,7 @@ module TencentCloud
900
900
 
901
901
  # CreateCheckSyncJob请求参数结构体
902
902
  class CreateCheckSyncJobRequest < TencentCloud::Common::AbstractModel
903
- # @param JobId: 同步任务id
903
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
904
904
  # @type JobId: String
905
905
 
906
906
  attr_accessor :JobId
@@ -990,7 +990,7 @@ module TencentCloud
990
990
 
991
991
  # CreateConsumerGroup请求参数结构体
992
992
  class CreateConsumerGroupRequest < TencentCloud::Common::AbstractModel
993
- # @param SubscribeId: 订阅实例id
993
+ # @param SubscribeId: 订阅实例id，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
994
994
  # @type SubscribeId: String
995
995
  # @param ConsumerGroupName: 消费组名称，以数字、字母(大小写)或者_ - .开头，以数字、字母(大小写)结尾。实际生成的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
996
996
  # @type ConsumerGroupName: String
@@ -1038,7 +1038,7 @@ module TencentCloud
1038
1038
 
1039
1039
  # CreateMigrateCheckJob请求参数结构体
1040
1040
  class CreateMigrateCheckJobRequest < TencentCloud::Common::AbstractModel
1041
- # @param JobId: 数据迁移任务ID
1041
+ # @param JobId: 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1042
1042
  # @type JobId: String
1043
1043
 
1044
1044
  attr_accessor :JobId
@@ -1142,7 +1142,7 @@ module TencentCloud
1142
1142
 
1143
1143
  # CreateModifyCheckSyncJob请求参数结构体
1144
1144
  class CreateModifyCheckSyncJobRequest < TencentCloud::Common::AbstractModel
1145
- # @param JobId: 同步任务id
1145
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1146
1146
  # @type JobId: String
1147
1147
 
1148
1148
  attr_accessor :JobId
@@ -1174,7 +1174,7 @@ module TencentCloud
1174
1174
 
1175
1175
  # CreateSubscribeCheckJob请求参数结构体
1176
1176
  class CreateSubscribeCheckJobRequest < TencentCloud::Common::AbstractModel
1177
- # @param SubscribeId: 数据订阅实例的 ID
1177
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1178
1178
  # @type SubscribeId: String
1179
1179
 
1180
1180
  attr_accessor :SubscribeId
@@ -1840,13 +1840,13 @@ module TencentCloud
1840
1840
 
1841
1841
  # DeleteConsumerGroup请求参数结构体
1842
1842
  class DeleteConsumerGroupRequest < TencentCloud::Common::AbstractModel
1843
- # @param SubscribeId: 数据订阅实例的 ID
1843
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1844
1844
  # @type SubscribeId: String
1845
1845
  # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
1846
- # 请务必保证消费组名称正确。
1846
+ # 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
1847
1847
  # @type ConsumerGroupName: String
1848
1848
  # @param AccountName: 账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。
1849
- # 请务必保证账户名称正确。
1849
+ # 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
1850
1850
  # @type AccountName: String
1851
1851
 
1852
1852
  attr_accessor :SubscribeId, :ConsumerGroupName, :AccountName
@@ -1882,7 +1882,7 @@ module TencentCloud
1882
1882
 
1883
1883
  # DescribeCheckSyncJobResult请求参数结构体
1884
1884
  class DescribeCheckSyncJobResultRequest < TencentCloud::Common::AbstractModel
1885
- # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23，此值必填
1885
+ # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23，此值必填，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1886
1886
  # @type JobId: String
1887
1887
 
1888
1888
  attr_accessor :JobId
@@ -1942,9 +1942,9 @@ module TencentCloud
1942
1942
 
1943
1943
  # DescribeCompareReport请求参数结构体
1944
1944
  class DescribeCompareReportRequest < TencentCloud::Common::AbstractModel
1945
- # @param JobId: 迁移任务 Id
1945
+ # @param JobId: 迁移任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1946
1946
  # @type JobId: String
1947
- # @param CompareTaskId: 校验任务 Id
1947
+ # @param CompareTaskId: 校验任务 Id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1948
1948
  # @type CompareTaskId: String
1949
1949
  # @param DifferenceLimit: 校验不一致结果的 limit
1950
1950
  # @type DifferenceLimit: Integer
@@ -2087,7 +2087,7 @@ module TencentCloud
2087
2087
 
2088
2088
  # DescribeConsumerGroups请求参数结构体
2089
2089
  class DescribeConsumerGroupsRequest < TencentCloud::Common::AbstractModel
2090
- # @param SubscribeId: 订阅实例id
2090
+ # @param SubscribeId: 订阅实例id，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2091
2091
  # @type SubscribeId: String
2092
2092
  # @param Offset: 返回记录的起始偏移量。默认0
2093
2093
  # @type Offset: Integer
@@ -2225,7 +2225,7 @@ module TencentCloud
2225
2225
 
2226
2226
  # DescribeMigrationCheckJob请求参数结构体
2227
2227
  class DescribeMigrationCheckJobRequest < TencentCloud::Common::AbstractModel
2228
- # @param JobId: 任务id
2228
+ # @param JobId: 任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2229
2229
  # @type JobId: String
2230
2230
 
2231
2231
  attr_accessor :JobId
@@ -2557,7 +2557,7 @@ module TencentCloud
2557
2557
 
2558
2558
  # DescribeModifyCheckSyncJobResult请求参数结构体
2559
2559
  class DescribeModifyCheckSyncJobResultRequest < TencentCloud::Common::AbstractModel
2560
- # @param JobId: 同步任务id
2560
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2561
2561
  # @type JobId: String
2562
2562
 
2563
2563
  attr_accessor :JobId
@@ -2617,7 +2617,7 @@ module TencentCloud
2617
2617
 
2618
2618
  # DescribeOffsetByTime请求参数结构体
2619
2619
  class DescribeOffsetByTimeRequest < TencentCloud::Common::AbstractModel
2620
- # @param SubscribeId: 数据订阅实例的 ID
2620
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2621
2621
  # @type SubscribeId: String
2622
2622
  # @param Time: 时间点，格式为：Y-m-d h:m:s。如果输入时间比当前时间晚的多，相当于查询最新offset；如果输入时间比当前时间早的多，相当于查询最老offset；如果输入空，默认0时间，等价于查询最老offset。
2623
2623
  # @type Time: String
@@ -2731,7 +2731,7 @@ module TencentCloud
2731
2731
 
2732
2732
  # DescribeSubscribeDetail请求参数结构体
2733
2733
  class DescribeSubscribeDetailRequest < TencentCloud::Common::AbstractModel
2734
- # @param SubscribeId: 订阅实例ID
2734
+ # @param SubscribeId: 订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2735
2735
  # @type SubscribeId: String
2736
2736
 
2737
2737
  attr_accessor :SubscribeId
@@ -3041,7 +3041,7 @@ module TencentCloud
3041
3041
 
3042
3042
  # DescribeSubscribeReturnable请求参数结构体
3043
3043
  class DescribeSubscribeReturnableRequest < TencentCloud::Common::AbstractModel
3044
- # @param SubscribeId: 数据订阅实例的ID
3044
+ # @param SubscribeId: 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
3045
3045
  # @type SubscribeId: String
3046
3046
 
3047
3047
  attr_accessor :SubscribeId
@@ -3187,7 +3187,7 @@ module TencentCloud
3187
3187
 
3188
3188
  # DestroyIsolatedSubscribe请求参数结构体
3189
3189
  class DestroyIsolatedSubscribeRequest < TencentCloud::Common::AbstractModel
3190
- # @param SubscribeId: 数据订阅实例的ID
3190
+ # @param SubscribeId: 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
3191
3191
  # @type SubscribeId: String
3192
3192
 
3193
3193
  attr_accessor :SubscribeId
@@ -3219,7 +3219,7 @@ module TencentCloud
3219
3219
 
3220
3220
  # DestroyMigrateJob请求参数结构体
3221
3221
  class DestroyMigrateJobRequest < TencentCloud::Common::AbstractModel
3222
- # @param JobId: 任务id
3222
+ # @param JobId: 任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
3223
3223
  # @type JobId: String
3224
3224
 
3225
3225
  attr_accessor :JobId
@@ -3251,7 +3251,7 @@ module TencentCloud
3251
3251
 
3252
3252
  # DestroySyncJob请求参数结构体
3253
3253
  class DestroySyncJobRequest < TencentCloud::Common::AbstractModel
3254
- # @param JobId: 同步任务id
3254
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
3255
3255
  # @type JobId: String
3256
3256
 
3257
3257
  attr_accessor :JobId
@@ -4004,7 +4004,7 @@ module TencentCloud
4004
4004
 
4005
4005
  # IsolateSubscribe请求参数结构体
4006
4006
  class IsolateSubscribeRequest < TencentCloud::Common::AbstractModel
4007
- # @param SubscribeId: 订阅实例ID
4007
+ # @param SubscribeId: 订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4008
4008
  # @type SubscribeId: String
4009
4009
 
4010
4010
  attr_accessor :SubscribeId
@@ -4036,7 +4036,7 @@ module TencentCloud
4036
4036
 
4037
4037
  # IsolateSyncJob请求参数结构体
4038
4038
  class IsolateSyncJobRequest < TencentCloud::Common::AbstractModel
4039
- # @param JobId: 同步任务id
4039
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
4040
4040
  # @type JobId: String
4041
4041
 
4042
4042
  attr_accessor :JobId
@@ -4183,7 +4183,7 @@ module TencentCloud
4183
4183
 
4184
4184
  # 目标端为kafka时添加的同步选项字段
4185
4185
  class KafkaOption < TencentCloud::Common::AbstractModel
4186
- # @param DataType: 投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json
4186
+ # @param DataType: 投递到kafka的数据类型，如Avro,Json,canal-pb,canal-json,debezium
4187
4187
  # @type DataType: String
4188
4188
  # @param TopicType: 同步topic策略，如Single（集中投递到单topic）,Multi (自定义topic名称)
4189
4189
  # @type TopicType: String
@@ -4338,6 +4338,7 @@ module TencentCloud
4338
4338
  # @param MigrateType: 迁移类型，full(全量迁移)，structure(结构迁移)，fullAndIncrement(全量加增量迁移)， 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。
4339
4339
  # @type MigrateType: String
4340
4340
  # @param Consistency: 数据一致性校验选项， 默认为不开启一致性校验
4341
+ # 注意：此字段可能返回 null，表示取不到有效值。
4341
4342
  # @type Consistency: :class:`Tencentcloud::Dts.v20211206.models.ConsistencyOption`
4342
4343
  # @param IsMigrateAccount: 是否迁移账号，true(迁移账号)，false(不迁移账号)
4343
4344
  # @type IsMigrateAccount: Boolean
@@ -4346,7 +4347,7 @@ module TencentCloud
4346
4347
  # @param IsDstReadOnly: 是否在迁移时设置目标库只读(仅对mysql有效)，true(设置只读)、false(不设置只读，默认此值)
4347
4348
  # @type IsDstReadOnly: Boolean
4348
4349
  # @param ExtraAttr: 其他附加信息，对于特定库可设置额外参数，Redis可定义如下的参数:
4349
- # ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样，不做额外动作) "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120， 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
4350
+ # ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(要求目标端为空，否则校验不通过) ，不显示指定默认以覆盖写的方式执行任务 "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120， 复制超时时间(秒) "IsExpireKey":"true",过期key自动淘汰]
4350
4351
  # @type ExtraAttr: Array
4351
4352
  # @param MigrateWay: pgsql迁移分类：logical(逻辑迁移)、physical(物理迁移)
4352
4353
  # @type MigrateWay: String
@@ -4514,13 +4515,13 @@ module TencentCloud
4514
4515
 
4515
4516
  # ModifyConsumerGroupDescription请求参数结构体
4516
4517
  class ModifyConsumerGroupDescriptionRequest < TencentCloud::Common::AbstractModel
4517
- # @param SubscribeId: 数据订阅实例的 ID
4518
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4518
4519
  # @type SubscribeId: String
4519
4520
  # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
4520
- # 请务必保证消费组名称正确。
4521
+ # 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4521
4522
  # @type ConsumerGroupName: String
4522
4523
  # @param AccountName: 账户名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。
4523
- # 请务必保证账户名称正确。
4524
+ # 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4524
4525
  # @type AccountName: String
4525
4526
  # @param Description: 修改之后的消费组描述
4526
4527
  # @type Description: String
@@ -4560,11 +4561,11 @@ module TencentCloud
4560
4561
 
4561
4562
  # ModifyConsumerGroupPassword请求参数结构体
4562
4563
  class ModifyConsumerGroupPasswordRequest < TencentCloud::Common::AbstractModel
4563
- # @param SubscribeId: 数据订阅实例的 ID
4564
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4564
4565
  # @type SubscribeId: String
4565
- # @param AccountName: 账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}
4566
+ # @param AccountName: 账号名称。实际的账户全称形如：account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4566
4567
  # @type AccountName: String
4567
- # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
4568
+ # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4568
4569
  # @type ConsumerGroupName: String
4569
4570
  # @param NewPassword: 新密码。字符长度不小于3，不大于32
4570
4571
  # @type NewPassword: String
@@ -4851,7 +4852,7 @@ module TencentCloud
4851
4852
 
4852
4853
  # ModifySubscribeAutoRenewFlag请求参数结构体
4853
4854
  class ModifySubscribeAutoRenewFlagRequest < TencentCloud::Common::AbstractModel
4854
- # @param SubscribeId: 订阅实例ID
4855
+ # @param SubscribeId: 订阅实例ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4855
4856
  # @type SubscribeId: String
4856
4857
  # @param AutoRenewFlag: 自动续费标识。1-自动续费，0-不自动续费
4857
4858
  # @type AutoRenewFlag: Integer
@@ -4887,7 +4888,7 @@ module TencentCloud
4887
4888
 
4888
4889
  # ModifySubscribeName请求参数结构体
4889
4890
  class ModifySubscribeNameRequest < TencentCloud::Common::AbstractModel
4890
- # @param SubscribeId: 数据订阅实例的ID
4891
+ # @param SubscribeId: 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4891
4892
  # @type SubscribeId: String
4892
4893
  # @param SubscribeName: 修改后的数据订阅实例的名称，长度限制为[1,60]
4893
4894
  # @type SubscribeName: String
@@ -4923,11 +4924,11 @@ module TencentCloud
4923
4924
 
4924
4925
  # ModifySubscribeObjects请求参数结构体
4925
4926
  class ModifySubscribeObjectsRequest < TencentCloud::Common::AbstractModel
4926
- # @param SubscribeId: 数据订阅实例的ID
4927
+ # @param SubscribeId: 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4927
4928
  # @type SubscribeId: String
4928
4929
  # @param SubscribeObjectType: 数据订阅的类型，非mongo任务的枚举值：0-全实例更新；1-数据更新；2-结构更新；3-数据更新+结构更新。mongo任务的枚举值：0-全实例更新；4-订阅单库；5-订阅单集合
4929
4930
  # @type SubscribeObjectType: Integer
4930
- # @param Objects: 修改后的订阅数据库表信息。会覆盖原来的订阅对象，所以除非 SubscribeObjectType = 0或2，否则改字段必填。
4931
+ # @param Objects: 修改后的订阅数据库表信息。会覆盖原来的订阅对象，所以除非 SubscribeObjectType = 0或2，否则该字段必填。
4931
4932
  # @type Objects: Array
4932
4933
  # @param DistributeRules: kafka分区策略。如果不填，默认不修改。如果填了，会覆盖原来的策略。
4933
4934
  # @type DistributeRules: Array
@@ -5199,7 +5200,7 @@ module TencentCloud
5199
5200
 
5200
5201
  # 数据同步中的选项
5201
5202
  class Options < TencentCloud::Common::AbstractModel
5202
- # @param InitType: 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)
5203
+ # @param InitType: 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
5203
5204
  # @type InitType: String
5204
5205
  # @param DealOfExistSameTable: 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
5205
5206
  # @type DealOfExistSameTable: String
@@ -5302,7 +5303,7 @@ module TencentCloud
5302
5303
 
5303
5304
  # PauseMigrateJob请求参数结构体
5304
5305
  class PauseMigrateJobRequest < TencentCloud::Common::AbstractModel
5305
- # @param JobId: 数据迁移任务ID
5306
+ # @param JobId: 数据迁移任务ID，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5306
5307
  # @type JobId: String
5307
5308
 
5308
5309
  attr_accessor :JobId
@@ -5334,7 +5335,7 @@ module TencentCloud
5334
5335
 
5335
5336
  # PauseSyncJob请求参数结构体
5336
5337
  class PauseSyncJobRequest < TencentCloud::Common::AbstractModel
5337
- # @param JobId: 同步任务id
5338
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5338
5339
  # @type JobId: String
5339
5340
 
5340
5341
  attr_accessor :JobId
@@ -5509,7 +5510,7 @@ module TencentCloud
5509
5510
 
5510
5511
  # RecoverMigrateJob请求参数结构体
5511
5512
  class RecoverMigrateJobRequest < TencentCloud::Common::AbstractModel
5512
- # @param JobId: 任务id
5513
+ # @param JobId: 任务id，可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5513
5514
  # @type JobId: String
5514
5515
 
5515
5516
  attr_accessor :JobId
@@ -5541,7 +5542,7 @@ module TencentCloud
5541
5542
 
5542
5543
  # RecoverSyncJob请求参数结构体
5543
5544
  class RecoverSyncJobRequest < TencentCloud::Common::AbstractModel
5544
- # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23
5545
+ # @param JobId: 同步实例id（即标识一个同步作业），形如sync-werwfs23，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5545
5546
  # @type JobId: String
5546
5547
 
5547
5548
  attr_accessor :JobId
@@ -5625,7 +5626,7 @@ module TencentCloud
5625
5626
 
5626
5627
  # ResetSubscribe请求参数结构体
5627
5628
  class ResetSubscribeRequest < TencentCloud::Common::AbstractModel
5628
- # @param SubscribeId: 数据订阅实例的ID
5629
+ # @param SubscribeId: 数据订阅实例的ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
5629
5630
  # @type SubscribeId: String
5630
5631
 
5631
5632
  attr_accessor :SubscribeId
@@ -5761,7 +5762,7 @@ module TencentCloud
5761
5762
 
5762
5763
  # ResumeSubscribe请求参数结构体
5763
5764
  class ResumeSubscribeRequest < TencentCloud::Common::AbstractModel
5764
- # @param SubscribeId: 数据订阅实例的 ID
5765
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
5765
5766
  # @type SubscribeId: String
5766
5767
 
5767
5768
  attr_accessor :SubscribeId
@@ -5793,7 +5794,7 @@ module TencentCloud
5793
5794
 
5794
5795
  # ResumeSyncJob请求参数结构体
5795
5796
  class ResumeSyncJobRequest < TencentCloud::Common::AbstractModel
5796
- # @param JobId: 同步任务id
5797
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5797
5798
  # @type JobId: String
5798
5799
 
5799
5800
  attr_accessor :JobId
@@ -6076,7 +6077,7 @@ module TencentCloud
6076
6077
 
6077
6078
  # StartModifySyncJob请求参数结构体
6078
6079
  class StartModifySyncJobRequest < TencentCloud::Common::AbstractModel
6079
- # @param JobId: 同步任务id
6080
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
6080
6081
  # @type JobId: String
6081
6082
 
6082
6083
  attr_accessor :JobId
@@ -6108,7 +6109,7 @@ module TencentCloud
6108
6109
 
6109
6110
  # StartSubscribe请求参数结构体
6110
6111
  class StartSubscribeRequest < TencentCloud::Common::AbstractModel
6111
- # @param SubscribeId: 数据订阅实例的 ID
6112
+ # @param SubscribeId: 数据订阅实例的 ID，可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
6112
6113
  # @type SubscribeId: String
6113
6114
 
6114
6115
  attr_accessor :SubscribeId
@@ -6398,7 +6399,7 @@ module TencentCloud
6398
6399
 
6399
6400
  # StopSyncJob请求参数结构体
6400
6401
  class StopSyncJobRequest < TencentCloud::Common::AbstractModel
6401
- # @param JobId: 同步任务id
6402
+ # @param JobId: 同步任务id，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
6402
6403
  # @type JobId: String
6403
6404
 
6404
6405
  attr_accessor :JobId
@@ -6841,7 +6842,7 @@ module TencentCloud
6841
6842
  # @type SrcInfo: :class:`Tencentcloud::Dts.v20211206.models.Endpoint`
6842
6843
  # @param SrcNodeType: 枚举值：cluster、single。源库为单节点数据库使用single，多节点使用cluster
6843
6844
  # @type SrcNodeType: String
6844
- # @param SrcInfos: 源端信息，多节点数据库使用
6845
+ # @param SrcInfos: 源端信息，若SrcNodeType=cluster，则源端信息在这个字段里，mongodb链路使用此参数透传。
6845
6846
  # @type SrcInfos: :class:`Tencentcloud::Dts.v20211206.models.SyncDBEndpointInfos`
6846
6847
  # @param DstRegion: 目标端地域，如：ap-guangzhou等
6847
6848
  # @type DstRegion: String
@@ -6853,7 +6854,7 @@ module TencentCloud
6853
6854
  # @type DstInfo: :class:`Tencentcloud::Dts.v20211206.models.Endpoint`
6854
6855
  # @param DstNodeType: 枚举值：cluster、single。目标库为单节点数据库使用single，多节点使用cluster
6855
6856
  # @type DstNodeType: String
6856
- # @param DstInfos: 目标端信息，多节点数据库使用
6857
+ # @param DstInfos: 目标端信息，若SrcNodeType=cluster，则源端信息在这个字段里，mongodb链路使用此参数透传。
6857
6858
  # @type DstInfos: :class:`Tencentcloud::Dts.v20211206.models.SyncDBEndpointInfos`
6858
6859
  # @param CreateTime: 创建时间，格式为 yyyy-mm-dd hh:mm:ss
6859
6860
  # @type CreateTime: String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-dts
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1139
4
+ version: 3.0.1149
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-09-10 00:00:00.000000000 Z
11
+ date: 2025-09-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,11 +33,11 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20211206/models.rb
37
- - lib/v20211206/client.rb
38
36
  - lib/tencentcloud-sdk-dts.rb
39
- - lib/v20180330/models.rb
40
37
  - lib/v20180330/client.rb
38
+ - lib/v20180330/models.rb
39
+ - lib/v20211206/client.rb
40
+ - lib/v20211206/models.rb
41
41
  - lib/VERSION
42
42
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
43
43
  licenses: