tencentcloud-sdk-python-dts 3.0.1459__tar.gz → 3.0.1469__tar.gz

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 (20) hide show
  1. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/setup.py +1 -1
  3. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20180330/dts_client.py +1 -1
  5. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20180330/models.py +8 -4
  6. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20211206/dts_client.py +6 -5
  7. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20211206/models.py +152 -108
  8. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud_sdk_python_dts.egg-info/PKG-INFO +1 -1
  9. tencentcloud-sdk-python-dts-3.0.1469/tencentcloud_sdk_python_dts.egg-info/requires.txt +1 -0
  10. tencentcloud-sdk-python-dts-3.0.1459/tencentcloud_sdk_python_dts.egg-info/requires.txt +0 -1
  11. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/README.rst +0 -0
  12. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/setup.cfg +0 -0
  13. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/__init__.py +0 -0
  14. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20180330/__init__.py +0 -0
  15. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20180330/errorcodes.py +0 -0
  16. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20211206/__init__.py +0 -0
  17. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud/dts/v20211206/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud_sdk_python_dts.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud_sdk_python_dts.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-dts-3.0.1459 → tencentcloud-sdk-python-dts-3.0.1469}/tencentcloud_sdk_python_dts.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-dts
3
- Version: 3.0.1459
3
+ Version: 3.0.1469
4
4
  Summary: Tencent Cloud Dts SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-dts',
11
- install_requires=["tencentcloud-sdk-python-common>=3.0.1459,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.0.1469,<4.0.0"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Dts SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1459'
17
+ __version__ = '3.0.1469'
@@ -501,7 +501,7 @@ class DtsClient(AbstractClient):
501
501
 
502
502
 
503
503
  def StartMigrateJob(self, request):
504
- r"""本接口(StartMigrationJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
504
+ r"""本接口(StartMigrateJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
505
505
  调用此接口前,请务必先使用CreateMigrateCheckJob校验数据迁移任务,并通过DescribeMigrateJobs接口查询到任务状态为校验通过(status=4)时,才能启动数据迁移任务。
506
506
 
507
507
  :param request: Request instance for StartMigrateJob.
@@ -181,7 +181,8 @@ class CompleteMigrateJobRequest(AbstractModel):
181
181
 
182
182
  def __init__(self):
183
183
  r"""
184
- :param _JobId: 数据迁移任务ID
184
+ :param _JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
185
+
185
186
  :type JobId: str
186
187
  :param _CompleteMode: 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
187
188
  :type CompleteMode: str
@@ -191,7 +192,8 @@ class CompleteMigrateJobRequest(AbstractModel):
191
192
 
192
193
  @property
193
194
  def JobId(self):
194
- r"""数据迁移任务ID
195
+ r"""数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
196
+
195
197
  :rtype: str
196
198
  """
197
199
  return self._JobId
@@ -4146,14 +4148,16 @@ class StartMigrateJobRequest(AbstractModel):
4146
4148
 
4147
4149
  def __init__(self):
4148
4150
  r"""
4149
- :param _JobId: 数据迁移任务ID
4151
+ :param _JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4152
+
4150
4153
  :type JobId: str
4151
4154
  """
4152
4155
  self._JobId = None
4153
4156
 
4154
4157
  @property
4155
4158
  def JobId(self):
4156
- r"""数据迁移任务ID
4159
+ r"""数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4160
+
4157
4161
  :rtype: str
4158
4162
  """
4159
4163
  return self._JobId
@@ -190,7 +190,8 @@ class DtsClient(AbstractClient):
190
190
 
191
191
 
192
192
  def CreateConsumerGroup(self, request):
193
- r"""为订阅实例创建消费者组
193
+ r"""为订阅实例创建消费者组。
194
+ 只有状态为运行中的实例支持创建消费组。
194
195
 
195
196
  :param request: Request instance for CreateConsumerGroup.
196
197
  :type request: :class:`tencentcloud.dts.v20211206.models.CreateConsumerGroupRequest`
@@ -213,7 +214,7 @@ class DtsClient(AbstractClient):
213
214
 
214
215
 
215
216
  def CreateMigrateCheckJob(self, request):
216
- r"""校验迁移任务,
217
+ r"""创建校验迁移任务,
217
218
  在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看,
218
219
  校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移
219
220
 
@@ -865,7 +866,7 @@ class DtsClient(AbstractClient):
865
866
 
866
867
 
867
868
  def IsolateSyncJob(self, request):
868
- r"""隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
869
+ r"""隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
869
870
 
870
871
  :param request: Request instance for IsolateSyncJob.
871
872
  :type request: :class:`tencentcloud.dts.v20211206.models.IsolateSyncJobRequest`
@@ -1280,7 +1281,7 @@ class DtsClient(AbstractClient):
1280
1281
 
1281
1282
 
1282
1283
  def RecoverSyncJob(self, request):
1283
- r"""解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。
1284
+ r"""解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。注意,此接口只支持按量计费实例。
1284
1285
 
1285
1286
  :param request: Request instance for RecoverSyncJob.
1286
1287
  :type request: :class:`tencentcloud.dts.v20211206.models.RecoverSyncJobRequest`
@@ -1327,7 +1328,7 @@ class DtsClient(AbstractClient):
1327
1328
 
1328
1329
  def ResetSubscribe(self, request):
1329
1330
  r"""本接口(ResetSubscribe)用于重置订阅实例,重置后,可以重新配置订阅任务。
1330
- 可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
1331
+ 可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
1331
1332
 
1332
1333
  :param request: Request instance for ResetSubscribe.
1333
1334
  :type request: :class:`tencentcloud.dts.v20211206.models.ResetSubscribeRequest`
@@ -1743,11 +1743,12 @@ class ConfigureSyncJobRequest(AbstractModel):
1743
1743
 
1744
1744
  def __init__(self):
1745
1745
  r"""
1746
- :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23
1746
+ :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1747
+
1747
1748
  :type JobId: str
1748
- :param _SrcAccessType: 源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
1749
+ :param _SrcAccessType: 源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
1749
1750
  :type SrcAccessType: str
1750
- :param _DstAccessType: 目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
1751
+ :param _DstAccessType: 目标端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
1751
1752
  :type DstAccessType: str
1752
1753
  :param _Objects: 同步库表对象信息
1753
1754
  :type Objects: :class:`tencentcloud.dts.v20211206.models.Objects`
@@ -1763,13 +1764,13 @@ class ConfigureSyncJobRequest(AbstractModel):
1763
1764
  :type SrcConnectType: str
1764
1765
  :param _SrcInfo: 源端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
1765
1766
  :type SrcInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
1766
- :param _SrcInfos: 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1767
+ :param _SrcInfos: 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
1767
1768
  :type SrcInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1768
1769
  :param _SrcNodeType: 枚举值:cluster、single。源库为单节点数据库使用single,多节点使用cluster
1769
1770
  :type SrcNodeType: str
1770
1771
  :param _DstInfo: 目标端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
1771
1772
  :type DstInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
1772
- :param _DstInfos: 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1773
+ :param _DstInfos: 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
1773
1774
  :type DstInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1774
1775
  :param _DstNodeType: 枚举值:cluster、single。目标库为单节点数据库使用single,多节点使用cluster
1775
1776
  :type DstNodeType: str
@@ -1798,7 +1799,8 @@ class ConfigureSyncJobRequest(AbstractModel):
1798
1799
 
1799
1800
  @property
1800
1801
  def JobId(self):
1801
- r"""同步实例id(即标识一个同步作业),形如sync-werwfs23
1802
+ r"""同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1803
+
1802
1804
  :rtype: str
1803
1805
  """
1804
1806
  return self._JobId
@@ -1809,7 +1811,7 @@ class ConfigureSyncJobRequest(AbstractModel):
1809
1811
 
1810
1812
  @property
1811
1813
  def SrcAccessType(self):
1812
- r"""源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
1814
+ r"""源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
1813
1815
  :rtype: str
1814
1816
  """
1815
1817
  return self._SrcAccessType
@@ -1820,7 +1822,7 @@ class ConfigureSyncJobRequest(AbstractModel):
1820
1822
 
1821
1823
  @property
1822
1824
  def DstAccessType(self):
1823
- r"""目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
1825
+ r"""目标端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
1824
1826
  :rtype: str
1825
1827
  """
1826
1828
  return self._DstAccessType
@@ -1908,7 +1910,7 @@ class ConfigureSyncJobRequest(AbstractModel):
1908
1910
 
1909
1911
  @property
1910
1912
  def SrcInfos(self):
1911
- r"""源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1913
+ r"""源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
1912
1914
  :rtype: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1913
1915
  """
1914
1916
  return self._SrcInfos
@@ -1941,7 +1943,7 @@ class ConfigureSyncJobRequest(AbstractModel):
1941
1943
 
1942
1944
  @property
1943
1945
  def DstInfos(self):
1944
- r"""目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1946
+ r"""目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等,mongodb使用此参数透传。
1945
1947
  :rtype: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1946
1948
  """
1947
1949
  return self._DstInfos
@@ -2161,14 +2163,16 @@ class ContinueMigrateJobRequest(AbstractModel):
2161
2163
 
2162
2164
  def __init__(self):
2163
2165
  r"""
2164
- :param _JobId: 数据迁移任务ID
2166
+ :param _JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2167
+
2165
2168
  :type JobId: str
2166
2169
  """
2167
2170
  self._JobId = None
2168
2171
 
2169
2172
  @property
2170
2173
  def JobId(self):
2171
- r"""数据迁移任务ID
2174
+ r"""数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2175
+
2172
2176
  :rtype: str
2173
2177
  """
2174
2178
  return self._JobId
@@ -2225,14 +2229,16 @@ class ContinueSyncJobRequest(AbstractModel):
2225
2229
 
2226
2230
  def __init__(self):
2227
2231
  r"""
2228
- :param _JobId: 同步任务id
2232
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2233
+
2229
2234
  :type JobId: str
2230
2235
  """
2231
2236
  self._JobId = None
2232
2237
 
2233
2238
  @property
2234
2239
  def JobId(self):
2235
- r"""同步任务id
2240
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2241
+
2236
2242
  :rtype: str
2237
2243
  """
2238
2244
  return self._JobId
@@ -2289,14 +2295,16 @@ class CreateCheckSyncJobRequest(AbstractModel):
2289
2295
 
2290
2296
  def __init__(self):
2291
2297
  r"""
2292
- :param _JobId: 同步任务id
2298
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2299
+
2293
2300
  :type JobId: str
2294
2301
  """
2295
2302
  self._JobId = None
2296
2303
 
2297
2304
  @property
2298
2305
  def JobId(self):
2299
- r"""同步任务id
2306
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2307
+
2300
2308
  :rtype: str
2301
2309
  """
2302
2310
  return self._JobId
@@ -2496,7 +2504,8 @@ class CreateConsumerGroupRequest(AbstractModel):
2496
2504
 
2497
2505
  def __init__(self):
2498
2506
  r"""
2499
- :param _SubscribeId: 订阅实例id
2507
+ :param _SubscribeId: 订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2508
+
2500
2509
  :type SubscribeId: str
2501
2510
  :param _ConsumerGroupName: 消费组名称,以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
2502
2511
  :type ConsumerGroupName: str
@@ -2515,7 +2524,8 @@ class CreateConsumerGroupRequest(AbstractModel):
2515
2524
 
2516
2525
  @property
2517
2526
  def SubscribeId(self):
2518
- r"""订阅实例id
2527
+ r"""订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2528
+
2519
2529
  :rtype: str
2520
2530
  """
2521
2531
  return self._SubscribeId
@@ -2620,14 +2630,16 @@ class CreateMigrateCheckJobRequest(AbstractModel):
2620
2630
 
2621
2631
  def __init__(self):
2622
2632
  r"""
2623
- :param _JobId: 数据迁移任务ID
2633
+ :param _JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2634
+
2624
2635
  :type JobId: str
2625
2636
  """
2626
2637
  self._JobId = None
2627
2638
 
2628
2639
  @property
2629
2640
  def JobId(self):
2630
- r"""数据迁移任务ID
2641
+ r"""数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
2642
+
2631
2643
  :rtype: str
2632
2644
  """
2633
2645
  return self._JobId
@@ -2875,14 +2887,14 @@ class CreateModifyCheckSyncJobRequest(AbstractModel):
2875
2887
 
2876
2888
  def __init__(self):
2877
2889
  r"""
2878
- :param _JobId: 同步任务id
2890
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2879
2891
  :type JobId: str
2880
2892
  """
2881
2893
  self._JobId = None
2882
2894
 
2883
2895
  @property
2884
2896
  def JobId(self):
2885
- r"""同步任务id
2897
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2886
2898
  :rtype: str
2887
2899
  """
2888
2900
  return self._JobId
@@ -2939,14 +2951,14 @@ class CreateSubscribeCheckJobRequest(AbstractModel):
2939
2951
 
2940
2952
  def __init__(self):
2941
2953
  r"""
2942
- :param _SubscribeId: 数据订阅实例的 ID
2954
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2943
2955
  :type SubscribeId: str
2944
2956
  """
2945
2957
  self._SubscribeId = None
2946
2958
 
2947
2959
  @property
2948
2960
  def SubscribeId(self):
2949
- r"""数据订阅实例的 ID
2961
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2950
2962
  :rtype: str
2951
2963
  """
2952
2964
  return self._SubscribeId
@@ -4835,13 +4847,14 @@ class DeleteConsumerGroupRequest(AbstractModel):
4835
4847
 
4836
4848
  def __init__(self):
4837
4849
  r"""
4838
- :param _SubscribeId: 数据订阅实例的 ID
4850
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4851
+
4839
4852
  :type SubscribeId: str
4840
4853
  :param _ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
4841
- 请务必保证消费组名称正确。
4854
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4842
4855
  :type ConsumerGroupName: str
4843
4856
  :param _AccountName: 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
4844
- 请务必保证账户名称正确。
4857
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4845
4858
  :type AccountName: str
4846
4859
  """
4847
4860
  self._SubscribeId = None
@@ -4850,7 +4863,8 @@ class DeleteConsumerGroupRequest(AbstractModel):
4850
4863
 
4851
4864
  @property
4852
4865
  def SubscribeId(self):
4853
- r"""数据订阅实例的 ID
4866
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4867
+
4854
4868
  :rtype: str
4855
4869
  """
4856
4870
  return self._SubscribeId
@@ -4862,7 +4876,7 @@ class DeleteConsumerGroupRequest(AbstractModel):
4862
4876
  @property
4863
4877
  def ConsumerGroupName(self):
4864
4878
  r"""消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
4865
- 请务必保证消费组名称正确。
4879
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4866
4880
  :rtype: str
4867
4881
  """
4868
4882
  return self._ConsumerGroupName
@@ -4874,7 +4888,7 @@ class DeleteConsumerGroupRequest(AbstractModel):
4874
4888
  @property
4875
4889
  def AccountName(self):
4876
4890
  r"""账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
4877
- 请务必保证账户名称正确。
4891
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
4878
4892
  :rtype: str
4879
4893
  """
4880
4894
  return self._AccountName
@@ -4933,14 +4947,16 @@ class DescribeCheckSyncJobResultRequest(AbstractModel):
4933
4947
 
4934
4948
  def __init__(self):
4935
4949
  r"""
4936
- :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填
4950
+ :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
4951
+
4937
4952
  :type JobId: str
4938
4953
  """
4939
4954
  self._JobId = None
4940
4955
 
4941
4956
  @property
4942
4957
  def JobId(self):
4943
- r"""同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填
4958
+ r"""同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
4959
+
4944
4960
  :rtype: str
4945
4961
  """
4946
4962
  return self._JobId
@@ -5079,9 +5095,9 @@ class DescribeCompareReportRequest(AbstractModel):
5079
5095
 
5080
5096
  def __init__(self):
5081
5097
  r"""
5082
- :param _JobId: 迁移任务 Id
5098
+ :param _JobId: 迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5083
5099
  :type JobId: str
5084
- :param _CompareTaskId: 校验任务 Id
5100
+ :param _CompareTaskId: 校验任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5085
5101
  :type CompareTaskId: str
5086
5102
  :param _DifferenceLimit: 校验不一致结果的 limit
5087
5103
  :type DifferenceLimit: int
@@ -5113,7 +5129,7 @@ class DescribeCompareReportRequest(AbstractModel):
5113
5129
 
5114
5130
  @property
5115
5131
  def JobId(self):
5116
- r"""迁移任务 Id
5132
+ r"""迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5117
5133
  :rtype: str
5118
5134
  """
5119
5135
  return self._JobId
@@ -5124,7 +5140,7 @@ class DescribeCompareReportRequest(AbstractModel):
5124
5140
 
5125
5141
  @property
5126
5142
  def CompareTaskId(self):
5127
- r"""校验任务 Id
5143
+ r"""校验任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5128
5144
  :rtype: str
5129
5145
  """
5130
5146
  return self._CompareTaskId
@@ -5471,7 +5487,7 @@ class DescribeConsumerGroupsRequest(AbstractModel):
5471
5487
 
5472
5488
  def __init__(self):
5473
5489
  r"""
5474
- :param _SubscribeId: 订阅实例id
5490
+ :param _SubscribeId: 订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
5475
5491
  :type SubscribeId: str
5476
5492
  :param _Offset: 返回记录的起始偏移量。默认0
5477
5493
  :type Offset: int
@@ -5484,7 +5500,7 @@ class DescribeConsumerGroupsRequest(AbstractModel):
5484
5500
 
5485
5501
  @property
5486
5502
  def SubscribeId(self):
5487
- r"""订阅实例id
5503
+ r"""订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
5488
5504
  :rtype: str
5489
5505
  """
5490
5506
  return self._SubscribeId
@@ -5834,14 +5850,16 @@ class DescribeMigrationCheckJobRequest(AbstractModel):
5834
5850
 
5835
5851
  def __init__(self):
5836
5852
  r"""
5837
- :param _JobId: 任务id
5853
+ :param _JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5854
+
5838
5855
  :type JobId: str
5839
5856
  """
5840
5857
  self._JobId = None
5841
5858
 
5842
5859
  @property
5843
5860
  def JobId(self):
5844
- r"""任务id
5861
+ r"""任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
5862
+
5845
5863
  :rtype: str
5846
5864
  """
5847
5865
  return self._JobId
@@ -6718,14 +6736,16 @@ class DescribeModifyCheckSyncJobResultRequest(AbstractModel):
6718
6736
 
6719
6737
  def __init__(self):
6720
6738
  r"""
6721
- :param _JobId: 同步任务id
6739
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
6740
+
6722
6741
  :type JobId: str
6723
6742
  """
6724
6743
  self._JobId = None
6725
6744
 
6726
6745
  @property
6727
6746
  def JobId(self):
6728
- r"""同步任务id
6747
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
6748
+
6729
6749
  :rtype: str
6730
6750
  """
6731
6751
  return self._JobId
@@ -6864,7 +6884,7 @@ class DescribeOffsetByTimeRequest(AbstractModel):
6864
6884
 
6865
6885
  def __init__(self):
6866
6886
  r"""
6867
- :param _SubscribeId: 数据订阅实例的 ID
6887
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
6868
6888
  :type SubscribeId: str
6869
6889
  :param _Time: 时间点,格式为:Y-m-d h:m:s。如果输入时间比当前时间晚的多,相当于查询最新offset;如果输入时间比当前时间早的多,相当于查询最老offset;如果输入空,默认0时间,等价于查询最老offset。
6870
6890
  :type Time: str
@@ -6874,7 +6894,7 @@ class DescribeOffsetByTimeRequest(AbstractModel):
6874
6894
 
6875
6895
  @property
6876
6896
  def SubscribeId(self):
6877
- r"""数据订阅实例的 ID
6897
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
6878
6898
  :rtype: str
6879
6899
  """
6880
6900
  return self._SubscribeId
@@ -7137,14 +7157,14 @@ class DescribeSubscribeDetailRequest(AbstractModel):
7137
7157
 
7138
7158
  def __init__(self):
7139
7159
  r"""
7140
- :param _SubscribeId: 订阅实例ID
7160
+ :param _SubscribeId: 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
7141
7161
  :type SubscribeId: str
7142
7162
  """
7143
7163
  self._SubscribeId = None
7144
7164
 
7145
7165
  @property
7146
7166
  def SubscribeId(self):
7147
- r"""订阅实例ID
7167
+ r"""订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
7148
7168
  :rtype: str
7149
7169
  """
7150
7170
  return self._SubscribeId
@@ -8003,14 +8023,14 @@ class DescribeSubscribeReturnableRequest(AbstractModel):
8003
8023
 
8004
8024
  def __init__(self):
8005
8025
  r"""
8006
- :param _SubscribeId: 数据订阅实例的ID
8026
+ :param _SubscribeId: 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
8007
8027
  :type SubscribeId: str
8008
8028
  """
8009
8029
  self._SubscribeId = None
8010
8030
 
8011
8031
  @property
8012
8032
  def SubscribeId(self):
8013
- r"""数据订阅实例的ID
8033
+ r"""数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
8014
8034
  :rtype: str
8015
8035
  """
8016
8036
  return self._SubscribeId
@@ -8396,14 +8416,14 @@ class DestroyIsolatedSubscribeRequest(AbstractModel):
8396
8416
 
8397
8417
  def __init__(self):
8398
8418
  r"""
8399
- :param _SubscribeId: 数据订阅实例的ID
8419
+ :param _SubscribeId: 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
8400
8420
  :type SubscribeId: str
8401
8421
  """
8402
8422
  self._SubscribeId = None
8403
8423
 
8404
8424
  @property
8405
8425
  def SubscribeId(self):
8406
- r"""数据订阅实例的ID
8426
+ r"""数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
8407
8427
  :rtype: str
8408
8428
  """
8409
8429
  return self._SubscribeId
@@ -8460,14 +8480,16 @@ class DestroyMigrateJobRequest(AbstractModel):
8460
8480
 
8461
8481
  def __init__(self):
8462
8482
  r"""
8463
- :param _JobId: 任务id
8483
+ :param _JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
8484
+
8464
8485
  :type JobId: str
8465
8486
  """
8466
8487
  self._JobId = None
8467
8488
 
8468
8489
  @property
8469
8490
  def JobId(self):
8470
- r"""任务id
8491
+ r"""任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
8492
+
8471
8493
  :rtype: str
8472
8494
  """
8473
8495
  return self._JobId
@@ -8524,14 +8546,16 @@ class DestroySyncJobRequest(AbstractModel):
8524
8546
 
8525
8547
  def __init__(self):
8526
8548
  r"""
8527
- :param _JobId: 同步任务id
8549
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
8550
+
8528
8551
  :type JobId: str
8529
8552
  """
8530
8553
  self._JobId = None
8531
8554
 
8532
8555
  @property
8533
8556
  def JobId(self):
8534
- r"""同步任务id
8557
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
8558
+
8535
8559
  :rtype: str
8536
8560
  """
8537
8561
  return self._JobId
@@ -10699,14 +10723,14 @@ class IsolateSubscribeRequest(AbstractModel):
10699
10723
 
10700
10724
  def __init__(self):
10701
10725
  r"""
10702
- :param _SubscribeId: 订阅实例ID
10726
+ :param _SubscribeId: 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
10703
10727
  :type SubscribeId: str
10704
10728
  """
10705
10729
  self._SubscribeId = None
10706
10730
 
10707
10731
  @property
10708
10732
  def SubscribeId(self):
10709
- r"""订阅实例ID
10733
+ r"""订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
10710
10734
  :rtype: str
10711
10735
  """
10712
10736
  return self._SubscribeId
@@ -10763,14 +10787,14 @@ class IsolateSyncJobRequest(AbstractModel):
10763
10787
 
10764
10788
  def __init__(self):
10765
10789
  r"""
10766
- :param _JobId: 同步任务id
10790
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
10767
10791
  :type JobId: str
10768
10792
  """
10769
10793
  self._JobId = None
10770
10794
 
10771
10795
  @property
10772
10796
  def JobId(self):
10773
- r"""同步任务id
10797
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
10774
10798
  :rtype: str
10775
10799
  """
10776
10800
  return self._JobId
@@ -11154,7 +11178,7 @@ class KafkaOption(AbstractModel):
11154
11178
 
11155
11179
  def __init__(self):
11156
11180
  r"""
11157
- :param _DataType: 投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json
11181
+ :param _DataType: 投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json,debezium
11158
11182
  :type DataType: str
11159
11183
  :param _TopicType: 同步topic策略,如Single(集中投递到单topic),Multi (自定义topic名称)
11160
11184
  :type TopicType: str
@@ -11170,7 +11194,7 @@ class KafkaOption(AbstractModel):
11170
11194
 
11171
11195
  @property
11172
11196
  def DataType(self):
11173
- r"""投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json
11197
+ r"""投递到kafka的数据类型,如Avro,Json,canal-pb,canal-json,debezium
11174
11198
  :rtype: str
11175
11199
  """
11176
11200
  return self._DataType
@@ -11559,6 +11583,7 @@ class MigrateOption(AbstractModel):
11559
11583
  :param _MigrateType: 迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement;注意redis,keewidb产品只支持fullAndIncrement类型。
11560
11584
  :type MigrateType: str
11561
11585
  :param _Consistency: 数据一致性校验选项, 默认为不开启一致性校验
11586
+ 注意:此字段可能返回 null,表示取不到有效值。
11562
11587
  :type Consistency: :class:`tencentcloud.dts.v20211206.models.ConsistencyOption`
11563
11588
  :param _IsMigrateAccount: 是否迁移账号,true(迁移账号),false(不迁移账号)
11564
11589
  :type IsMigrateAccount: bool
@@ -11567,7 +11592,7 @@ class MigrateOption(AbstractModel):
11567
11592
  :param _IsDstReadOnly: 是否在迁移时设置目标库只读(仅对mysql有效),true(设置只读)、false(不设置只读,默认此值)
11568
11593
  :type IsDstReadOnly: bool
11569
11594
  :param _ExtraAttr: 其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
11570
- ["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自动淘汰]
11595
+ ["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自动淘汰]
11571
11596
  :type ExtraAttr: list of KeyValuePairOption
11572
11597
  :param _MigrateWay: pgsql迁移分类:logical(逻辑迁移)、physical(物理迁移)
11573
11598
  :type MigrateWay: str
@@ -11606,6 +11631,7 @@ class MigrateOption(AbstractModel):
11606
11631
  @property
11607
11632
  def Consistency(self):
11608
11633
  r"""数据一致性校验选项, 默认为不开启一致性校验
11634
+ 注意:此字段可能返回 null,表示取不到有效值。
11609
11635
  :rtype: :class:`tencentcloud.dts.v20211206.models.ConsistencyOption`
11610
11636
  """
11611
11637
  return self._Consistency
@@ -11650,7 +11676,7 @@ class MigrateOption(AbstractModel):
11650
11676
  @property
11651
11677
  def ExtraAttr(self):
11652
11678
  r"""其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
11653
- ["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自动淘汰]
11679
+ ["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自动淘汰]
11654
11680
  :rtype: list of KeyValuePairOption
11655
11681
  """
11656
11682
  return self._ExtraAttr
@@ -12011,13 +12037,13 @@ class ModifyConsumerGroupDescriptionRequest(AbstractModel):
12011
12037
 
12012
12038
  def __init__(self):
12013
12039
  r"""
12014
- :param _SubscribeId: 数据订阅实例的 ID
12040
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12015
12041
  :type SubscribeId: str
12016
12042
  :param _ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
12017
- 请务必保证消费组名称正确。
12043
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12018
12044
  :type ConsumerGroupName: str
12019
12045
  :param _AccountName: 账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
12020
- 请务必保证账户名称正确。
12046
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12021
12047
  :type AccountName: str
12022
12048
  :param _Description: 修改之后的消费组描述
12023
12049
  :type Description: str
@@ -12029,7 +12055,7 @@ class ModifyConsumerGroupDescriptionRequest(AbstractModel):
12029
12055
 
12030
12056
  @property
12031
12057
  def SubscribeId(self):
12032
- r"""数据订阅实例的 ID
12058
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12033
12059
  :rtype: str
12034
12060
  """
12035
12061
  return self._SubscribeId
@@ -12041,7 +12067,7 @@ class ModifyConsumerGroupDescriptionRequest(AbstractModel):
12041
12067
  @property
12042
12068
  def ConsumerGroupName(self):
12043
12069
  r"""消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
12044
- 请务必保证消费组名称正确。
12070
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12045
12071
  :rtype: str
12046
12072
  """
12047
12073
  return self._ConsumerGroupName
@@ -12053,7 +12079,7 @@ class ModifyConsumerGroupDescriptionRequest(AbstractModel):
12053
12079
  @property
12054
12080
  def AccountName(self):
12055
12081
  r"""账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
12056
- 请务必保证账户名称正确。
12082
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12057
12083
  :rtype: str
12058
12084
  """
12059
12085
  return self._AccountName
@@ -12124,11 +12150,12 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12124
12150
 
12125
12151
  def __init__(self):
12126
12152
  r"""
12127
- :param _SubscribeId: 数据订阅实例的 ID
12153
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12154
+
12128
12155
  :type SubscribeId: str
12129
- :param _AccountName: 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}
12156
+ :param _AccountName: 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12130
12157
  :type AccountName: str
12131
- :param _ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
12158
+ :param _ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12132
12159
  :type ConsumerGroupName: str
12133
12160
  :param _NewPassword: 新密码。字符长度不小于3,不大于32
12134
12161
  :type NewPassword: str
@@ -12140,7 +12167,8 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12140
12167
 
12141
12168
  @property
12142
12169
  def SubscribeId(self):
12143
- r"""数据订阅实例的 ID
12170
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12171
+
12144
12172
  :rtype: str
12145
12173
  """
12146
12174
  return self._SubscribeId
@@ -12151,7 +12179,7 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12151
12179
 
12152
12180
  @property
12153
12181
  def AccountName(self):
12154
- r"""账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}
12182
+ r"""账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12155
12183
  :rtype: str
12156
12184
  """
12157
12185
  return self._AccountName
@@ -12162,7 +12190,7 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12162
12190
 
12163
12191
  @property
12164
12192
  def ConsumerGroupName(self):
12165
- r"""消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
12193
+ r"""消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
12166
12194
  :rtype: str
12167
12195
  """
12168
12196
  return self._ConsumerGroupName
@@ -12809,7 +12837,7 @@ class ModifySubscribeAutoRenewFlagRequest(AbstractModel):
12809
12837
 
12810
12838
  def __init__(self):
12811
12839
  r"""
12812
- :param _SubscribeId: 订阅实例ID
12840
+ :param _SubscribeId: 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12813
12841
  :type SubscribeId: str
12814
12842
  :param _AutoRenewFlag: 自动续费标识。1-自动续费,0-不自动续费
12815
12843
  :type AutoRenewFlag: int
@@ -12819,7 +12847,7 @@ class ModifySubscribeAutoRenewFlagRequest(AbstractModel):
12819
12847
 
12820
12848
  @property
12821
12849
  def SubscribeId(self):
12822
- r"""订阅实例ID
12850
+ r"""订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12823
12851
  :rtype: str
12824
12852
  """
12825
12853
  return self._SubscribeId
@@ -12888,7 +12916,7 @@ class ModifySubscribeNameRequest(AbstractModel):
12888
12916
 
12889
12917
  def __init__(self):
12890
12918
  r"""
12891
- :param _SubscribeId: 数据订阅实例的ID
12919
+ :param _SubscribeId: 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12892
12920
  :type SubscribeId: str
12893
12921
  :param _SubscribeName: 修改后的数据订阅实例的名称,长度限制为[1,60]
12894
12922
  :type SubscribeName: str
@@ -12898,7 +12926,7 @@ class ModifySubscribeNameRequest(AbstractModel):
12898
12926
 
12899
12927
  @property
12900
12928
  def SubscribeId(self):
12901
- r"""数据订阅实例的ID
12929
+ r"""数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12902
12930
  :rtype: str
12903
12931
  """
12904
12932
  return self._SubscribeId
@@ -12967,11 +12995,11 @@ class ModifySubscribeObjectsRequest(AbstractModel):
12967
12995
 
12968
12996
  def __init__(self):
12969
12997
  r"""
12970
- :param _SubscribeId: 数据订阅实例的ID
12998
+ :param _SubscribeId: 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12971
12999
  :type SubscribeId: str
12972
13000
  :param _SubscribeObjectType: 数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合
12973
13001
  :type SubscribeObjectType: int
12974
- :param _Objects: 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
13002
+ :param _Objects: 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。
12975
13003
  :type Objects: list of ModifiedSubscribeObject
12976
13004
  :param _DistributeRules: kafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。
12977
13005
  :type DistributeRules: list of DistributeRule
@@ -12991,7 +13019,7 @@ class ModifySubscribeObjectsRequest(AbstractModel):
12991
13019
 
12992
13020
  @property
12993
13021
  def SubscribeId(self):
12994
- r"""数据订阅实例的ID
13022
+ r"""数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
12995
13023
  :rtype: str
12996
13024
  """
12997
13025
  return self._SubscribeId
@@ -13013,7 +13041,7 @@ class ModifySubscribeObjectsRequest(AbstractModel):
13013
13041
 
13014
13042
  @property
13015
13043
  def Objects(self):
13016
- r"""修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
13044
+ r"""修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。
13017
13045
  :rtype: list of ModifiedSubscribeObject
13018
13046
  """
13019
13047
  return self._Objects
@@ -13620,7 +13648,7 @@ class Options(AbstractModel):
13620
13648
 
13621
13649
  def __init__(self):
13622
13650
  r"""
13623
- :param _InitType: 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
13651
+ :param _InitType: 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量);mongodb链路只支持全量数据初始化或仅增量。
13624
13652
  :type InitType: str
13625
13653
  :param _DealOfExistSameTable: 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、ExecuteAfterIgnore(忽略并继续执行)
13626
13654
  :type DealOfExistSameTable: str
@@ -13665,7 +13693,7 @@ class Options(AbstractModel):
13665
13693
 
13666
13694
  @property
13667
13695
  def InitType(self):
13668
- r"""同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
13696
+ r"""同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量);mongodb链路只支持全量数据初始化或仅增量。
13669
13697
  :rtype: str
13670
13698
  """
13671
13699
  return self._InitType
@@ -13904,14 +13932,16 @@ class PauseMigrateJobRequest(AbstractModel):
13904
13932
 
13905
13933
  def __init__(self):
13906
13934
  r"""
13907
- :param _JobId: 数据迁移任务ID
13935
+ :param _JobId: 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
13936
+
13908
13937
  :type JobId: str
13909
13938
  """
13910
13939
  self._JobId = None
13911
13940
 
13912
13941
  @property
13913
13942
  def JobId(self):
13914
- r"""数据迁移任务ID
13943
+ r"""数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
13944
+
13915
13945
  :rtype: str
13916
13946
  """
13917
13947
  return self._JobId
@@ -13968,14 +13998,16 @@ class PauseSyncJobRequest(AbstractModel):
13968
13998
 
13969
13999
  def __init__(self):
13970
14000
  r"""
13971
- :param _JobId: 同步任务id
14001
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
14002
+
13972
14003
  :type JobId: str
13973
14004
  """
13974
14005
  self._JobId = None
13975
14006
 
13976
14007
  @property
13977
14008
  def JobId(self):
13978
- r"""同步任务id
14009
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
14010
+
13979
14011
  :rtype: str
13980
14012
  """
13981
14013
  return self._JobId
@@ -14451,14 +14483,16 @@ class RecoverMigrateJobRequest(AbstractModel):
14451
14483
 
14452
14484
  def __init__(self):
14453
14485
  r"""
14454
- :param _JobId: 任务id
14486
+ :param _JobId: 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
14487
+
14455
14488
  :type JobId: str
14456
14489
  """
14457
14490
  self._JobId = None
14458
14491
 
14459
14492
  @property
14460
14493
  def JobId(self):
14461
- r"""任务id
14494
+ r"""任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
14495
+
14462
14496
  :rtype: str
14463
14497
  """
14464
14498
  return self._JobId
@@ -14515,14 +14549,16 @@ class RecoverSyncJobRequest(AbstractModel):
14515
14549
 
14516
14550
  def __init__(self):
14517
14551
  r"""
14518
- :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23
14552
+ :param _JobId: 同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
14553
+
14519
14554
  :type JobId: str
14520
14555
  """
14521
14556
  self._JobId = None
14522
14557
 
14523
14558
  @property
14524
14559
  def JobId(self):
14525
- r"""同步实例id(即标识一个同步作业),形如sync-werwfs23
14560
+ r"""同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
14561
+
14526
14562
  :rtype: str
14527
14563
  """
14528
14564
  return self._JobId
@@ -14718,14 +14754,16 @@ class ResetSubscribeRequest(AbstractModel):
14718
14754
 
14719
14755
  def __init__(self):
14720
14756
  r"""
14721
- :param _SubscribeId: 数据订阅实例的ID
14757
+ :param _SubscribeId: 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
14758
+
14722
14759
  :type SubscribeId: str
14723
14760
  """
14724
14761
  self._SubscribeId = None
14725
14762
 
14726
14763
  @property
14727
14764
  def SubscribeId(self):
14728
- r"""数据订阅实例的ID
14765
+ r"""数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
14766
+
14729
14767
  :rtype: str
14730
14768
  """
14731
14769
  return self._SubscribeId
@@ -15004,14 +15042,14 @@ class ResumeSubscribeRequest(AbstractModel):
15004
15042
 
15005
15043
  def __init__(self):
15006
15044
  r"""
15007
- :param _SubscribeId: 数据订阅实例的 ID
15045
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
15008
15046
  :type SubscribeId: str
15009
15047
  """
15010
15048
  self._SubscribeId = None
15011
15049
 
15012
15050
  @property
15013
15051
  def SubscribeId(self):
15014
- r"""数据订阅实例的 ID
15052
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
15015
15053
  :rtype: str
15016
15054
  """
15017
15055
  return self._SubscribeId
@@ -15068,14 +15106,16 @@ class ResumeSyncJobRequest(AbstractModel):
15068
15106
 
15069
15107
  def __init__(self):
15070
15108
  r"""
15071
- :param _JobId: 同步任务id
15109
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
15110
+
15072
15111
  :type JobId: str
15073
15112
  """
15074
15113
  self._JobId = None
15075
15114
 
15076
15115
  @property
15077
15116
  def JobId(self):
15078
- r"""同步任务id
15117
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
15118
+
15079
15119
  :rtype: str
15080
15120
  """
15081
15121
  return self._JobId
@@ -15732,14 +15772,16 @@ class StartModifySyncJobRequest(AbstractModel):
15732
15772
 
15733
15773
  def __init__(self):
15734
15774
  r"""
15735
- :param _JobId: 同步任务id
15775
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
15776
+
15736
15777
  :type JobId: str
15737
15778
  """
15738
15779
  self._JobId = None
15739
15780
 
15740
15781
  @property
15741
15782
  def JobId(self):
15742
- r"""同步任务id
15783
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
15784
+
15743
15785
  :rtype: str
15744
15786
  """
15745
15787
  return self._JobId
@@ -15796,14 +15838,14 @@ class StartSubscribeRequest(AbstractModel):
15796
15838
 
15797
15839
  def __init__(self):
15798
15840
  r"""
15799
- :param _SubscribeId: 数据订阅实例的 ID
15841
+ :param _SubscribeId: 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
15800
15842
  :type SubscribeId: str
15801
15843
  """
15802
15844
  self._SubscribeId = None
15803
15845
 
15804
15846
  @property
15805
15847
  def SubscribeId(self):
15806
- r"""数据订阅实例的 ID
15848
+ r"""数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
15807
15849
  :rtype: str
15808
15850
  """
15809
15851
  return self._SubscribeId
@@ -16499,14 +16541,16 @@ class StopSyncJobRequest(AbstractModel):
16499
16541
 
16500
16542
  def __init__(self):
16501
16543
  r"""
16502
- :param _JobId: 同步任务id
16544
+ :param _JobId: 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
16545
+
16503
16546
  :type JobId: str
16504
16547
  """
16505
16548
  self._JobId = None
16506
16549
 
16507
16550
  @property
16508
16551
  def JobId(self):
16509
- r"""同步任务id
16552
+ r"""同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
16553
+
16510
16554
  :rtype: str
16511
16555
  """
16512
16556
  return self._JobId
@@ -17630,7 +17674,7 @@ class SyncJobInfo(AbstractModel):
17630
17674
  :type SrcInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
17631
17675
  :param _SrcNodeType: 枚举值:cluster、single。源库为单节点数据库使用single,多节点使用cluster
17632
17676
  :type SrcNodeType: str
17633
- :param _SrcInfos: 源端信息,多节点数据库使用
17677
+ :param _SrcInfos: 源端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
17634
17678
  :type SrcInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
17635
17679
  :param _DstRegion: 目标端地域,如:ap-guangzhou等
17636
17680
  :type DstRegion: str
@@ -17642,7 +17686,7 @@ class SyncJobInfo(AbstractModel):
17642
17686
  :type DstInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
17643
17687
  :param _DstNodeType: 枚举值:cluster、single。目标库为单节点数据库使用single,多节点使用cluster
17644
17688
  :type DstNodeType: str
17645
- :param _DstInfos: 目标端信息,多节点数据库使用
17689
+ :param _DstInfos: 目标端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
17646
17690
  :type DstInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
17647
17691
  :param _CreateTime: 创建时间,格式为 yyyy-mm-dd hh:mm:ss
17648
17692
  :type CreateTime: str
@@ -17887,7 +17931,7 @@ class SyncJobInfo(AbstractModel):
17887
17931
 
17888
17932
  @property
17889
17933
  def SrcInfos(self):
17890
- r"""源端信息,多节点数据库使用
17934
+ r"""源端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
17891
17935
  :rtype: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
17892
17936
  """
17893
17937
  return self._SrcInfos
@@ -17953,7 +17997,7 @@ class SyncJobInfo(AbstractModel):
17953
17997
 
17954
17998
  @property
17955
17999
  def DstInfos(self):
17956
- r"""目标端信息,多节点数据库使用
18000
+ r"""目标端信息,若SrcNodeType=cluster,则源端信息在这个字段里,mongodb链路使用此参数透传。
17957
18001
  :rtype: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
17958
18002
  """
17959
18003
  return self._DstInfos
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-dts
3
- Version: 3.0.1459
3
+ Version: 3.0.1469
4
4
  Summary: Tencent Cloud Dts SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.0.1469
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.0.1459