tencentcloud-sdk-dts 3.0.1156 → 3.0.1158

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 24486ffd4f365e7fd4b60d25eeef2db4d56b60f4
4
- data.tar.gz: 5e0ecc440183518c7a63499143ea00a97591d956
3
+ metadata.gz: 47f508df346abf8944860cab745a05903e527569
4
+ data.tar.gz: 6ca23109805680039582c1c02e6d0859521116dc
5
5
  SHA512:
6
- metadata.gz: e7d77561f40e808ec9d6723703d85f68cda1498b5e6d821820d1af7e7715f21a7677698fb2fe884bdbdb5ede71ff249102a1d4d5392552a4c1a68556445c9402
7
- data.tar.gz: 10d5460de2c64dcd97757498a0904a2c0c22cd544af86af8ef35dbdae1fa73d23d073bf1b235e1aad37566bdb6b29ee90c9338157847ac75b96d68a88a12fde7
6
+ metadata.gz: c06888ce9f0abf96f8d703e987364db07779da8287bf4cb71665bb151ecc0728edd02c96124b241e7666314e1bb2ced82e3ed3809598685571505dcc5e59cff4
7
+ data.tar.gz: dc22ee293a0a9ce5aa0d514b30e2472f352e8aeb21afb6336ceac7cce006c2d36a17e3f93c45ece7991ff418037fb427cda7df28efa7bca8593d220daa2bcdf5
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1156
1
+ 3.0.1158
@@ -466,7 +466,7 @@ module TencentCloud
466
466
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
467
467
  end
468
468
 
469
- # 查询一致性校验任务列表,调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。
469
+ # 查询一致性校验任务列表。
470
470
 
471
471
  # @param request: Request instance for DescribeCompareTasks.
472
472
  # @type request: :class:`Tencentcloud::dts::V20211206::DescribeCompareTasksRequest`
@@ -856,7 +856,7 @@ module TencentCloud
856
856
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
857
857
  end
858
858
 
859
- # 隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。
859
+ # 隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrateJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。
860
860
 
861
861
  # @param request: Request instance for IsolateMigrateJob.
862
862
  # @type request: :class:`Tencentcloud::dts::V20211206::IsolateMigrateJobRequest`
@@ -1024,7 +1024,7 @@ module TencentCloud
1024
1024
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1025
1025
  end
1026
1026
 
1027
- # 调整实例规格,此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1027
+ # 调整实例规格,此接口只支持按量计费任务的调整,且仅在计费或者待计费状态下支持修改。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1028
1028
 
1029
1029
  # @param request: Request instance for ModifyMigrateJobSpec.
1030
1030
  # @type request: :class:`Tencentcloud::dts::V20211206::ModifyMigrateJobSpecRequest`
@@ -1072,7 +1072,7 @@ module TencentCloud
1072
1072
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1073
1073
  end
1074
1074
 
1075
- # 用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
1075
+ # 用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率;此操作仅在任务运行中可执行。
1076
1076
 
1077
1077
  # @param request: Request instance for ModifyMigrateRateLimit.
1078
1078
  # @type request: :class:`Tencentcloud::dts::V20211206::ModifyMigrateRateLimitRequest`
@@ -1120,7 +1120,7 @@ module TencentCloud
1120
1120
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1121
1121
  end
1122
1122
 
1123
- # 配置迁移服务,配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。
1123
+ # 配置迁移服务,配置成功后可通过`CreateMigrateCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。
1124
1124
 
1125
1125
  # @param request: Request instance for ModifyMigrationJob.
1126
1126
  # @type request: :class:`Tencentcloud::dts::V20211206::ModifyMigrationJobRequest`
@@ -1458,7 +1458,7 @@ module TencentCloud
1458
1458
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1459
1459
  end
1460
1460
 
1461
- # 重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。注意:此操作跳过校验阶段,直接重新发起任务,相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1461
+ # 重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。
1462
1462
 
1463
1463
  # @param request: Request instance for ResumeMigrateJob.
1464
1464
  # @type request: :class:`Tencentcloud::dts::V20211206::ResumeMigrateJobRequest`
@@ -1602,7 +1602,7 @@ module TencentCloud
1602
1602
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1603
1603
  end
1604
1604
 
1605
- # 本接口(StartMigrationJob)用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1605
+ # 本接口(StartMigrateJob)用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1606
1606
 
1607
1607
  # @param request: Request instance for StartMigrateJob.
1608
1608
  # @type request: :class:`Tencentcloud::dts::V20211206::StartMigrateJobRequest`
@@ -1722,7 +1722,7 @@ module TencentCloud
1722
1722
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1723
1723
  end
1724
1724
 
1725
- # 本接口(StopMigrateJob)用于终止数据迁移任务。
1725
+ # 本接口(StopMigrateJob)用于终止数据迁移任务。当任务状态为运行中、准备运行、准备完成、错误、暂停、未知等状态时可调用此接口终止任务。
1726
1726
  # 调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
1727
1727
 
1728
1728
  # @param request: Request instance for StopMigrateJob.
@@ -375,19 +375,35 @@ module TencentCloud
375
375
  # @type SampleRate: Integer
376
376
  # @param ThreadCount: 线程数,取值1-8,默认为1
377
377
  # @type ThreadCount: Integer
378
-
379
- attr_accessor :Method, :SampleRate, :ThreadCount
380
-
381
- def initialize(method=nil, samplerate=nil, threadcount=nil)
378
+ # @param Type: 对比类型:builtin(内置校验)、independent(独立校验)。默认为builtin,mongodb及redis链路不支持独立校验。
379
+ # @type Type: String
380
+ # @param CompareMode: 校验类型,枚举值:structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验,Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持)
381
+ # @type CompareMode: Array
382
+ # @param ReCheckTime: 复检次数
383
+ # @type ReCheckTime: Integer
384
+ # @param ReCheckInterval: 复检时间间隔,单位为分钟,取值 1-60
385
+ # @type ReCheckInterval: Integer
386
+
387
+ attr_accessor :Method, :SampleRate, :ThreadCount, :Type, :CompareMode, :ReCheckTime, :ReCheckInterval
388
+
389
+ def initialize(method=nil, samplerate=nil, threadcount=nil, type=nil, comparemode=nil, rechecktime=nil, recheckinterval=nil)
382
390
  @Method = method
383
391
  @SampleRate = samplerate
384
392
  @ThreadCount = threadcount
393
+ @Type = type
394
+ @CompareMode = comparemode
395
+ @ReCheckTime = rechecktime
396
+ @ReCheckInterval = recheckinterval
385
397
  end
386
398
 
387
399
  def deserialize(params)
388
400
  @Method = params['Method']
389
401
  @SampleRate = params['SampleRate']
390
402
  @ThreadCount = params['ThreadCount']
403
+ @Type = params['Type']
404
+ @CompareMode = params['CompareMode']
405
+ @ReCheckTime = params['ReCheckTime']
406
+ @ReCheckInterval = params['ReCheckInterval']
391
407
  end
392
408
  end
393
409
 
@@ -540,7 +556,7 @@ module TencentCloud
540
556
 
541
557
  # CompleteMigrateJob请求参数结构体
542
558
  class CompleteMigrateJobRequest < TencentCloud::Common::AbstractModel
543
- # @param JobId: 数据迁移任务ID
559
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
544
560
  # @type JobId: String
545
561
  # @param CompleteMode: 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
546
562
  # @type CompleteMode: String
@@ -576,7 +592,7 @@ module TencentCloud
576
592
 
577
593
  # ConfigureSubscribeJob请求参数结构体
578
594
  class ConfigureSubscribeJobRequest < TencentCloud::Common::AbstractModel
579
- # @param SubscribeId: 数据订阅实例的 ID
595
+ # @param SubscribeId: 数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
580
596
  # @type SubscribeId: String
581
597
  # @param SubscribeMode: 数据订阅的类型,当 DatabaseType 不为 mongodb 时,枚举值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时,枚举值为 all-全实例更新;database-订阅单库;collection-订阅单集合
582
598
  # @type SubscribeMode: String
@@ -798,9 +814,9 @@ module TencentCloud
798
814
  class ConflictHandleOption < TencentCloud::Common::AbstractModel
799
815
  # @param ConditionColumn: 条件覆盖的列
800
816
  # @type ConditionColumn: String
801
- # @param ConditionOperator: 条件覆盖操作
817
+ # @param ConditionOperator: 条件覆盖操作,目前仅支持>
802
818
  # @type ConditionOperator: String
803
- # @param ConditionOrderInSrcAndDst: 条件覆盖优先级处理
819
+ # @param ConditionOrderInSrcAndDst: 条件覆盖优先级处理,支持类型有>,<,=
804
820
  # @type ConditionOrderInSrcAndDst: String
805
821
 
806
822
  attr_accessor :ConditionColumn, :ConditionOperator, :ConditionOrderInSrcAndDst
@@ -822,15 +838,34 @@ module TencentCloud
822
838
  class ConsistencyOption < TencentCloud::Common::AbstractModel
823
839
  # @param Mode: 一致性检测类型: full(全量检测迁移对象)、noCheck(不检测)、notConfigured(未配置)
824
840
  # @type Mode: String
841
+ # @param ObjectMode: 校验对象选择。枚举值:sameAsMigrate-与迁移同步任务相同、custom-用户自定义,搭配Objects操作
842
+ # @type ObjectMode: String
843
+ # @param Objects: 校验对象
844
+ # 注意:此字段可能返回 null,表示取不到有效值。
845
+ # @type Objects: :class:`Tencentcloud::Dts.v20211206.models.DatabaseTableObject`
846
+ # @param Options: 校验配置
847
+ # @type Options: :class:`Tencentcloud::Dts.v20211206.models.CompareOptions`
825
848
 
826
- attr_accessor :Mode
849
+ attr_accessor :Mode, :ObjectMode, :Objects, :Options
827
850
 
828
- def initialize(mode=nil)
851
+ def initialize(mode=nil, objectmode=nil, objects=nil, options=nil)
829
852
  @Mode = mode
853
+ @ObjectMode = objectmode
854
+ @Objects = objects
855
+ @Options = options
830
856
  end
831
857
 
832
858
  def deserialize(params)
833
859
  @Mode = params['Mode']
860
+ @ObjectMode = params['ObjectMode']
861
+ unless params['Objects'].nil?
862
+ @Objects = DatabaseTableObject.new
863
+ @Objects.deserialize(params['Objects'])
864
+ end
865
+ unless params['Options'].nil?
866
+ @Options = CompareOptions.new
867
+ @Options.deserialize(params['Options'])
868
+ end
834
869
  end
835
870
  end
836
871
 
@@ -932,7 +967,7 @@ module TencentCloud
932
967
 
933
968
  # CreateCompareTask请求参数结构体
934
969
  class CreateCompareTaskRequest < TencentCloud::Common::AbstractModel
935
- # @param JobId: 任务 Id
970
+ # @param JobId: 任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
936
971
  # @type JobId: String
937
972
  # @param TaskName: 数据对比任务名称,若为空则默认给CompareTaskId相同值
938
973
  # @type TaskName: String
@@ -1287,7 +1322,7 @@ module TencentCloud
1287
1322
  # @type DstDatabaseType: String
1288
1323
  # @param DstRegion: 目标端数据库所在地域,如ap-guangzhou
1289
1324
  # @type DstRegion: String
1290
- # @param Specification: 同步任务规格,Standard:标准版
1325
+ # @param Specification: 同步任务规格,Standard:标准版,目前仅支持Standard规格。
1291
1326
  # @type Specification: String
1292
1327
  # @param TimeSpan: 购买时长(单位:月),当PayMode值为PrePay则此项配置有意义,默认为1月,取值范围为[1,100]
1293
1328
  # @type TimeSpan: Integer
@@ -1755,7 +1790,9 @@ module TencentCloud
1755
1790
  # @type ObjectMode: String
1756
1791
  # @param Databases: 迁移对象,当 ObjectMode 为 partial 时,不为空
1757
1792
  # @type Databases: Array
1758
- # @param AdvancedObjects: 高级对象类型,如trigger、function、procedure、event。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型
1793
+ # @param AdvancedObjects: 高级对象类型,如trigger(触发器)、function(函数)、procedure(存储过程)、event(事件)。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型。
1794
+
1795
+ # > 当前支持高级对象迁移的场景为MySQL、TDSQL-CMySQL、MariaDB、Percona之间的数据迁移。
1759
1796
  # 注意:此字段可能返回 null,表示取不到有效值。
1760
1797
  # @type AdvancedObjects: Array
1761
1798
 
@@ -1804,9 +1841,9 @@ module TencentCloud
1804
1841
 
1805
1842
  # DeleteCompareTask请求参数结构体
1806
1843
  class DeleteCompareTaskRequest < TencentCloud::Common::AbstractModel
1807
- # @param JobId: 迁移任务 Id
1844
+ # @param JobId: 迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1808
1845
  # @type JobId: String
1809
- # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1846
+ # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9。可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1810
1847
  # @type CompareTaskId: String
1811
1848
 
1812
1849
  attr_accessor :JobId, :CompareTaskId
@@ -2024,7 +2061,7 @@ module TencentCloud
2024
2061
 
2025
2062
  # DescribeCompareTasks请求参数结构体
2026
2063
  class DescribeCompareTasksRequest < TencentCloud::Common::AbstractModel
2027
- # @param JobId: 迁移任务 Id
2064
+ # @param JobId: 迁移任务 Id,可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。
2028
2065
  # @type JobId: String
2029
2066
  # @param Limit: 分页设置,表示每页显示多少条任务,默认为 20
2030
2067
  # @type Limit: Integer
@@ -2142,13 +2179,13 @@ module TencentCloud
2142
2179
 
2143
2180
  # DescribeMigrateDBInstances请求参数结构体
2144
2181
  class DescribeMigrateDBInstancesRequest < TencentCloud::Common::AbstractModel
2145
- # @param DatabaseType: 数据库类型,如mysql,redis
2182
+ # @param DatabaseType: 数据库类型,如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。
2146
2183
  # @type DatabaseType: String
2147
2184
  # @param MigrateRole: 实例作为迁移的源还是目标,src(表示源),dst(表示目标)
2148
2185
  # @type MigrateRole: String
2149
- # @param InstanceId: 云数据库实例ID
2186
+ # @param InstanceId: 云数据库实例ID,可通过对应业务实例列表获取实例信息。
2150
2187
  # @type InstanceId: String
2151
- # @param InstanceName: 云数据库名称
2188
+ # @param InstanceName: 云数据库名称,可通过对应业务实例列表获取实例信息。
2152
2189
  # @type InstanceName: String
2153
2190
  # @param Limit: 返回数量限制
2154
2191
  # @type Limit: Integer
@@ -2280,7 +2317,7 @@ module TencentCloud
2280
2317
 
2281
2318
  # DescribeMigrationDetail请求参数结构体
2282
2319
  class DescribeMigrationDetailRequest < TencentCloud::Common::AbstractModel
2283
- # @param JobId: 数据迁移任务ID
2320
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2284
2321
  # @type JobId: String
2285
2322
 
2286
2323
  attr_accessor :JobId
@@ -2664,7 +2701,7 @@ module TencentCloud
2664
2701
 
2665
2702
  # DescribeSubscribeCheckJob请求参数结构体
2666
2703
  class DescribeSubscribeCheckJobRequest < TencentCloud::Common::AbstractModel
2667
- # @param SubscribeId: 数据订阅实例的 ID
2704
+ # @param SubscribeId: 数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2668
2705
  # @type SubscribeId: String
2669
2706
 
2670
2707
  attr_accessor :SubscribeId
@@ -2684,7 +2721,7 @@ module TencentCloud
2684
2721
  # @type SubscribeId: String
2685
2722
  # @param Message: 失败或者报错提示,成功则提示success。
2686
2723
  # @type Message: String
2687
- # @param Status: 任务运行状态,可能值为 running,failed,success
2724
+ # @param Status: 任务运行状态,可能值为 running(运行中),failed(失败),success(成功),unknown(未知状态)。
2688
2725
  # @type Status: String
2689
2726
  # @param Progress: 当前总体进度,范围 0~100
2690
2727
  # @type Progress: Integer
@@ -3081,13 +3118,13 @@ module TencentCloud
3081
3118
 
3082
3119
  # DescribeSyncJobs请求参数结构体
3083
3120
  class DescribeSyncJobsRequest < TencentCloud::Common::AbstractModel
3084
- # @param JobId: 同步任务id,如sync-werwfs23
3121
+ # @param JobId: 同步任务id,如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
3085
3122
  # @type JobId: String
3086
- # @param JobIds: 同步任务id列表,如sync-werwfs23
3123
+ # @param JobIds: 同步任务id列表,如["sync-n3gh7md9"]
3087
3124
  # @type JobIds: Array
3088
3125
  # @param JobName: 同步任务名
3089
3126
  # @type JobName: String
3090
- # @param Order: 排序字段,可以取值为CreateTime
3127
+ # @param Order: 排序字段,目前仅支持CreateTime字段排序
3091
3128
  # @type Order: String
3092
3129
  # @param OrderSeq: 排序方式,升序为ASC,降序为DESC,默认为CreateTime降序
3093
3130
  # @type OrderSeq: String
@@ -3095,11 +3132,11 @@ module TencentCloud
3095
3132
  # @type Offset: Integer
3096
3133
  # @param Limit: 返回同步任务实例数量,默认20,有效区间[1,100]
3097
3134
  # @type Limit: Integer
3098
- # @param Status: 状态集合,如Initialized,CheckPass,Running,ResumableErr,Stopped
3135
+ # @param Status: 状态集合,如Initialized(初始化),CheckPass(校验通过),Running(运行中),ResumableErr(恢复中),Stopped(已结束)
3099
3136
  # @type Status: Array
3100
3137
  # @param RunMode: 运行模式,如Immediate:立即运行,Timed:定时运行
3101
3138
  # @type RunMode: String
3102
- # @param JobType: 任务类型,如mysql2mysql:msyql同步到mysql
3139
+ # @param JobType: 任务类型,如mysql2mysql:msyql同步到mysql;可取值有mysql2mysql、mysql2kafka、tdsqlmysql2kafka、tdsqlmysql2tdsqlmysql、tdsqlmysql2mysql、mysql2tdsqlmysql、mysql2mariadb、mariadb2mariadb、mariadb2kafka、cynosdbmysql2kafka、cynosdbmysql2cynosdbmysql、cynosdbmysql2mysql、mysql2cynosdbmysql、mariadb2tdsqlmysql、tdsqlmysql2cynosdbmysql、cynosdbmysql2tdsqlmysql、tdstore2mysql、tdstore2percona、tdstore2mariadb、tdstore2cynosdbmysql、cynosdbmysql2mariadb、mariadb2cynosdbmysql、tdsqlmysql2mariadb、mariadb2mysql、percona2mariadb、postgresql2postgresql、tdstore2tdsqlmysql、mongodb2mongodb
3103
3140
  # @type JobType: String
3104
3141
  # @param PayMode: 付费类型,PrePay:预付费,PostPay:后付费
3105
3142
  # @type PayMode: String
@@ -3976,7 +4013,7 @@ module TencentCloud
3976
4013
 
3977
4014
  # IsolateMigrateJob请求参数结构体
3978
4015
  class IsolateMigrateJobRequest < TencentCloud::Common::AbstractModel
3979
- # @param JobId: 任务id
4016
+ # @param JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
3980
4017
  # @type JobId: String
3981
4018
 
3982
4019
  attr_accessor :JobId
@@ -4421,9 +4458,9 @@ module TencentCloud
4421
4458
 
4422
4459
  # ModifyCompareTaskName请求参数结构体
4423
4460
  class ModifyCompareTaskNameRequest < TencentCloud::Common::AbstractModel
4424
- # @param JobId: 迁移任务 Id
4461
+ # @param JobId: 迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4425
4462
  # @type JobId: String
4426
- # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4463
+ # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4427
4464
  # @type CompareTaskId: String
4428
4465
  # @param TaskName: 一致性校验任务名称
4429
4466
  # @type TaskName: String
@@ -4461,9 +4498,9 @@ module TencentCloud
4461
4498
 
4462
4499
  # ModifyCompareTask请求参数结构体
4463
4500
  class ModifyCompareTaskRequest < TencentCloud::Common::AbstractModel
4464
- # @param JobId: 任务 Id
4501
+ # @param JobId: 任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4465
4502
  # @type JobId: String
4466
- # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4503
+ # @param CompareTaskId: 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4467
4504
  # @type CompareTaskId: String
4468
4505
  # @param TaskName: 任务名称
4469
4506
  # @type TaskName: String
@@ -4609,7 +4646,7 @@ module TencentCloud
4609
4646
 
4610
4647
  # ModifyMigrateJobSpec请求参数结构体
4611
4648
  class ModifyMigrateJobSpecRequest < TencentCloud::Common::AbstractModel
4612
- # @param JobId: 任务id
4649
+ # @param JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4613
4650
  # @type JobId: String
4614
4651
  # @param NewInstanceClass: 新实例规格大小,包括:micro、small、medium、large、xlarge、2xlarge
4615
4652
  # @type NewInstanceClass: String
@@ -4645,7 +4682,7 @@ module TencentCloud
4645
4682
 
4646
4683
  # ModifyMigrateName请求参数结构体
4647
4684
  class ModifyMigrateNameRequest < TencentCloud::Common::AbstractModel
4648
- # @param JobId: 迁移任务id
4685
+ # @param JobId: 迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4649
4686
  # @type JobId: String
4650
4687
  # @param JobName: 修改后的迁移任务名
4651
4688
  # @type JobName: String
@@ -4681,7 +4718,7 @@ module TencentCloud
4681
4718
 
4682
4719
  # ModifyMigrateRateLimit请求参数结构体
4683
4720
  class ModifyMigrateRateLimitRequest < TencentCloud::Common::AbstractModel
4684
- # @param JobId: 迁移任务ID
4721
+ # @param JobId: 迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4685
4722
  # @type JobId: String
4686
4723
  # @param DumpThread: 迁移任务全量导出线程数、有效值为 1-16
4687
4724
  # @type DumpThread: Integer
@@ -4733,7 +4770,7 @@ module TencentCloud
4733
4770
 
4734
4771
  # ModifyMigrateRuntimeAttribute请求参数结构体
4735
4772
  class ModifyMigrateRuntimeAttributeRequest < TencentCloud::Common::AbstractModel
4736
- # @param JobId: 迁移任务id,如:dts-2rgv0f09
4773
+ # @param JobId: 迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4737
4774
  # @type JobId: String
4738
4775
  # @param OtherOptions: 需要修改的属性,此结构设计为通用结构,用于屏蔽多个业务的定制属性。<br>例如对于Redis:<br>{<br> "Key": "DstWriteMode", //目标库写入模式<br> "Value": "normal" //clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作,默认为此值) <br>},<br>{<br/> "Key": "IsDstReadOnly", //是否在迁移时设置目标库只读<br/> "Value": "true" //true(设置只读)、false(不设置只读) <br/>}
4739
4776
  # @type OtherOptions: Array
@@ -4776,7 +4813,7 @@ module TencentCloud
4776
4813
 
4777
4814
  # ModifyMigrationJob请求参数结构体
4778
4815
  class ModifyMigrationJobRequest < TencentCloud::Common::AbstractModel
4779
- # @param JobId: 任务id
4816
+ # @param JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4780
4817
  # @type JobId: String
4781
4818
  # @param RunMode: 运行模式,取值如:immediate(表示立即运行)、timed(表示定时运行)
4782
4819
  # @type RunMode: String
@@ -5003,7 +5040,7 @@ module TencentCloud
5003
5040
 
5004
5041
  # ModifySyncJobConfig请求参数结构体
5005
5042
  class ModifySyncJobConfigRequest < TencentCloud::Common::AbstractModel
5006
- # @param JobId: 同步任务id
5043
+ # @param JobId: 同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5007
5044
  # @type JobId: String
5008
5045
  # @param DynamicObjects: 修改后的同步对象
5009
5046
  # @type DynamicObjects: :class:`Tencentcloud::Dts.v20211206.models.Objects`
@@ -5049,11 +5086,11 @@ module TencentCloud
5049
5086
 
5050
5087
  # ModifySyncRateLimit请求参数结构体
5051
5088
  class ModifySyncRateLimitRequest < TencentCloud::Common::AbstractModel
5052
- # @param JobId: 迁移任务ID
5089
+ # @param JobId: 同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5053
5090
  # @type JobId: String
5054
5091
  # @param DumpThread: 同步任务全量导出线程数、有效值为 1-16
5055
5092
  # @type DumpThread: Integer
5056
- # @param DumpRps: 同步任务全量导出的 Rps 限制、需要大于 0
5093
+ # @param DumpRps: 同步任务全量导出的 Rps 限制、需要大于 0;对于mongodb最大值为20000,其他数据库最大值为50000000
5057
5094
  # @type DumpRps: Integer
5058
5095
  # @param LoadThread: 同步任务全量导入线程数、有效值为 1-16
5059
5096
  # @type LoadThread: Integer
@@ -5188,7 +5225,7 @@ module TencentCloud
5188
5225
 
5189
5226
  # OnlineDDL类型
5190
5227
  class OnlineDDL < TencentCloud::Common::AbstractModel
5191
- # @param Status: 状态
5228
+ # @param Status: 状态,ON-启用,OFF-不启用。
5192
5229
  # @type Status: String
5193
5230
 
5194
5231
  attr_accessor :Status
@@ -5578,13 +5615,13 @@ module TencentCloud
5578
5615
 
5579
5616
  # ResetConsumerGroupOffset请求参数结构体
5580
5617
  class ResetConsumerGroupOffsetRequest < TencentCloud::Common::AbstractModel
5581
- # @param SubscribeId: 订阅实例id
5618
+ # @param SubscribeId: 订阅实例id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5582
5619
  # @type SubscribeId: String
5583
- # @param TopicName: 订阅的kafka topic
5620
+ # @param TopicName: 订阅的kafka topic,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5584
5621
  # @type TopicName: String
5585
- # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
5622
+ # @param ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/api/571/102947)接口获取。
5586
5623
  # @type ConsumerGroupName: String
5587
- # @param PartitionNos: 需要修改offset的分区编号
5624
+ # @param PartitionNos: 需要修改offset的分区编号,可通过[DescribeOffsetByTime](https://cloud.tencent.com/document/api/571/102946)接口获取。
5588
5625
  # @type PartitionNos: Array
5589
5626
  # @param ResetMode: 重置方式。枚举值为 earliest-从最开始位置开始消费;latest-从最新位置开始消费;datetime-从指定时间前最近的checkpoint开始消费
5590
5627
  # @type ResetMode: String
@@ -5694,9 +5731,9 @@ module TencentCloud
5694
5731
 
5695
5732
  # ResizeSyncJob请求参数结构体
5696
5733
  class ResizeSyncJobRequest < TencentCloud::Common::AbstractModel
5697
- # @param JobId: 同步任务id
5734
+ # @param JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5698
5735
  # @type JobId: String
5699
- # @param NewInstanceClass: 任务规格
5736
+ # @param NewInstanceClass: 任务规格,可选值包括micro,small,medium,large
5700
5737
  # @type NewInstanceClass: String
5701
5738
 
5702
5739
  attr_accessor :JobId, :NewInstanceClass
@@ -5730,7 +5767,7 @@ module TencentCloud
5730
5767
 
5731
5768
  # ResumeMigrateJob请求参数结构体
5732
5769
  class ResumeMigrateJobRequest < TencentCloud::Common::AbstractModel
5733
- # @param JobId: 数据迁移任务ID
5770
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5734
5771
  # @type JobId: String
5735
5772
  # @param ResumeOption: 恢复任务的模式,目前的取值有:clearData 清空目标实例数据,overwrite 以覆盖写的方式执行任务,normal 跟正常流程一样,不做额外动作;注意,clearData、overwrite仅对redis生效,normal仅针对非redis链路生效
5736
5773
  # @type ResumeOption: String
@@ -5878,9 +5915,9 @@ module TencentCloud
5878
5915
 
5879
5916
  # SkipCheckItem请求参数结构体
5880
5917
  class SkipCheckItemRequest < TencentCloud::Common::AbstractModel
5881
- # @param JobId: 数据迁移任务ID
5918
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5882
5919
  # @type JobId: String
5883
- # @param StepIds: 需要跳过校验项的步骤id,需要通过DescribeMigrationCheckJob接口返回StepInfo[i].StepId字段获取,例如:["OptimizeCheck"]
5920
+ # @param StepIds: 需要跳过校验项的步骤id,需要通过[DescribeMigrationCheckJob](https://cloud.tencent.com/document/product/571/82086)接口返回StepInfo[i].StepId字段获取,例如:["OptimizeCheck"]
5884
5921
  # @type StepIds: Array
5885
5922
  # @param ForeignKeyFlag: 当出现外键依赖检查导致校验不通过时、可以通过该字段选择是否迁移外键依赖,当StepIds包含ConstraintCheck且该字段值为shield时表示不迁移外键依赖、当StepIds包含ConstraintCheck且值为migrate时表示迁移外键依赖
5886
5923
  # @type ForeignKeyFlag: String
@@ -5922,7 +5959,7 @@ module TencentCloud
5922
5959
 
5923
5960
  # SkipSyncCheckItem请求参数结构体
5924
5961
  class SkipSyncCheckItemRequest < TencentCloud::Common::AbstractModel
5925
- # @param JobId: 任务id,如:sync-4ddgid2
5962
+ # @param JobId: 任务id,如:sync-4ddgid2,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
5926
5963
  # @type JobId: String
5927
5964
  # @param StepIds: 需要跳过校验项的步骤id,需要通过`DescribeCheckSyncJobResult`接口返回StepInfos[i].StepId字段获取,例如:["OptimizeCheck"]
5928
5965
  # @type StepIds: Array
@@ -6049,7 +6086,7 @@ module TencentCloud
6049
6086
 
6050
6087
  # StartMigrateJob请求参数结构体
6051
6088
  class StartMigrateJobRequest < TencentCloud::Common::AbstractModel
6052
- # @param JobId: 数据迁移任务ID
6089
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
6053
6090
  # @type JobId: String
6054
6091
 
6055
6092
  attr_accessor :JobId
@@ -6145,7 +6182,7 @@ module TencentCloud
6145
6182
 
6146
6183
  # StartSyncJob请求参数结构体
6147
6184
  class StartSyncJobRequest < TencentCloud::Common::AbstractModel
6148
- # @param JobId: 同步任务id
6185
+ # @param JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
6149
6186
  # @type JobId: String
6150
6187
 
6151
6188
  attr_accessor :JobId
@@ -6371,7 +6408,7 @@ module TencentCloud
6371
6408
 
6372
6409
  # StopMigrateJob请求参数结构体
6373
6410
  class StopMigrateJobRequest < TencentCloud::Common::AbstractModel
6374
- # @param JobId: 数据迁移任务ID
6411
+ # @param JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
6375
6412
  # @type JobId: String
6376
6413
 
6377
6414
  attr_accessor :JobId
@@ -6465,7 +6502,7 @@ module TencentCloud
6465
6502
  # @type StepId: String
6466
6503
  # @param StepNo: 步骤编号,从 1 开始
6467
6504
  # @type StepNo: Integer
6468
- # @param Status: 当前步骤状态,可能值为 notStarted,running,finished,failed
6505
+ # @param Status: 当前步骤状态,可能值为 notStarted-未开始,running-运行中,finished-已完成,failed-失败,unknown-未知
6469
6506
  # @type Status: String
6470
6507
  # @param Percent: 当前步骤进度
6471
6508
  # @type Percent: Integer
@@ -6838,9 +6875,9 @@ module TencentCloud
6838
6875
  # @type ExpireTime: String
6839
6876
  # @param SrcRegion: 源端地域,如:ap-guangzhou等
6840
6877
  # @type SrcRegion: String
6841
- # @param SrcDatabaseType: 源端数据库类型,mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等
6878
+ # @param SrcDatabaseType: 源端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。
6842
6879
  # @type SrcDatabaseType: String
6843
- # @param SrcAccessType: 源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)
6880
+ # @param SrcAccessType: 源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)
6844
6881
  # @type SrcAccessType: String
6845
6882
  # @param SrcInfo: 源端信息,单节点数据库使用
6846
6883
  # @type SrcInfo: :class:`Tencentcloud::Dts.v20211206.models.Endpoint`
@@ -6850,7 +6887,7 @@ module TencentCloud
6850
6887
  # @type SrcInfos: :class:`Tencentcloud::Dts.v20211206.models.SyncDBEndpointInfos`
6851
6888
  # @param DstRegion: 目标端地域,如:ap-guangzhou等
6852
6889
  # @type DstRegion: String
6853
- # @param DstDatabaseType: 目标端数据库类型,mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等
6890
+ # @param DstDatabaseType: 目标端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。
6854
6891
  # @type DstDatabaseType: String
6855
6892
  # @param DstAccessType: 目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)
6856
6893
  # @type DstAccessType: 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.1156
4
+ version: 3.0.1158
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-10-19 00:00:00.000000000 Z
11
+ date: 2025-10-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common