tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1077__py2.py3-none-any.whl

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.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (126) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/autoscaling_client.py +16 -10
  8. tencentcloud/autoscaling/v20180419/errorcodes.py +3 -0
  9. tencentcloud/autoscaling/v20180419/models.py +2472 -7
  10. tencentcloud/batch/v20170312/models.py +1566 -0
  11. tencentcloud/billing/v20180709/models.py +2418 -0
  12. tencentcloud/cam/v20190116/models.py +1697 -0
  13. tencentcloud/captcha/v20190722/models.py +70 -0
  14. tencentcloud/car/v20220110/models.py +803 -0
  15. tencentcloud/cbs/v20170312/models.py +1245 -0
  16. tencentcloud/ccc/v20200210/models.py +1949 -1
  17. tencentcloud/cdb/v20170320/models.py +4821 -0
  18. tencentcloud/cdn/v20180606/models.py +4870 -8
  19. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  20. tencentcloud/cfg/v20210820/models.py +1194 -0
  21. tencentcloud/cfs/v20190719/models.py +1178 -0
  22. tencentcloud/cfw/v20190904/models.py +2378 -0
  23. tencentcloud/chdfs/v20201112/models.py +513 -0
  24. tencentcloud/ciam/v20210420/models.py +49 -0
  25. tencentcloud/ciam/v20220331/models.py +789 -0
  26. tencentcloud/ckafka/v20190819/models.py +2576 -0
  27. tencentcloud/clb/v20180317/models.py +3220 -1
  28. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  29. tencentcloud/cls/v20201016/models.py +3652 -1
  30. tencentcloud/cmq/v20190304/models.py +571 -0
  31. tencentcloud/controlcenter/v20230110/models.py +15 -0
  32. tencentcloud/csip/v20221121/models.py +2881 -2
  33. tencentcloud/cvm/v20170312/models.py +2827 -0
  34. tencentcloud/cwp/v20180228/models.py +16412 -0
  35. tencentcloud/cynosdb/v20190107/models.py +4263 -0
  36. tencentcloud/dataintegration/v20220613/models.py +18 -0
  37. tencentcloud/dayu/v20180709/models.py +3541 -12
  38. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  39. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  40. tencentcloud/dc/v20180410/models.py +767 -0
  41. tencentcloud/dcdb/v20180411/models.py +2335 -0
  42. tencentcloud/dlc/v20210125/models.py +3985 -5
  43. tencentcloud/dms/v20200819/models.py +51 -0
  44. tencentcloud/dnspod/v20210323/models.py +1286 -0
  45. tencentcloud/domain/v20180808/models.py +855 -0
  46. tencentcloud/dts/v20180330/models.py +791 -0
  47. tencentcloud/dts/v20211206/models.py +2317 -1
  48. tencentcloud/eb/v20210416/models.py +858 -0
  49. tencentcloud/ecdn/v20191012/models.py +811 -0
  50. tencentcloud/ecm/v20190719/models.py +3972 -1
  51. tencentcloud/eiam/v20210420/models.py +1265 -0
  52. tencentcloud/emr/v20190103/models.py +2926 -7
  53. tencentcloud/es/v20180416/models.py +1523 -0
  54. tencentcloud/facefusion/v20220927/models.py +211 -0
  55. tencentcloud/faceid/v20180301/models.py +2071 -0
  56. tencentcloud/gaap/v20180529/models.py +3103 -8
  57. tencentcloud/gme/v20180711/models.py +388 -0
  58. tencentcloud/gpm/v20200820/models.py +674 -0
  59. tencentcloud/gse/v20191112/models.py +972 -0
  60. tencentcloud/iai/v20200303/models.py +1430 -0
  61. tencentcloud/ims/v20201229/models.py +329 -0
  62. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  63. tencentcloud/iotcloud/v20210408/models.py +585 -0
  64. tencentcloud/ip/v20210409/models.py +178 -0
  65. tencentcloud/kms/v20190118/models.py +869 -0
  66. tencentcloud/lcic/v20220817/models.py +1658 -0
  67. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  68. tencentcloud/live/v20180801/models.py +4287 -0
  69. tencentcloud/mariadb/v20170312/models.py +1905 -0
  70. tencentcloud/mdc/v20200828/models.py +1104 -0
  71. tencentcloud/mdl/v20200326/models.py +1911 -1
  72. tencentcloud/mdp/v20200527/models.py +452 -0
  73. tencentcloud/mongodb/v20190725/models.py +1234 -0
  74. tencentcloud/monitor/v20180724/models.py +5798 -2
  75. tencentcloud/mps/v20190612/models.py +8135 -0
  76. tencentcloud/msp/v20180319/models.py +183 -0
  77. tencentcloud/ocr/v20181119/models.py +3160 -1
  78. tencentcloud/omics/v20221128/models.py +1086 -0
  79. tencentcloud/organization/v20181225/models.py +285 -0
  80. tencentcloud/organization/v20210331/models.py +2267 -0
  81. tencentcloud/postgres/v20170312/models.py +3248 -0
  82. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  83. tencentcloud/privatedns/v20201028/models.py +1700 -0
  84. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  85. tencentcloud/redis/v20180412/models.py +3298 -3
  86. tencentcloud/rum/v20210622/models.py +2114 -0
  87. tencentcloud/scf/v20180416/models.py +1561 -0
  88. tencentcloud/ses/v20201002/models.py +649 -0
  89. tencentcloud/sms/v20190711/models.py +575 -0
  90. tencentcloud/sms/v20210111/models.py +593 -0
  91. tencentcloud/sqlserver/v20180328/models.py +2780 -0
  92. tencentcloud/ssl/v20191205/models.py +2267 -0
  93. tencentcloud/ssm/v20190923/models.py +675 -11
  94. tencentcloud/sts/v20180813/models.py +161 -0
  95. tencentcloud/tag/v20180813/models.py +784 -0
  96. tencentcloud/tat/v20201028/models.py +806 -0
  97. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  98. tencentcloud/tchd/v20230306/models.py +41 -0
  99. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  100. tencentcloud/tcr/v20190924/models.py +1851 -0
  101. tencentcloud/tcss/v20201101/models.py +12523 -0
  102. tencentcloud/tdid/v20210519/models.py +1258 -0
  103. tencentcloud/tdmq/v20200217/models.py +3495 -0
  104. tencentcloud/tem/v20201221/models.py +803 -0
  105. tencentcloud/tem/v20210701/models.py +2551 -1
  106. tencentcloud/teo/v20220106/models.py +4731 -0
  107. tencentcloud/teo/v20220901/models.py +6066 -0
  108. tencentcloud/tiw/v20190919/models.py +1678 -1
  109. tencentcloud/tke/v20180525/models.py +3662 -0
  110. tencentcloud/tms/v20201229/models.py +176 -0
  111. tencentcloud/tmt/v20180321/models.py +65 -0
  112. tencentcloud/trtc/v20190722/models.py +1698 -8
  113. tencentcloud/tts/v20190823/models.py +72 -0
  114. tencentcloud/vm/v20201229/models.py +568 -0
  115. tencentcloud/vm/v20210922/models.py +636 -0
  116. tencentcloud/vod/v20180717/models.py +13490 -1
  117. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  118. tencentcloud/vpc/v20170312/models.py +6622 -1
  119. tencentcloud/vpc/v20170312/vpc_client.py +23 -0
  120. tencentcloud/waf/v20180125/models.py +4814 -0
  121. tencentcloud/wedata/v20210820/models.py +12594 -0
  122. tencentcloud/yunjing/v20180228/models.py +1867 -0
  123. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/METADATA +1 -1
  124. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/RECORD +126 -126
  125. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/WHEEL +0 -0
  126. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/top_level.txt +0 -0
@@ -47,6 +47,9 @@ class ActivateSubscribeRequest(AbstractModel):
47
47
 
48
48
  @property
49
49
  def SubscribeId(self):
50
+ """Subscription instance ID.
51
+ :rtype: str
52
+ """
50
53
  return self._SubscribeId
51
54
 
52
55
  @SubscribeId.setter
@@ -55,6 +58,9 @@ class ActivateSubscribeRequest(AbstractModel):
55
58
 
56
59
  @property
57
60
  def InstanceId(self):
61
+ """Database Instance ID
62
+ :rtype: str
63
+ """
58
64
  return self._InstanceId
59
65
 
60
66
  @InstanceId.setter
@@ -63,6 +69,9 @@ class ActivateSubscribeRequest(AbstractModel):
63
69
 
64
70
  @property
65
71
  def SubscribeObjectType(self):
72
+ """Data subscription type. 0: full instance subscription, 1: data subscription, 2: structure subscription, 3: data subscription and structure subscription
73
+ :rtype: int
74
+ """
66
75
  return self._SubscribeObjectType
67
76
 
68
77
  @SubscribeObjectType.setter
@@ -71,6 +80,9 @@ class ActivateSubscribeRequest(AbstractModel):
71
80
 
72
81
  @property
73
82
  def Objects(self):
83
+ """Subscription object
84
+ :rtype: :class:`tencentcloud.dts.v20180330.models.SubscribeObject`
85
+ """
74
86
  return self._Objects
75
87
 
76
88
  @Objects.setter
@@ -79,6 +91,9 @@ class ActivateSubscribeRequest(AbstractModel):
79
91
 
80
92
  @property
81
93
  def UniqSubnetId(self):
94
+ """Subnet of data subscription service, which is the subnet of the database instance by default.
95
+ :rtype: str
96
+ """
82
97
  return self._UniqSubnetId
83
98
 
84
99
  @UniqSubnetId.setter
@@ -87,6 +102,9 @@ class ActivateSubscribeRequest(AbstractModel):
87
102
 
88
103
  @property
89
104
  def Vport(self):
105
+ """Subscription service port. Default value: 7507
106
+ :rtype: int
107
+ """
90
108
  return self._Vport
91
109
 
92
110
  @Vport.setter
@@ -130,6 +148,9 @@ class ActivateSubscribeResponse(AbstractModel):
130
148
 
131
149
  @property
132
150
  def AsyncRequestId(self):
151
+ """Data subscription configuration task ID.
152
+ :rtype: str
153
+ """
133
154
  return self._AsyncRequestId
134
155
 
135
156
  @AsyncRequestId.setter
@@ -138,6 +159,9 @@ class ActivateSubscribeResponse(AbstractModel):
138
159
 
139
160
  @property
140
161
  def RequestId(self):
162
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
163
+ :rtype: str
164
+ """
141
165
  return self._RequestId
142
166
 
143
167
  @RequestId.setter
@@ -167,6 +191,9 @@ class CompleteMigrateJobRequest(AbstractModel):
167
191
 
168
192
  @property
169
193
  def JobId(self):
194
+ """Data migration task ID
195
+ :rtype: str
196
+ """
170
197
  return self._JobId
171
198
 
172
199
  @JobId.setter
@@ -175,6 +202,9 @@ class CompleteMigrateJobRequest(AbstractModel):
175
202
 
176
203
  @property
177
204
  def CompleteMode(self):
205
+ """The way to complete the task, which is supported only for legacy MySQL migration task. waitForSync: wait for the source-replica lag to become 0 before stopping; immediately: complete immediately without waiting for source-replica sync. Default value: waitForSync
206
+ :rtype: str
207
+ """
178
208
  return self._CompleteMode
179
209
 
180
210
  @CompleteMode.setter
@@ -209,6 +239,9 @@ class CompleteMigrateJobResponse(AbstractModel):
209
239
 
210
240
  @property
211
241
  def RequestId(self):
242
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
243
+ :rtype: str
244
+ """
212
245
  return self._RequestId
213
246
 
214
247
  @RequestId.setter
@@ -240,6 +273,9 @@ class ConsistencyParams(AbstractModel):
240
273
 
241
274
  @property
242
275
  def SelectRowsPerTable(self):
276
+ """Data content check parameter, which refers to the proportion of the rows selected for data comparison in all the rows of the table. Value: an integer between 1 and 100.
277
+ :rtype: int
278
+ """
243
279
  return self._SelectRowsPerTable
244
280
 
245
281
  @SelectRowsPerTable.setter
@@ -248,6 +284,9 @@ class ConsistencyParams(AbstractModel):
248
284
 
249
285
  @property
250
286
  def TablesSelectAll(self):
287
+ """Data content check parameter, which refers to the proportion of the tables selected for data detection in all the tables. Value: an integer between 1 and 100.
288
+ :rtype: int
289
+ """
251
290
  return self._TablesSelectAll
252
291
 
253
292
  @TablesSelectAll.setter
@@ -256,6 +295,9 @@ class ConsistencyParams(AbstractModel):
256
295
 
257
296
  @property
258
297
  def TablesSelectCount(self):
298
+ """Data quantity check parameter, which checks whether the numbers of rows are identical. It refers to the proportion of the tables selected for quantity check in all the tables. Value: an integer between 1 and 100.
299
+ :rtype: int
300
+ """
259
301
  return self._TablesSelectCount
260
302
 
261
303
  @TablesSelectCount.setter
@@ -291,6 +333,9 @@ class CreateMigrateCheckJobRequest(AbstractModel):
291
333
 
292
334
  @property
293
335
  def JobId(self):
336
+ """Data migration task ID
337
+ :rtype: str
338
+ """
294
339
  return self._JobId
295
340
 
296
341
  @JobId.setter
@@ -324,6 +369,9 @@ class CreateMigrateCheckJobResponse(AbstractModel):
324
369
 
325
370
  @property
326
371
  def RequestId(self):
372
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
373
+ :rtype: str
374
+ """
327
375
  return self._RequestId
328
376
 
329
377
  @RequestId.setter
@@ -386,6 +434,9 @@ For databases with a database-schema-table structure:
386
434
 
387
435
  @property
388
436
  def JobName(self):
437
+ """Data migration task name
438
+ :rtype: str
439
+ """
389
440
  return self._JobName
390
441
 
391
442
  @JobName.setter
@@ -394,6 +445,9 @@ For databases with a database-schema-table structure:
394
445
 
395
446
  @property
396
447
  def MigrateOption(self):
448
+ """Migration task configuration options
449
+ :rtype: :class:`tencentcloud.dts.v20180330.models.MigrateOption`
450
+ """
397
451
  return self._MigrateOption
398
452
 
399
453
  @MigrateOption.setter
@@ -402,6 +456,9 @@ For databases with a database-schema-table structure:
402
456
 
403
457
  @property
404
458
  def SrcDatabaseType(self):
459
+ """Source instance database type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona, and SQL Server. For more information on the supported types in a specific region, see the migration task creation page in the console.
460
+ :rtype: str
461
+ """
405
462
  return self._SrcDatabaseType
406
463
 
407
464
  @SrcDatabaseType.setter
@@ -410,6 +467,9 @@ For databases with a database-schema-table structure:
410
467
 
411
468
  @property
412
469
  def SrcAccessType(self):
470
+ """Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance), ccn (CCN instance)
471
+ :rtype: str
472
+ """
413
473
  return self._SrcAccessType
414
474
 
415
475
  @SrcAccessType.setter
@@ -418,6 +478,9 @@ For databases with a database-schema-table structure:
418
478
 
419
479
  @property
420
480
  def SrcInfo(self):
481
+ """Source instance information, which is correlated with the migration task type
482
+ :rtype: :class:`tencentcloud.dts.v20180330.models.SrcInfo`
483
+ """
421
484
  return self._SrcInfo
422
485
 
423
486
  @SrcInfo.setter
@@ -426,6 +489,9 @@ For databases with a database-schema-table structure:
426
489
 
427
490
  @property
428
491
  def DstDatabaseType(self):
492
+ """Target instance access type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, and Percona, SQL Server, and TDSQL-C for MySQL. For more information on the supported types in a specific region, see the migration task creation page in the console.
493
+ :rtype: str
494
+ """
429
495
  return self._DstDatabaseType
430
496
 
431
497
  @DstDatabaseType.setter
@@ -434,6 +500,9 @@ For databases with a database-schema-table structure:
434
500
 
435
501
  @property
436
502
  def DstAccessType(self):
503
+ """Target instance access type, which currently only supports cdb (TencentDB instance)
504
+ :rtype: str
505
+ """
437
506
  return self._DstAccessType
438
507
 
439
508
  @DstAccessType.setter
@@ -442,6 +511,9 @@ For databases with a database-schema-table structure:
442
511
 
443
512
  @property
444
513
  def DstInfo(self):
514
+ """Destination instance information
515
+ :rtype: :class:`tencentcloud.dts.v20180330.models.DstInfo`
516
+ """
445
517
  return self._DstInfo
446
518
 
447
519
  @DstInfo.setter
@@ -450,6 +522,13 @@ For databases with a database-schema-table structure:
450
522
 
451
523
  @property
452
524
  def DatabaseInfo(self):
525
+ """Information of the source table to be migrated, which is described in JSON string format. It is required if MigrateOption.MigrateObject is 2 (migrating the specified table).
526
+ For databases with a database-table structure:
527
+ [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
528
+ For databases with a database-schema-table structure:
529
+ [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
530
+ :rtype: str
531
+ """
453
532
  return self._DatabaseInfo
454
533
 
455
534
  @DatabaseInfo.setter
@@ -458,6 +537,9 @@ For databases with a database-schema-table structure:
458
537
 
459
538
  @property
460
539
  def Tags(self):
540
+ """Tag of the instance to be migrated.
541
+ :rtype: list of TagItem
542
+ """
461
543
  return self._Tags
462
544
 
463
545
  @Tags.setter
@@ -466,6 +548,9 @@ For databases with a database-schema-table structure:
466
548
 
467
549
  @property
468
550
  def SrcNodeType(self):
551
+ """Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
552
+ :rtype: str
553
+ """
469
554
  return self._SrcNodeType
470
555
 
471
556
  @SrcNodeType.setter
@@ -474,6 +559,9 @@ For databases with a database-schema-table structure:
474
559
 
475
560
  @property
476
561
  def SrcInfoMulti(self):
562
+ """Source instance information, which is correlated with the migration task type.
563
+ :rtype: list of SrcInfo
564
+ """
477
565
  return self._SrcInfoMulti
478
566
 
479
567
  @SrcInfoMulti.setter
@@ -537,6 +625,9 @@ class CreateMigrateJobResponse(AbstractModel):
537
625
 
538
626
  @property
539
627
  def JobId(self):
628
+ """Data migration task ID
629
+ :rtype: str
630
+ """
540
631
  return self._JobId
541
632
 
542
633
  @JobId.setter
@@ -545,6 +636,9 @@ class CreateMigrateJobResponse(AbstractModel):
545
636
 
546
637
  @property
547
638
  def RequestId(self):
639
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
640
+ :rtype: str
641
+ """
548
642
  return self._RequestId
549
643
 
550
644
  @RequestId.setter
@@ -589,6 +683,9 @@ class CreateSubscribeRequest(AbstractModel):
589
683
 
590
684
  @property
591
685
  def Product(self):
686
+ """Subscribed database type. Currently, MySQL is supported
687
+ :rtype: str
688
+ """
592
689
  return self._Product
593
690
 
594
691
  @Product.setter
@@ -597,6 +694,9 @@ class CreateSubscribeRequest(AbstractModel):
597
694
 
598
695
  @property
599
696
  def PayType(self):
697
+ """Instance billing mode, which is always 1 (hourly billing),
698
+ :rtype: int
699
+ """
600
700
  return self._PayType
601
701
 
602
702
  @PayType.setter
@@ -605,6 +705,9 @@ class CreateSubscribeRequest(AbstractModel):
605
705
 
606
706
  @property
607
707
  def Duration(self):
708
+ """Purchase duration in months, which is required if `PayType` is 0. Maximum value: 120 (this field is not required of global site users and is better to be hidden)
709
+ :rtype: int
710
+ """
608
711
  return self._Duration
609
712
 
610
713
  @Duration.setter
@@ -613,6 +716,9 @@ class CreateSubscribeRequest(AbstractModel):
613
716
 
614
717
  @property
615
718
  def Count(self):
719
+ """Quantity. Default value: 1. Maximum value: 10
720
+ :rtype: int
721
+ """
616
722
  return self._Count
617
723
 
618
724
  @Count.setter
@@ -621,6 +727,9 @@ class CreateSubscribeRequest(AbstractModel):
621
727
 
622
728
  @property
623
729
  def AutoRenew(self):
730
+ """Whether to auto-renew. Default value: 0. This flag does not take effect for hourly billed instances (this field should be hidden from global site users)
731
+ :rtype: int
732
+ """
624
733
  return self._AutoRenew
625
734
 
626
735
  @AutoRenew.setter
@@ -629,6 +738,9 @@ class CreateSubscribeRequest(AbstractModel):
629
738
 
630
739
  @property
631
740
  def Tags(self):
741
+ """Instance resource tags
742
+ :rtype: list of TagItem
743
+ """
632
744
  return self._Tags
633
745
 
634
746
  @Tags.setter
@@ -637,6 +749,9 @@ class CreateSubscribeRequest(AbstractModel):
637
749
 
638
750
  @property
639
751
  def Name(self):
752
+ """A custom instance name.
753
+ :rtype: str
754
+ """
640
755
  return self._Name
641
756
 
642
757
  @Name.setter
@@ -685,6 +800,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
685
800
 
686
801
  @property
687
802
  def SubscribeIds(self):
803
+ """Data subscription instance ID array
804
+ Note: this field may return null, indicating that no valid values can be obtained.
805
+ :rtype: list of str
806
+ """
688
807
  return self._SubscribeIds
689
808
 
690
809
  @SubscribeIds.setter
@@ -693,6 +812,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
693
812
 
694
813
  @property
695
814
  def RequestId(self):
815
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
816
+ :rtype: str
817
+ """
696
818
  return self._RequestId
697
819
 
698
820
  @RequestId.setter
@@ -719,6 +841,9 @@ class DeleteMigrateJobRequest(AbstractModel):
719
841
 
720
842
  @property
721
843
  def JobId(self):
844
+ """Data migration task ID
845
+ :rtype: str
846
+ """
722
847
  return self._JobId
723
848
 
724
849
  @JobId.setter
@@ -752,6 +877,9 @@ class DeleteMigrateJobResponse(AbstractModel):
752
877
 
753
878
  @property
754
879
  def RequestId(self):
880
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
881
+ :rtype: str
882
+ """
755
883
  return self._RequestId
756
884
 
757
885
  @RequestId.setter
@@ -777,6 +905,9 @@ class DescribeAsyncRequestInfoRequest(AbstractModel):
777
905
 
778
906
  @property
779
907
  def AsyncRequestId(self):
908
+ """Task ID
909
+ :rtype: str
910
+ """
780
911
  return self._AsyncRequestId
781
912
 
782
913
  @AsyncRequestId.setter
@@ -816,6 +947,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
816
947
 
817
948
  @property
818
949
  def Info(self):
950
+ """Task execution result information
951
+ :rtype: str
952
+ """
819
953
  return self._Info
820
954
 
821
955
  @Info.setter
@@ -824,6 +958,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
824
958
 
825
959
  @property
826
960
  def Status(self):
961
+ """Task execution status. Valid values: success, failed, running
962
+ :rtype: str
963
+ """
827
964
  return self._Status
828
965
 
829
966
  @Status.setter
@@ -832,6 +969,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
832
969
 
833
970
  @property
834
971
  def RequestId(self):
972
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
973
+ :rtype: str
974
+ """
835
975
  return self._RequestId
836
976
 
837
977
  @RequestId.setter
@@ -859,6 +999,9 @@ class DescribeMigrateCheckJobRequest(AbstractModel):
859
999
 
860
1000
  @property
861
1001
  def JobId(self):
1002
+ """Data migration task ID
1003
+ :rtype: str
1004
+ """
862
1005
  return self._JobId
863
1006
 
864
1007
  @JobId.setter
@@ -907,6 +1050,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
907
1050
 
908
1051
  @property
909
1052
  def Status(self):
1053
+ """Check task status: unavailable, starting, running, finished
1054
+ :rtype: str
1055
+ """
910
1056
  return self._Status
911
1057
 
912
1058
  @Status.setter
@@ -915,6 +1061,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
915
1061
 
916
1062
  @property
917
1063
  def ErrorCode(self):
1064
+ """Task error code
1065
+ :rtype: int
1066
+ """
918
1067
  return self._ErrorCode
919
1068
 
920
1069
  @ErrorCode.setter
@@ -923,6 +1072,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
923
1072
 
924
1073
  @property
925
1074
  def ErrorMessage(self):
1075
+ """Task error message
1076
+ :rtype: str
1077
+ """
926
1078
  return self._ErrorMessage
927
1079
 
928
1080
  @ErrorMessage.setter
@@ -931,6 +1083,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
931
1083
 
932
1084
  @property
933
1085
  def Progress(self):
1086
+ """Check task progress. For example, "30" means 30% completed
1087
+ :rtype: str
1088
+ """
934
1089
  return self._Progress
935
1090
 
936
1091
  @Progress.setter
@@ -939,6 +1094,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
939
1094
 
940
1095
  @property
941
1096
  def CheckFlag(self):
1097
+ """Whether the check succeeds. 0: no; 1: yes; 3: not checked
1098
+ :rtype: int
1099
+ """
942
1100
  return self._CheckFlag
943
1101
 
944
1102
  @CheckFlag.setter
@@ -947,6 +1105,9 @@ class DescribeMigrateCheckJobResponse(AbstractModel):
947
1105
 
948
1106
  @property
949
1107
  def RequestId(self):
1108
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1109
+ :rtype: str
1110
+ """
950
1111
  return self._RequestId
951
1112
 
952
1113
  @RequestId.setter
@@ -995,6 +1156,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
995
1156
 
996
1157
  @property
997
1158
  def JobId(self):
1159
+ """Data migration task ID
1160
+ :rtype: str
1161
+ """
998
1162
  return self._JobId
999
1163
 
1000
1164
  @JobId.setter
@@ -1003,6 +1167,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1003
1167
 
1004
1168
  @property
1005
1169
  def JobName(self):
1170
+ """Data migration task name
1171
+ :rtype: str
1172
+ """
1006
1173
  return self._JobName
1007
1174
 
1008
1175
  @JobName.setter
@@ -1011,6 +1178,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1011
1178
 
1012
1179
  @property
1013
1180
  def Order(self):
1181
+ """Sort by field. Value range: JobId, Status, JobName, MigrateType, RunMode, CreateTime
1182
+ :rtype: str
1183
+ """
1014
1184
  return self._Order
1015
1185
 
1016
1186
  @Order.setter
@@ -1019,6 +1189,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1019
1189
 
1020
1190
  @property
1021
1191
  def OrderSeq(self):
1192
+ """Sorting order. Value range: ASC (ascending), DESC (descending)
1193
+ :rtype: str
1194
+ """
1022
1195
  return self._OrderSeq
1023
1196
 
1024
1197
  @OrderSeq.setter
@@ -1027,6 +1200,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1027
1200
 
1028
1201
  @property
1029
1202
  def Offset(self):
1203
+ """Offset. Default value: 0
1204
+ :rtype: int
1205
+ """
1030
1206
  return self._Offset
1031
1207
 
1032
1208
  @Offset.setter
@@ -1035,6 +1211,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1035
1211
 
1036
1212
  @property
1037
1213
  def Limit(self):
1214
+ """Number of the returned instances. Value range: [1, 100]. Default value: 20
1215
+ :rtype: int
1216
+ """
1038
1217
  return self._Limit
1039
1218
 
1040
1219
  @Limit.setter
@@ -1043,6 +1222,9 @@ class DescribeMigrateJobsRequest(AbstractModel):
1043
1222
 
1044
1223
  @property
1045
1224
  def TagFilters(self):
1225
+ """Tag filter.
1226
+ :rtype: list of TagFilter
1227
+ """
1046
1228
  return self._TagFilters
1047
1229
 
1048
1230
  @TagFilters.setter
@@ -1093,6 +1275,9 @@ class DescribeMigrateJobsResponse(AbstractModel):
1093
1275
 
1094
1276
  @property
1095
1277
  def TotalCount(self):
1278
+ """Number of tasks
1279
+ :rtype: int
1280
+ """
1096
1281
  return self._TotalCount
1097
1282
 
1098
1283
  @TotalCount.setter
@@ -1101,6 +1286,9 @@ class DescribeMigrateJobsResponse(AbstractModel):
1101
1286
 
1102
1287
  @property
1103
1288
  def JobList(self):
1289
+ """Array of task details
1290
+ :rtype: list of MigrateJobInfo
1291
+ """
1104
1292
  return self._JobList
1105
1293
 
1106
1294
  @JobList.setter
@@ -1109,6 +1297,9 @@ class DescribeMigrateJobsResponse(AbstractModel):
1109
1297
 
1110
1298
  @property
1111
1299
  def RequestId(self):
1300
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1301
+ :rtype: str
1302
+ """
1112
1303
  return self._RequestId
1113
1304
 
1114
1305
  @RequestId.setter
@@ -1153,6 +1344,9 @@ class DescribeRegionConfResponse(AbstractModel):
1153
1344
 
1154
1345
  @property
1155
1346
  def TotalCount(self):
1347
+ """Number of purchasable regions
1348
+ :rtype: int
1349
+ """
1156
1350
  return self._TotalCount
1157
1351
 
1158
1352
  @TotalCount.setter
@@ -1161,6 +1355,9 @@ class DescribeRegionConfResponse(AbstractModel):
1161
1355
 
1162
1356
  @property
1163
1357
  def Items(self):
1358
+ """Purchasable region details
1359
+ :rtype: list of SubscribeRegionConf
1360
+ """
1164
1361
  return self._Items
1165
1362
 
1166
1363
  @Items.setter
@@ -1169,6 +1366,9 @@ class DescribeRegionConfResponse(AbstractModel):
1169
1366
 
1170
1367
  @property
1171
1368
  def RequestId(self):
1369
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1370
+ :rtype: str
1371
+ """
1172
1372
  return self._RequestId
1173
1373
 
1174
1374
  @RequestId.setter
@@ -1201,6 +1401,9 @@ class DescribeSubscribeConfRequest(AbstractModel):
1201
1401
 
1202
1402
  @property
1203
1403
  def SubscribeId(self):
1404
+ """Subscription instance ID
1405
+ :rtype: str
1406
+ """
1204
1407
  return self._SubscribeId
1205
1408
 
1206
1409
  @SubscribeId.setter
@@ -1321,6 +1524,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1321
1524
 
1322
1525
  @property
1323
1526
  def SubscribeId(self):
1527
+ """Subscription instance ID
1528
+ :rtype: str
1529
+ """
1324
1530
  return self._SubscribeId
1325
1531
 
1326
1532
  @SubscribeId.setter
@@ -1329,6 +1535,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1329
1535
 
1330
1536
  @property
1331
1537
  def SubscribeName(self):
1538
+ """Subscription instance name
1539
+ :rtype: str
1540
+ """
1332
1541
  return self._SubscribeName
1333
1542
 
1334
1543
  @SubscribeName.setter
@@ -1337,6 +1546,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1337
1546
 
1338
1547
  @property
1339
1548
  def ChannelId(self):
1549
+ """Subscription channel
1550
+ :rtype: str
1551
+ """
1340
1552
  return self._ChannelId
1341
1553
 
1342
1554
  @ChannelId.setter
@@ -1345,6 +1557,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1345
1557
 
1346
1558
  @property
1347
1559
  def Product(self):
1560
+ """Subscribed database type
1561
+ :rtype: str
1562
+ """
1348
1563
  return self._Product
1349
1564
 
1350
1565
  @Product.setter
@@ -1353,6 +1568,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1353
1568
 
1354
1569
  @property
1355
1570
  def InstanceId(self):
1571
+ """Subscribed instance
1572
+ :rtype: str
1573
+ """
1356
1574
  return self._InstanceId
1357
1575
 
1358
1576
  @InstanceId.setter
@@ -1361,6 +1579,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1361
1579
 
1362
1580
  @property
1363
1581
  def InstanceStatus(self):
1582
+ """Subscribed instance status. Valid values: running, offline, isolate
1583
+ :rtype: str
1584
+ """
1364
1585
  return self._InstanceStatus
1365
1586
 
1366
1587
  @InstanceStatus.setter
@@ -1369,6 +1590,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1369
1590
 
1370
1591
  @property
1371
1592
  def SubsStatus(self):
1593
+ """Subscription instance status. Valid values: unconfigure, configuring, configured
1594
+ :rtype: str
1595
+ """
1372
1596
  return self._SubsStatus
1373
1597
 
1374
1598
  @SubsStatus.setter
@@ -1377,6 +1601,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1377
1601
 
1378
1602
  @property
1379
1603
  def Status(self):
1604
+ """Subscription instance lifecycle status. Valid values: normal, isolating, isolated, offlining
1605
+ :rtype: str
1606
+ """
1380
1607
  return self._Status
1381
1608
 
1382
1609
  @Status.setter
@@ -1385,6 +1612,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1385
1612
 
1386
1613
  @property
1387
1614
  def CreateTime(self):
1615
+ """Subscription instance creation time
1616
+ :rtype: str
1617
+ """
1388
1618
  return self._CreateTime
1389
1619
 
1390
1620
  @CreateTime.setter
@@ -1393,6 +1623,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1393
1623
 
1394
1624
  @property
1395
1625
  def IsolateTime(self):
1626
+ """Subscription instance isolation time
1627
+ :rtype: str
1628
+ """
1396
1629
  return self._IsolateTime
1397
1630
 
1398
1631
  @IsolateTime.setter
@@ -1401,6 +1634,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1401
1634
 
1402
1635
  @property
1403
1636
  def ExpireTime(self):
1637
+ """Subscription instance expiration time
1638
+ :rtype: str
1639
+ """
1404
1640
  return self._ExpireTime
1405
1641
 
1406
1642
  @ExpireTime.setter
@@ -1409,6 +1645,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1409
1645
 
1410
1646
  @property
1411
1647
  def OfflineTime(self):
1648
+ """Subscription instance deactivation time
1649
+ :rtype: str
1650
+ """
1412
1651
  return self._OfflineTime
1413
1652
 
1414
1653
  @OfflineTime.setter
@@ -1417,6 +1656,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1417
1656
 
1418
1657
  @property
1419
1658
  def ConsumeStartTime(self):
1659
+ """Consumption starting time point of subscription instance
1660
+ :rtype: str
1661
+ """
1420
1662
  return self._ConsumeStartTime
1421
1663
 
1422
1664
  @ConsumeStartTime.setter
@@ -1425,6 +1667,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1425
1667
 
1426
1668
  @property
1427
1669
  def PayType(self):
1670
+ """Subscription instance billing mode. 1: hourly billing
1671
+ :rtype: int
1672
+ """
1428
1673
  return self._PayType
1429
1674
 
1430
1675
  @PayType.setter
@@ -1433,6 +1678,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1433
1678
 
1434
1679
  @property
1435
1680
  def Vip(self):
1681
+ """Subscription channel VIP
1682
+ :rtype: str
1683
+ """
1436
1684
  return self._Vip
1437
1685
 
1438
1686
  @Vip.setter
@@ -1441,6 +1689,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1441
1689
 
1442
1690
  @property
1443
1691
  def Vport(self):
1692
+ """Subscription channel port
1693
+ :rtype: int
1694
+ """
1444
1695
  return self._Vport
1445
1696
 
1446
1697
  @Vport.setter
@@ -1449,6 +1700,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1449
1700
 
1450
1701
  @property
1451
1702
  def UniqVpcId(self):
1703
+ """Subscription channel `VpcId`
1704
+ :rtype: str
1705
+ """
1452
1706
  return self._UniqVpcId
1453
1707
 
1454
1708
  @UniqVpcId.setter
@@ -1457,6 +1711,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1457
1711
 
1458
1712
  @property
1459
1713
  def UniqSubnetId(self):
1714
+ """Subscription channel `SubnetId`
1715
+ :rtype: str
1716
+ """
1460
1717
  return self._UniqSubnetId
1461
1718
 
1462
1719
  @UniqSubnetId.setter
@@ -1465,6 +1722,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1465
1722
 
1466
1723
  @property
1467
1724
  def SdkConsumedTime(self):
1725
+ """Current SDK consumption time point
1726
+ :rtype: str
1727
+ """
1468
1728
  return self._SdkConsumedTime
1469
1729
 
1470
1730
  @SdkConsumedTime.setter
@@ -1473,6 +1733,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1473
1733
 
1474
1734
  @property
1475
1735
  def SdkHost(self):
1736
+ """Subscription SDK IP address
1737
+ :rtype: str
1738
+ """
1476
1739
  return self._SdkHost
1477
1740
 
1478
1741
  @SdkHost.setter
@@ -1481,6 +1744,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1481
1744
 
1482
1745
  @property
1483
1746
  def SubscribeObjectType(self):
1747
+ """Subscription object type. 0: full instance subscription, 1: DDL data subscription, 2: DML structure subscription, 3: DDL data subscription + DML structure subscription
1748
+ :rtype: int
1749
+ """
1484
1750
  return self._SubscribeObjectType
1485
1751
 
1486
1752
  @SubscribeObjectType.setter
@@ -1489,6 +1755,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1489
1755
 
1490
1756
  @property
1491
1757
  def SubscribeObjects(self):
1758
+ """Subscription object, which is an empty array if `SubscribeObjectType` is 0
1759
+ :rtype: list of SubscribeObject
1760
+ """
1492
1761
  return self._SubscribeObjects
1493
1762
 
1494
1763
  @SubscribeObjects.setter
@@ -1497,6 +1766,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1497
1766
 
1498
1767
  @property
1499
1768
  def ModifyTime(self):
1769
+ """Modification time
1770
+ :rtype: str
1771
+ """
1500
1772
  return self._ModifyTime
1501
1773
 
1502
1774
  @ModifyTime.setter
@@ -1505,6 +1777,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1505
1777
 
1506
1778
  @property
1507
1779
  def Region(self):
1780
+ """Region
1781
+ :rtype: str
1782
+ """
1508
1783
  return self._Region
1509
1784
 
1510
1785
  @Region.setter
@@ -1513,6 +1788,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1513
1788
 
1514
1789
  @property
1515
1790
  def Tags(self):
1791
+ """Tags of the subscription
1792
+ Note: this field may return `null`, indicating that no valid values can be obtained.
1793
+ :rtype: list of TagItem
1794
+ """
1516
1795
  return self._Tags
1517
1796
 
1518
1797
  @Tags.setter
@@ -1521,6 +1800,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1521
1800
 
1522
1801
  @property
1523
1802
  def AutoRenewFlag(self):
1803
+ """Whether auto-renewal is enabled. 0: do not enable, 1: enable
1804
+ Note: this field may return `null`, indicating that no valid values can be obtained.
1805
+ :rtype: int
1806
+ """
1524
1807
  return self._AutoRenewFlag
1525
1808
 
1526
1809
  @AutoRenewFlag.setter
@@ -1529,6 +1812,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1529
1812
 
1530
1813
  @property
1531
1814
  def SubscribeVersion(self):
1815
+ """Data subscription edition. `txdts`: Legacy edition; `kafka`: Kafka edition.
1816
+ :rtype: str
1817
+ """
1532
1818
  return self._SubscribeVersion
1533
1819
 
1534
1820
  @SubscribeVersion.setter
@@ -1537,6 +1823,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1537
1823
 
1538
1824
  @property
1539
1825
  def Errors(self):
1826
+ """Error message.
1827
+ Note: This field may return `null`, indicating that no valid values can be obtained.
1828
+ :rtype: list of SubsErr
1829
+ """
1540
1830
  return self._Errors
1541
1831
 
1542
1832
  @Errors.setter
@@ -1545,6 +1835,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
1545
1835
 
1546
1836
  @property
1547
1837
  def RequestId(self):
1838
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1839
+ :rtype: str
1840
+ """
1548
1841
  return self._RequestId
1549
1842
 
1550
1843
  @RequestId.setter
@@ -1649,6 +1942,9 @@ class DescribeSubscribesRequest(AbstractModel):
1649
1942
 
1650
1943
  @property
1651
1944
  def SubscribeId(self):
1945
+ """Data subscription instance ID
1946
+ :rtype: str
1947
+ """
1652
1948
  return self._SubscribeId
1653
1949
 
1654
1950
  @SubscribeId.setter
@@ -1657,6 +1953,9 @@ class DescribeSubscribesRequest(AbstractModel):
1657
1953
 
1658
1954
  @property
1659
1955
  def SubscribeName(self):
1956
+ """Data subscription instance name
1957
+ :rtype: str
1958
+ """
1660
1959
  return self._SubscribeName
1661
1960
 
1662
1961
  @SubscribeName.setter
@@ -1665,6 +1964,9 @@ class DescribeSubscribesRequest(AbstractModel):
1665
1964
 
1666
1965
  @property
1667
1966
  def InstanceId(self):
1967
+ """ID of bound database instance
1968
+ :rtype: str
1969
+ """
1668
1970
  return self._InstanceId
1669
1971
 
1670
1972
  @InstanceId.setter
@@ -1673,6 +1975,9 @@ class DescribeSubscribesRequest(AbstractModel):
1673
1975
 
1674
1976
  @property
1675
1977
  def ChannelId(self):
1978
+ """Data subscription instance channel ID
1979
+ :rtype: str
1980
+ """
1676
1981
  return self._ChannelId
1677
1982
 
1678
1983
  @ChannelId.setter
@@ -1681,6 +1986,9 @@ class DescribeSubscribesRequest(AbstractModel):
1681
1986
 
1682
1987
  @property
1683
1988
  def PayType(self):
1989
+ """Billing mode filter. Default value: 1 (pay-as-you-go)
1990
+ :rtype: str
1991
+ """
1684
1992
  return self._PayType
1685
1993
 
1686
1994
  @PayType.setter
@@ -1689,6 +1997,9 @@ class DescribeSubscribesRequest(AbstractModel):
1689
1997
 
1690
1998
  @property
1691
1999
  def Product(self):
2000
+ """Subscribed database product, such as MySQL
2001
+ :rtype: str
2002
+ """
1692
2003
  return self._Product
1693
2004
 
1694
2005
  @Product.setter
@@ -1697,6 +2008,9 @@ class DescribeSubscribesRequest(AbstractModel):
1697
2008
 
1698
2009
  @property
1699
2010
  def Status(self):
2011
+ """Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining
2012
+ :rtype: list of str
2013
+ """
1700
2014
  return self._Status
1701
2015
 
1702
2016
  @Status.setter
@@ -1705,6 +2019,9 @@ class DescribeSubscribesRequest(AbstractModel):
1705
2019
 
1706
2020
  @property
1707
2021
  def SubsStatus(self):
2022
+ """Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
2023
+ :rtype: list of str
2024
+ """
1708
2025
  return self._SubsStatus
1709
2026
 
1710
2027
  @SubsStatus.setter
@@ -1713,6 +2030,9 @@ class DescribeSubscribesRequest(AbstractModel):
1713
2030
 
1714
2031
  @property
1715
2032
  def Offset(self):
2033
+ """Starting offset of returned results
2034
+ :rtype: int
2035
+ """
1716
2036
  return self._Offset
1717
2037
 
1718
2038
  @Offset.setter
@@ -1721,6 +2041,9 @@ class DescribeSubscribesRequest(AbstractModel):
1721
2041
 
1722
2042
  @property
1723
2043
  def Limit(self):
2044
+ """Number of results to be returned at a time
2045
+ :rtype: int
2046
+ """
1724
2047
  return self._Limit
1725
2048
 
1726
2049
  @Limit.setter
@@ -1729,6 +2052,9 @@ class DescribeSubscribesRequest(AbstractModel):
1729
2052
 
1730
2053
  @property
1731
2054
  def OrderDirection(self):
2055
+ """Sorting order. Valid values: DESC, ASC. Default value: DESC, indicating descending by creation time
2056
+ :rtype: str
2057
+ """
1732
2058
  return self._OrderDirection
1733
2059
 
1734
2060
  @OrderDirection.setter
@@ -1737,6 +2063,9 @@ class DescribeSubscribesRequest(AbstractModel):
1737
2063
 
1738
2064
  @property
1739
2065
  def TagFilters(self):
2066
+ """Tag filtering condition
2067
+ :rtype: list of TagFilter
2068
+ """
1740
2069
  return self._TagFilters
1741
2070
 
1742
2071
  @TagFilters.setter
@@ -1745,6 +2074,9 @@ class DescribeSubscribesRequest(AbstractModel):
1745
2074
 
1746
2075
  @property
1747
2076
  def SubscribeVersion(self):
2077
+ """Subscription instance edition. `txdts`: legacy data subscription; `kafka`: data subscription in Kafka edition
2078
+ :rtype: str
2079
+ """
1748
2080
  return self._SubscribeVersion
1749
2081
 
1750
2082
  @SubscribeVersion.setter
@@ -1801,6 +2133,9 @@ class DescribeSubscribesResponse(AbstractModel):
1801
2133
 
1802
2134
  @property
1803
2135
  def TotalCount(self):
2136
+ """Number of eligible instances.
2137
+ :rtype: int
2138
+ """
1804
2139
  return self._TotalCount
1805
2140
 
1806
2141
  @TotalCount.setter
@@ -1809,6 +2144,9 @@ class DescribeSubscribesResponse(AbstractModel):
1809
2144
 
1810
2145
  @property
1811
2146
  def Items(self):
2147
+ """Information list of data subscription instances
2148
+ :rtype: list of SubscribeInfo
2149
+ """
1812
2150
  return self._Items
1813
2151
 
1814
2152
  @Items.setter
@@ -1817,6 +2155,9 @@ class DescribeSubscribesResponse(AbstractModel):
1817
2155
 
1818
2156
  @property
1819
2157
  def RequestId(self):
2158
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2159
+ :rtype: str
2160
+ """
1820
2161
  return self._RequestId
1821
2162
 
1822
2163
  @RequestId.setter
@@ -1867,6 +2208,9 @@ class DstInfo(AbstractModel):
1867
2208
 
1868
2209
  @property
1869
2210
  def InstanceId(self):
2211
+ """Target instance ID, such as cdb-jd92ijd8
2212
+ :rtype: str
2213
+ """
1870
2214
  return self._InstanceId
1871
2215
 
1872
2216
  @InstanceId.setter
@@ -1875,6 +2219,9 @@ class DstInfo(AbstractModel):
1875
2219
 
1876
2220
  @property
1877
2221
  def Region(self):
2222
+ """Target instance region, such as ap-guangzhou
2223
+ :rtype: str
2224
+ """
1878
2225
  return self._Region
1879
2226
 
1880
2227
  @Region.setter
@@ -1883,6 +2230,9 @@ class DstInfo(AbstractModel):
1883
2230
 
1884
2231
  @property
1885
2232
  def Ip(self):
2233
+ """Target instance VIP, which has been disused and does not need to be entered
2234
+ :rtype: str
2235
+ """
1886
2236
  return self._Ip
1887
2237
 
1888
2238
  @Ip.setter
@@ -1891,6 +2241,9 @@ class DstInfo(AbstractModel):
1891
2241
 
1892
2242
  @property
1893
2243
  def Port(self):
2244
+ """Target instance Vport, which has been disused and does not need to be entered
2245
+ :rtype: int
2246
+ """
1894
2247
  return self._Port
1895
2248
 
1896
2249
  @Port.setter
@@ -1899,6 +2252,9 @@ class DstInfo(AbstractModel):
1899
2252
 
1900
2253
  @property
1901
2254
  def ReadOnly(self):
2255
+ """Only valid for MySQL currently. For instance-level migration, the value range is: 1 (read-only), 0 (read/write)
2256
+ :rtype: int
2257
+ """
1902
2258
  return self._ReadOnly
1903
2259
 
1904
2260
  @ReadOnly.setter
@@ -1907,6 +2263,9 @@ class DstInfo(AbstractModel):
1907
2263
 
1908
2264
  @property
1909
2265
  def User(self):
2266
+ """Target database account
2267
+ :rtype: str
2268
+ """
1910
2269
  return self._User
1911
2270
 
1912
2271
  @User.setter
@@ -1915,6 +2274,9 @@ class DstInfo(AbstractModel):
1915
2274
 
1916
2275
  @property
1917
2276
  def Password(self):
2277
+ """Target database password
2278
+ :rtype: str
2279
+ """
1918
2280
  return self._Password
1919
2281
 
1920
2282
  @Password.setter
@@ -1957,6 +2319,9 @@ class ErrorInfo(AbstractModel):
1957
2319
 
1958
2320
  @property
1959
2321
  def ErrorLog(self):
2322
+ """Specific error log, including error code and error message
2323
+ :rtype: str
2324
+ """
1960
2325
  return self._ErrorLog
1961
2326
 
1962
2327
  @ErrorLog.setter
@@ -1965,6 +2330,9 @@ class ErrorInfo(AbstractModel):
1965
2330
 
1966
2331
  @property
1967
2332
  def HelpDoc(self):
2333
+ """Help document URL corresponding to error
2334
+ :rtype: str
2335
+ """
1968
2336
  return self._HelpDoc
1969
2337
 
1970
2338
  @HelpDoc.setter
@@ -1999,6 +2367,9 @@ class IsolateSubscribeRequest(AbstractModel):
1999
2367
 
2000
2368
  @property
2001
2369
  def SubscribeId(self):
2370
+ """Subscription instance ID
2371
+ :rtype: str
2372
+ """
2002
2373
  return self._SubscribeId
2003
2374
 
2004
2375
  @SubscribeId.setter
@@ -2032,6 +2403,9 @@ class IsolateSubscribeResponse(AbstractModel):
2032
2403
 
2033
2404
  @property
2034
2405
  def RequestId(self):
2406
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2407
+ :rtype: str
2408
+ """
2035
2409
  return self._RequestId
2036
2410
 
2037
2411
  @RequestId.setter
@@ -2075,6 +2449,9 @@ class MigrateDetailInfo(AbstractModel):
2075
2449
 
2076
2450
  @property
2077
2451
  def StepAll(self):
2452
+ """Total number of steps
2453
+ :rtype: int
2454
+ """
2078
2455
  return self._StepAll
2079
2456
 
2080
2457
  @StepAll.setter
@@ -2083,6 +2460,9 @@ class MigrateDetailInfo(AbstractModel):
2083
2460
 
2084
2461
  @property
2085
2462
  def StepNow(self):
2463
+ """Current step
2464
+ :rtype: int
2465
+ """
2086
2466
  return self._StepNow
2087
2467
 
2088
2468
  @StepNow.setter
@@ -2091,6 +2471,9 @@ class MigrateDetailInfo(AbstractModel):
2091
2471
 
2092
2472
  @property
2093
2473
  def Progress(self):
2474
+ """Overall progress, such as "10"
2475
+ :rtype: str
2476
+ """
2094
2477
  return self._Progress
2095
2478
 
2096
2479
  @Progress.setter
@@ -2099,6 +2482,9 @@ class MigrateDetailInfo(AbstractModel):
2099
2482
 
2100
2483
  @property
2101
2484
  def CurrentStepProgress(self):
2485
+ """Progress of current step, such as "1"
2486
+ :rtype: str
2487
+ """
2102
2488
  return self._CurrentStepProgress
2103
2489
 
2104
2490
  @CurrentStepProgress.setter
@@ -2107,6 +2493,9 @@ class MigrateDetailInfo(AbstractModel):
2107
2493
 
2108
2494
  @property
2109
2495
  def MasterSlaveDistance(self):
2496
+ """Master/slave lag in MB, which is valid during incremental sync and currently supported by TencentDB for Redis and MySQL
2497
+ :rtype: int
2498
+ """
2110
2499
  return self._MasterSlaveDistance
2111
2500
 
2112
2501
  @MasterSlaveDistance.setter
@@ -2115,6 +2504,9 @@ class MigrateDetailInfo(AbstractModel):
2115
2504
 
2116
2505
  @property
2117
2506
  def SecondsBehindMaster(self):
2507
+ """Master/slave lag in seconds, which is valid during incremental sync and currently supported by TencentDB for MySQL
2508
+ :rtype: int
2509
+ """
2118
2510
  return self._SecondsBehindMaster
2119
2511
 
2120
2512
  @SecondsBehindMaster.setter
@@ -2123,6 +2515,9 @@ class MigrateDetailInfo(AbstractModel):
2123
2515
 
2124
2516
  @property
2125
2517
  def StepInfo(self):
2518
+ """Step information
2519
+ :rtype: list of MigrateStepDetailInfo
2520
+ """
2126
2521
  return self._StepInfo
2127
2522
 
2128
2523
  @StepInfo.setter
@@ -2220,6 +2615,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2220
2615
 
2221
2616
  @property
2222
2617
  def JobId(self):
2618
+ """Data migration task ID
2619
+ :rtype: str
2620
+ """
2223
2621
  return self._JobId
2224
2622
 
2225
2623
  @JobId.setter
@@ -2228,6 +2626,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2228
2626
 
2229
2627
  @property
2230
2628
  def JobName(self):
2629
+ """Data migration task name
2630
+ :rtype: str
2631
+ """
2231
2632
  return self._JobName
2232
2633
 
2233
2634
  @JobName.setter
@@ -2236,6 +2637,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2236
2637
 
2237
2638
  @property
2238
2639
  def MigrateOption(self):
2640
+ """Migration task configuration options
2641
+ :rtype: :class:`tencentcloud.dts.v20180330.models.MigrateOption`
2642
+ """
2239
2643
  return self._MigrateOption
2240
2644
 
2241
2645
  @MigrateOption.setter
@@ -2244,6 +2648,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2244
2648
 
2245
2649
  @property
2246
2650
  def SrcDatabaseType(self):
2651
+ """Source instance database type: MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona
2652
+ :rtype: str
2653
+ """
2247
2654
  return self._SrcDatabaseType
2248
2655
 
2249
2656
  @SrcDatabaseType.setter
@@ -2252,6 +2659,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2252
2659
 
2253
2660
  @property
2254
2661
  def SrcAccessType(self):
2662
+ """Source instance access type. Value range: extranet (public network), cvm (CVM-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance), ccn (CCN instances)
2663
+ :rtype: str
2664
+ """
2255
2665
  return self._SrcAccessType
2256
2666
 
2257
2667
  @SrcAccessType.setter
@@ -2260,6 +2670,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2260
2670
 
2261
2671
  @property
2262
2672
  def SrcInfo(self):
2673
+ """Source instance information, which is correlated with the migration task type
2674
+ :rtype: :class:`tencentcloud.dts.v20180330.models.SrcInfo`
2675
+ """
2263
2676
  return self._SrcInfo
2264
2677
 
2265
2678
  @SrcInfo.setter
@@ -2268,6 +2681,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2268
2681
 
2269
2682
  @property
2270
2683
  def DstDatabaseType(self):
2684
+ """Target instance access type: MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona
2685
+ :rtype: str
2686
+ """
2271
2687
  return self._DstDatabaseType
2272
2688
 
2273
2689
  @DstDatabaseType.setter
@@ -2276,6 +2692,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2276
2692
 
2277
2693
  @property
2278
2694
  def DstAccessType(self):
2695
+ """Target instance access type, which currently only supports cdb (TencentDB instance)
2696
+ :rtype: str
2697
+ """
2279
2698
  return self._DstAccessType
2280
2699
 
2281
2700
  @DstAccessType.setter
@@ -2284,6 +2703,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2284
2703
 
2285
2704
  @property
2286
2705
  def DstInfo(self):
2706
+ """Target instance information
2707
+ :rtype: :class:`tencentcloud.dts.v20180330.models.DstInfo`
2708
+ """
2287
2709
  return self._DstInfo
2288
2710
 
2289
2711
  @DstInfo.setter
@@ -2292,6 +2714,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2292
2714
 
2293
2715
  @property
2294
2716
  def DatabaseInfo(self):
2717
+ """Information of the source table to be migrated. If the entire instance is to be migrated, this field should be []
2718
+ :rtype: str
2719
+ """
2295
2720
  return self._DatabaseInfo
2296
2721
 
2297
2722
  @DatabaseInfo.setter
@@ -2300,6 +2725,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2300
2725
 
2301
2726
  @property
2302
2727
  def CreateTime(self):
2728
+ """Task creation/submission time
2729
+ :rtype: str
2730
+ """
2303
2731
  return self._CreateTime
2304
2732
 
2305
2733
  @CreateTime.setter
@@ -2308,6 +2736,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2308
2736
 
2309
2737
  @property
2310
2738
  def StartTime(self):
2739
+ """Task start time
2740
+ :rtype: str
2741
+ """
2311
2742
  return self._StartTime
2312
2743
 
2313
2744
  @StartTime.setter
@@ -2316,6 +2747,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2316
2747
 
2317
2748
  @property
2318
2749
  def EndTime(self):
2750
+ """Task end time
2751
+ :rtype: str
2752
+ """
2319
2753
  return self._EndTime
2320
2754
 
2321
2755
  @EndTime.setter
@@ -2324,6 +2758,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2324
2758
 
2325
2759
  @property
2326
2760
  def Status(self):
2761
+ """Task status. Value range: 1 (Creating), 3 (Checking), 4 (CheckPass), 5 (CheckNotPass), 7 (Running), 8 (ReadyComplete), 9 (Success), 10 (Failed), 11 (Stopping), 12 (Completing)
2762
+ :rtype: int
2763
+ """
2327
2764
  return self._Status
2328
2765
 
2329
2766
  @Status.setter
@@ -2332,6 +2769,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2332
2769
 
2333
2770
  @property
2334
2771
  def Detail(self):
2772
+ """Task details
2773
+ :rtype: :class:`tencentcloud.dts.v20180330.models.MigrateDetailInfo`
2774
+ """
2335
2775
  return self._Detail
2336
2776
 
2337
2777
  @Detail.setter
@@ -2340,6 +2780,9 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2340
2780
 
2341
2781
  @property
2342
2782
  def ErrorInfo(self):
2783
+ """Prompt message for task error, which is not null or empty when an error occurs with the task
2784
+ :rtype: list of ErrorInfo
2785
+ """
2343
2786
  return self._ErrorInfo
2344
2787
 
2345
2788
  @ErrorInfo.setter
@@ -2348,6 +2791,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2348
2791
 
2349
2792
  @property
2350
2793
  def Tags(self):
2794
+ """Tag
2795
+ Note: this field may return `null`, indicating that no valid values can be obtained.
2796
+ :rtype: list of TagItem
2797
+ """
2351
2798
  return self._Tags
2352
2799
 
2353
2800
  @Tags.setter
@@ -2356,6 +2803,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
2356
2803
 
2357
2804
  @property
2358
2805
  def SrcInfoMulti(self):
2806
+ """Information of the source instance, a cluster edition instance whose access type is not `cdb`.
2807
+ Note: This field may return `null`, indicating that no valid values can be obtained.
2808
+ :rtype: list of SrcInfo
2809
+ """
2359
2810
  return self._SrcInfoMulti
2360
2811
 
2361
2812
  @SrcInfoMulti.setter
@@ -2465,6 +2916,9 @@ MySQL currently does not support configuring additional parameters.
2465
2916
 
2466
2917
  @property
2467
2918
  def RunMode(self):
2919
+ """Task operation mode. Value range: 1 (immediate execution), 2 (scheduled execution)
2920
+ :rtype: int
2921
+ """
2468
2922
  return self._RunMode
2469
2923
 
2470
2924
  @RunMode.setter
@@ -2473,6 +2927,9 @@ MySQL currently does not support configuring additional parameters.
2473
2927
 
2474
2928
  @property
2475
2929
  def ExpectTime(self):
2930
+ """Expected execution time in the format of yyyy-mm-dd hh:mm:ss. If runMode=2, this field is required
2931
+ :rtype: str
2932
+ """
2476
2933
  return self._ExpectTime
2477
2934
 
2478
2935
  @ExpectTime.setter
@@ -2481,6 +2938,9 @@ MySQL currently does not support configuring additional parameters.
2481
2938
 
2482
2939
  @property
2483
2940
  def MigrateType(self):
2941
+ """Data migration type. Value range: 1 (structural migration), 2 (full migration), 3 (full + incremental migration)
2942
+ :rtype: int
2943
+ """
2484
2944
  return self._MigrateType
2485
2945
 
2486
2946
  @MigrateType.setter
@@ -2489,6 +2949,9 @@ MySQL currently does not support configuring additional parameters.
2489
2949
 
2490
2950
  @property
2491
2951
  def MigrateObject(self):
2952
+ """Migration subject. 1: entire instance; 2: specified table
2953
+ :rtype: int
2954
+ """
2492
2955
  return self._MigrateObject
2493
2956
 
2494
2957
  @MigrateObject.setter
@@ -2497,6 +2960,9 @@ MySQL currently does not support configuring additional parameters.
2497
2960
 
2498
2961
  @property
2499
2962
  def ConsistencyType(self):
2963
+ """Parameter of spot data consistency check. 1: not configured; 2: full check; 3: spot check; 4: check inconsistent tables only; 5: no check
2964
+ :rtype: int
2965
+ """
2500
2966
  return self._ConsistencyType
2501
2967
 
2502
2968
  @ConsistencyType.setter
@@ -2505,6 +2971,9 @@ MySQL currently does not support configuring additional parameters.
2505
2971
 
2506
2972
  @property
2507
2973
  def IsOverrideRoot(self):
2974
+ """Whether to overwrite the target database with the root account of the source database. Value range: 0 (no), 1 (yes). This value should be 0 for table or structural migration
2975
+ :rtype: int
2976
+ """
2508
2977
  return self._IsOverrideRoot
2509
2978
 
2510
2979
  @IsOverrideRoot.setter
@@ -2513,6 +2982,24 @@ MySQL currently does not support configuring additional parameters.
2513
2982
 
2514
2983
  @property
2515
2984
  def ExternParams(self):
2985
+ """Additional parameters for different databases, which are described in JSON format.
2986
+ The following parameters can be defined for Redis:
2987
+ {
2988
+ "ClientOutputBufferHardLimit":512, Hard capacity limit of slave buffer (MB)
2989
+ "ClientOutputBufferSoftLimit":512, Soft capacity limit of slave buffer (MB)
2990
+ "ClientOutputBufferPersistTime":60, Soft limit duration of slave buffer (s)
2991
+ "ReplBacklogSize":512, Circular buffer capacity limit (MB)
2992
+ "ReplTimeout":120, Replication timeout period (s)
2993
+ }
2994
+ The following parameters can be defined for MongoDB:
2995
+ {
2996
+ 'SrcAuthDatabase':'admin',
2997
+ 'SrcAuthFlag': "1",
2998
+ 'SrcAuthMechanism':"SCRAM-SHA-1"
2999
+ }
3000
+ MySQL currently does not support configuring additional parameters.
3001
+ :rtype: str
3002
+ """
2516
3003
  return self._ExternParams
2517
3004
 
2518
3005
  @ExternParams.setter
@@ -2521,6 +3008,9 @@ MySQL currently does not support configuring additional parameters.
2521
3008
 
2522
3009
  @property
2523
3010
  def ConsistencyParams(self):
3011
+ """Only used for "spot data consistency check". It is required if ConsistencyType is spot check
3012
+ :rtype: :class:`tencentcloud.dts.v20180330.models.ConsistencyParams`
3013
+ """
2524
3014
  return self._ConsistencyParams
2525
3015
 
2526
3016
  @ConsistencyParams.setter
@@ -2576,6 +3066,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2576
3066
 
2577
3067
  @property
2578
3068
  def StepNo(self):
3069
+ """Step number
3070
+ :rtype: int
3071
+ """
2579
3072
  return self._StepNo
2580
3073
 
2581
3074
  @StepNo.setter
@@ -2584,6 +3077,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2584
3077
 
2585
3078
  @property
2586
3079
  def StepName(self):
3080
+ """Step name
3081
+ :rtype: str
3082
+ """
2587
3083
  return self._StepName
2588
3084
 
2589
3085
  @StepName.setter
@@ -2592,6 +3088,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2592
3088
 
2593
3089
  @property
2594
3090
  def StepId(self):
3091
+ """Step ID
3092
+ :rtype: str
3093
+ """
2595
3094
  return self._StepId
2596
3095
 
2597
3096
  @StepId.setter
@@ -2600,6 +3099,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2600
3099
 
2601
3100
  @property
2602
3101
  def Status(self):
3102
+ """Step status. Value range: 0 (default), 1 (succeeded), 2 (failed), 3 (in progress), 4 (not started)
3103
+ :rtype: int
3104
+ """
2603
3105
  return self._Status
2604
3106
 
2605
3107
  @Status.setter
@@ -2608,6 +3110,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2608
3110
 
2609
3111
  @property
2610
3112
  def StartTime(self):
3113
+ """Start time of current step in the format of `yyyy-mm-dd hh:mm:ss`. This field is meaningless if it does not exist or is empty
3114
+ Note: this field may return null, indicating that no valid values can be obtained.
3115
+ :rtype: str
3116
+ """
2611
3117
  return self._StartTime
2612
3118
 
2613
3119
  @StartTime.setter
@@ -2679,6 +3185,9 @@ This field does not need to be set when the entire instance is to be migrated
2679
3185
 
2680
3186
  @property
2681
3187
  def JobId(self):
3188
+ """ID of the data migration task to be modified
3189
+ :rtype: str
3190
+ """
2682
3191
  return self._JobId
2683
3192
 
2684
3193
  @JobId.setter
@@ -2687,6 +3196,9 @@ This field does not need to be set when the entire instance is to be migrated
2687
3196
 
2688
3197
  @property
2689
3198
  def JobName(self):
3199
+ """Data migration task name
3200
+ :rtype: str
3201
+ """
2690
3202
  return self._JobName
2691
3203
 
2692
3204
  @JobName.setter
@@ -2695,6 +3207,9 @@ This field does not need to be set when the entire instance is to be migrated
2695
3207
 
2696
3208
  @property
2697
3209
  def MigrateOption(self):
3210
+ """Migration task configuration options
3211
+ :rtype: :class:`tencentcloud.dts.v20180330.models.MigrateOption`
3212
+ """
2698
3213
  return self._MigrateOption
2699
3214
 
2700
3215
  @MigrateOption.setter
@@ -2703,6 +3218,9 @@ This field does not need to be set when the entire instance is to be migrated
2703
3218
 
2704
3219
  @property
2705
3220
  def SrcAccessType(self):
3221
+ """Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance)
3222
+ :rtype: str
3223
+ """
2706
3224
  return self._SrcAccessType
2707
3225
 
2708
3226
  @SrcAccessType.setter
@@ -2711,6 +3229,9 @@ This field does not need to be set when the entire instance is to be migrated
2711
3229
 
2712
3230
  @property
2713
3231
  def SrcInfo(self):
3232
+ """Source instance information, which is correlated with the migration task type
3233
+ :rtype: :class:`tencentcloud.dts.v20180330.models.SrcInfo`
3234
+ """
2714
3235
  return self._SrcInfo
2715
3236
 
2716
3237
  @SrcInfo.setter
@@ -2719,6 +3240,9 @@ This field does not need to be set when the entire instance is to be migrated
2719
3240
 
2720
3241
  @property
2721
3242
  def DstAccessType(self):
3243
+ """Target instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance). Currently, only `cdb` is supported
3244
+ :rtype: str
3245
+ """
2722
3246
  return self._DstAccessType
2723
3247
 
2724
3248
  @DstAccessType.setter
@@ -2727,6 +3251,9 @@ This field does not need to be set when the entire instance is to be migrated
2727
3251
 
2728
3252
  @property
2729
3253
  def DstInfo(self):
3254
+ """Target instance information. The region where the target instance is located cannot be modified.
3255
+ :rtype: :class:`tencentcloud.dts.v20180330.models.DstInfo`
3256
+ """
2730
3257
  return self._DstInfo
2731
3258
 
2732
3259
  @DstInfo.setter
@@ -2735,6 +3262,16 @@ This field does not need to be set when the entire instance is to be migrated
2735
3262
 
2736
3263
  @property
2737
3264
  def DatabaseInfo(self):
3265
+ """When migrating the specified table, you need to set the information of the source database table to be migrated, which should be described in JSON string format. Below are examples.
3266
+
3267
+ For databases with a database-table structure:
3268
+ [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
3269
+ For databases with a database-schema-table structure:
3270
+ [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
3271
+
3272
+ This field does not need to be set when the entire instance is to be migrated
3273
+ :rtype: str
3274
+ """
2738
3275
  return self._DatabaseInfo
2739
3276
 
2740
3277
  @DatabaseInfo.setter
@@ -2743,6 +3280,9 @@ This field does not need to be set when the entire instance is to be migrated
2743
3280
 
2744
3281
  @property
2745
3282
  def SrcNodeType(self):
3283
+ """Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
3284
+ :rtype: str
3285
+ """
2746
3286
  return self._SrcNodeType
2747
3287
 
2748
3288
  @SrcNodeType.setter
@@ -2751,6 +3291,9 @@ This field does not need to be set when the entire instance is to be migrated
2751
3291
 
2752
3292
  @property
2753
3293
  def SrcInfoMulti(self):
3294
+ """Source instance information, which is correlated with the migration task type.
3295
+ :rtype: list of SrcInfo
3296
+ """
2754
3297
  return self._SrcInfoMulti
2755
3298
 
2756
3299
  @SrcInfoMulti.setter
@@ -2804,6 +3347,9 @@ class ModifyMigrateJobResponse(AbstractModel):
2804
3347
 
2805
3348
  @property
2806
3349
  def RequestId(self):
3350
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3351
+ :rtype: str
3352
+ """
2807
3353
  return self._RequestId
2808
3354
 
2809
3355
  @RequestId.setter
@@ -2832,6 +3378,9 @@ class ModifySubscribeConsumeTimeRequest(AbstractModel):
2832
3378
 
2833
3379
  @property
2834
3380
  def SubscribeId(self):
3381
+ """Data subscription instance ID
3382
+ :rtype: str
3383
+ """
2835
3384
  return self._SubscribeId
2836
3385
 
2837
3386
  @SubscribeId.setter
@@ -2840,6 +3389,9 @@ class ModifySubscribeConsumeTimeRequest(AbstractModel):
2840
3389
 
2841
3390
  @property
2842
3391
  def ConsumeStartTime(self):
3392
+ """Consumption starting time point in the format of `Y-m-d h:m:s`, i.e., the starting time point for data subscription. Value range: within the last 24 hours
3393
+ :rtype: str
3394
+ """
2843
3395
  return self._ConsumeStartTime
2844
3396
 
2845
3397
  @ConsumeStartTime.setter
@@ -2874,6 +3426,9 @@ class ModifySubscribeConsumeTimeResponse(AbstractModel):
2874
3426
 
2875
3427
  @property
2876
3428
  def RequestId(self):
3429
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3430
+ :rtype: str
3431
+ """
2877
3432
  return self._RequestId
2878
3433
 
2879
3434
  @RequestId.setter
@@ -2902,6 +3457,9 @@ class ModifySubscribeNameRequest(AbstractModel):
2902
3457
 
2903
3458
  @property
2904
3459
  def SubscribeId(self):
3460
+ """Data subscription instance ID
3461
+ :rtype: str
3462
+ """
2905
3463
  return self._SubscribeId
2906
3464
 
2907
3465
  @SubscribeId.setter
@@ -2910,6 +3468,9 @@ class ModifySubscribeNameRequest(AbstractModel):
2910
3468
 
2911
3469
  @property
2912
3470
  def SubscribeName(self):
3471
+ """Data subscription instance name. Length limit: [1,60]
3472
+ :rtype: str
3473
+ """
2913
3474
  return self._SubscribeName
2914
3475
 
2915
3476
  @SubscribeName.setter
@@ -2944,6 +3505,9 @@ class ModifySubscribeNameResponse(AbstractModel):
2944
3505
 
2945
3506
  @property
2946
3507
  def RequestId(self):
3508
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3509
+ :rtype: str
3510
+ """
2947
3511
  return self._RequestId
2948
3512
 
2949
3513
  @RequestId.setter
@@ -2975,6 +3539,9 @@ class ModifySubscribeObjectsRequest(AbstractModel):
2975
3539
 
2976
3540
  @property
2977
3541
  def SubscribeId(self):
3542
+ """Data subscription instance ID
3543
+ :rtype: str
3544
+ """
2978
3545
  return self._SubscribeId
2979
3546
 
2980
3547
  @SubscribeId.setter
@@ -2983,6 +3550,9 @@ class ModifySubscribeObjectsRequest(AbstractModel):
2983
3550
 
2984
3551
  @property
2985
3552
  def SubscribeObjectType(self):
3553
+ """Data subscription type. Valid values: 0 (full instance subscription), 1 (data subscription), 2 (structure subscription), 3 (data subscription + structure subscription)
3554
+ :rtype: int
3555
+ """
2986
3556
  return self._SubscribeObjectType
2987
3557
 
2988
3558
  @SubscribeObjectType.setter
@@ -2991,6 +3561,9 @@ class ModifySubscribeObjectsRequest(AbstractModel):
2991
3561
 
2992
3562
  @property
2993
3563
  def Objects(self):
3564
+ """Information of subscribed table
3565
+ :rtype: list of SubscribeObject
3566
+ """
2994
3567
  return self._Objects
2995
3568
 
2996
3569
  @Objects.setter
@@ -3034,6 +3607,9 @@ class ModifySubscribeObjectsResponse(AbstractModel):
3034
3607
 
3035
3608
  @property
3036
3609
  def AsyncRequestId(self):
3610
+ """Async task ID
3611
+ :rtype: str
3612
+ """
3037
3613
  return self._AsyncRequestId
3038
3614
 
3039
3615
  @AsyncRequestId.setter
@@ -3042,6 +3618,9 @@ class ModifySubscribeObjectsResponse(AbstractModel):
3042
3618
 
3043
3619
  @property
3044
3620
  def RequestId(self):
3621
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3622
+ :rtype: str
3623
+ """
3045
3624
  return self._RequestId
3046
3625
 
3047
3626
  @RequestId.setter
@@ -3077,6 +3656,9 @@ class ModifySubscribeVipVportRequest(AbstractModel):
3077
3656
 
3078
3657
  @property
3079
3658
  def SubscribeId(self):
3659
+ """Data subscription instance ID
3660
+ :rtype: str
3661
+ """
3080
3662
  return self._SubscribeId
3081
3663
 
3082
3664
  @SubscribeId.setter
@@ -3085,6 +3667,9 @@ class ModifySubscribeVipVportRequest(AbstractModel):
3085
3667
 
3086
3668
  @property
3087
3669
  def DstUniqSubnetId(self):
3670
+ """Specified destination subnet. If this parameter is passed in, `DstIp` must be in the destination subnet
3671
+ :rtype: str
3672
+ """
3088
3673
  return self._DstUniqSubnetId
3089
3674
 
3090
3675
  @DstUniqSubnetId.setter
@@ -3093,6 +3678,9 @@ class ModifySubscribeVipVportRequest(AbstractModel):
3093
3678
 
3094
3679
  @property
3095
3680
  def DstIp(self):
3681
+ """Target IP. Either this field or `DstPort` must be passed in
3682
+ :rtype: str
3683
+ """
3096
3684
  return self._DstIp
3097
3685
 
3098
3686
  @DstIp.setter
@@ -3101,6 +3689,9 @@ class ModifySubscribeVipVportRequest(AbstractModel):
3101
3689
 
3102
3690
  @property
3103
3691
  def DstPort(self):
3692
+ """Target port. Value range: [1025-65535]
3693
+ :rtype: int
3694
+ """
3104
3695
  return self._DstPort
3105
3696
 
3106
3697
  @DstPort.setter
@@ -3137,6 +3728,9 @@ class ModifySubscribeVipVportResponse(AbstractModel):
3137
3728
 
3138
3729
  @property
3139
3730
  def RequestId(self):
3731
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3732
+ :rtype: str
3733
+ """
3140
3734
  return self._RequestId
3141
3735
 
3142
3736
  @RequestId.setter
@@ -3162,6 +3756,9 @@ class OfflineIsolatedSubscribeRequest(AbstractModel):
3162
3756
 
3163
3757
  @property
3164
3758
  def SubscribeId(self):
3759
+ """Data subscription instance ID
3760
+ :rtype: str
3761
+ """
3165
3762
  return self._SubscribeId
3166
3763
 
3167
3764
  @SubscribeId.setter
@@ -3195,6 +3792,9 @@ class OfflineIsolatedSubscribeResponse(AbstractModel):
3195
3792
 
3196
3793
  @property
3197
3794
  def RequestId(self):
3795
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3796
+ :rtype: str
3797
+ """
3198
3798
  return self._RequestId
3199
3799
 
3200
3800
  @RequestId.setter
@@ -3220,6 +3820,9 @@ class ResetSubscribeRequest(AbstractModel):
3220
3820
 
3221
3821
  @property
3222
3822
  def SubscribeId(self):
3823
+ """Data subscription instance ID
3824
+ :rtype: str
3825
+ """
3223
3826
  return self._SubscribeId
3224
3827
 
3225
3828
  @SubscribeId.setter
@@ -3253,6 +3856,9 @@ class ResetSubscribeResponse(AbstractModel):
3253
3856
 
3254
3857
  @property
3255
3858
  def RequestId(self):
3859
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3860
+ :rtype: str
3861
+ """
3256
3862
  return self._RequestId
3257
3863
 
3258
3864
  @RequestId.setter
@@ -3324,6 +3930,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3324
3930
 
3325
3931
  @property
3326
3932
  def AccessKey(self):
3933
+ """Alibaba Cloud AccessKey, which is applicable if the source database is an Alibaba Cloud ApsaraDB for RDS 5.6 instance
3934
+ :rtype: str
3935
+ """
3327
3936
  return self._AccessKey
3328
3937
 
3329
3938
  @AccessKey.setter
@@ -3332,6 +3941,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3332
3941
 
3333
3942
  @property
3334
3943
  def Ip(self):
3944
+ """Instance IP address
3945
+ :rtype: str
3946
+ """
3335
3947
  return self._Ip
3336
3948
 
3337
3949
  @Ip.setter
@@ -3340,6 +3952,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3340
3952
 
3341
3953
  @property
3342
3954
  def Port(self):
3955
+ """Instance port
3956
+ :rtype: int
3957
+ """
3343
3958
  return self._Port
3344
3959
 
3345
3960
  @Port.setter
@@ -3348,6 +3963,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3348
3963
 
3349
3964
  @property
3350
3965
  def User(self):
3966
+ """Instance username
3967
+ :rtype: str
3968
+ """
3351
3969
  return self._User
3352
3970
 
3353
3971
  @User.setter
@@ -3356,6 +3974,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3356
3974
 
3357
3975
  @property
3358
3976
  def Password(self):
3977
+ """Instance password
3978
+ :rtype: str
3979
+ """
3359
3980
  return self._Password
3360
3981
 
3361
3982
  @Password.setter
@@ -3364,6 +3985,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3364
3985
 
3365
3986
  @property
3366
3987
  def RdsInstanceId(self):
3988
+ """Alibaba Cloud ApsaraDB for RDS instance ID, which is applicable if the source database is an Alibaba Cloud ApsaraDB for RDS 5.6/5.7 instance
3989
+ :rtype: str
3990
+ """
3367
3991
  return self._RdsInstanceId
3368
3992
 
3369
3993
  @RdsInstanceId.setter
@@ -3372,6 +3996,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3372
3996
 
3373
3997
  @property
3374
3998
  def CvmInstanceId(self):
3999
+ """Short CVM instance ID in the format of `ins-olgl39y8`. It is the same as the instance ID displayed on the CVM Console page. For CVM-based self-created instances, this field needs to be passed in
4000
+ :rtype: str
4001
+ """
3375
4002
  return self._CvmInstanceId
3376
4003
 
3377
4004
  @CvmInstanceId.setter
@@ -3380,6 +4007,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3380
4007
 
3381
4008
  @property
3382
4009
  def UniqDcgId(self):
4010
+ """Direct Connect gateway ID in the format of dcg-0rxtqqxb
4011
+ :rtype: str
4012
+ """
3383
4013
  return self._UniqDcgId
3384
4014
 
3385
4015
  @UniqDcgId.setter
@@ -3388,6 +4018,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3388
4018
 
3389
4019
  @property
3390
4020
  def VpcId(self):
4021
+ """VPC ID in the format of vpc-92jblxto
4022
+ :rtype: str
4023
+ """
3391
4024
  return self._VpcId
3392
4025
 
3393
4026
  @VpcId.setter
@@ -3396,6 +4029,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3396
4029
 
3397
4030
  @property
3398
4031
  def SubnetId(self):
4032
+ """VPC Subnet ID in the format of subnet-3paxmkdz
4033
+ :rtype: str
4034
+ """
3399
4035
  return self._SubnetId
3400
4036
 
3401
4037
  @SubnetId.setter
@@ -3404,6 +4040,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3404
4040
 
3405
4041
  @property
3406
4042
  def UniqVpnGwId(self):
4043
+ """VPN gateway ID in the format of vpngw-9ghexg7q
4044
+ :rtype: str
4045
+ """
3407
4046
  return self._UniqVpnGwId
3408
4047
 
3409
4048
  @UniqVpnGwId.setter
@@ -3412,6 +4051,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3412
4051
 
3413
4052
  @property
3414
4053
  def InstanceId(self):
4054
+ """Database instance ID in the format of cdb-powiqx8q
4055
+ :rtype: str
4056
+ """
3415
4057
  return self._InstanceId
3416
4058
 
3417
4059
  @InstanceId.setter
@@ -3420,6 +4062,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3420
4062
 
3421
4063
  @property
3422
4064
  def Region(self):
4065
+ """Region name, such as ap-guangzhou
4066
+ :rtype: str
4067
+ """
3423
4068
  return self._Region
3424
4069
 
3425
4070
  @Region.setter
@@ -3428,6 +4073,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3428
4073
 
3429
4074
  @property
3430
4075
  def Supplier(self):
4076
+ """For Alibaba Cloud ApsaraDB for RDS instances, enter "aliyun"; otherwise, enter "others"
4077
+ :rtype: str
4078
+ """
3431
4079
  return self._Supplier
3432
4080
 
3433
4081
  @Supplier.setter
@@ -3436,6 +4084,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
3436
4084
 
3437
4085
  @property
3438
4086
  def CcnId(self):
4087
+ """CCN instance ID, such as ccn-afp6kltc
4088
+ Note: This field may return null, indicating that no valid values can be obtained.
4089
+ :rtype: str
4090
+ """
3439
4091
  return self._CcnId
3440
4092
 
3441
4093
  @CcnId.setter
@@ -3444,6 +4096,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3444
4096
 
3445
4097
  @property
3446
4098
  def EngineVersion(self):
4099
+ """Database version. This parameter is valid only when the instance is an RDS instance. Value: 5.6 or 5.7. Default value: 5.6
4100
+ :rtype: str
4101
+ """
3447
4102
  return self._EngineVersion
3448
4103
 
3449
4104
  @EngineVersion.setter
@@ -3492,6 +4147,9 @@ class StartMigrateJobRequest(AbstractModel):
3492
4147
 
3493
4148
  @property
3494
4149
  def JobId(self):
4150
+ """Data migration task ID
4151
+ :rtype: str
4152
+ """
3495
4153
  return self._JobId
3496
4154
 
3497
4155
  @JobId.setter
@@ -3525,6 +4183,9 @@ class StartMigrateJobResponse(AbstractModel):
3525
4183
 
3526
4184
  @property
3527
4185
  def RequestId(self):
4186
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4187
+ :rtype: str
4188
+ """
3528
4189
  return self._RequestId
3529
4190
 
3530
4191
  @RequestId.setter
@@ -3550,6 +4211,9 @@ class StopMigrateJobRequest(AbstractModel):
3550
4211
 
3551
4212
  @property
3552
4213
  def JobId(self):
4214
+ """Data migration task ID
4215
+ :rtype: str
4216
+ """
3553
4217
  return self._JobId
3554
4218
 
3555
4219
  @JobId.setter
@@ -3583,6 +4247,9 @@ class StopMigrateJobResponse(AbstractModel):
3583
4247
 
3584
4248
  @property
3585
4249
  def RequestId(self):
4250
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4251
+ :rtype: str
4252
+ """
3586
4253
  return self._RequestId
3587
4254
 
3588
4255
  @RequestId.setter
@@ -3609,6 +4276,10 @@ Note: This field may return `null`, indicating that no valid values can be obtai
3609
4276
 
3610
4277
  @property
3611
4278
  def Message(self):
4279
+ """Error message.
4280
+ Note: This field may return `null`, indicating that no valid values can be obtained.
4281
+ :rtype: str
4282
+ """
3612
4283
  return self._Message
3613
4284
 
3614
4285
  @Message.setter
@@ -3714,6 +4385,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3714
4385
 
3715
4386
  @property
3716
4387
  def SubscribeId(self):
4388
+ """Data subscription instance ID
4389
+ :rtype: str
4390
+ """
3717
4391
  return self._SubscribeId
3718
4392
 
3719
4393
  @SubscribeId.setter
@@ -3722,6 +4396,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3722
4396
 
3723
4397
  @property
3724
4398
  def SubscribeName(self):
4399
+ """Data subscription instance name
4400
+ :rtype: str
4401
+ """
3725
4402
  return self._SubscribeName
3726
4403
 
3727
4404
  @SubscribeName.setter
@@ -3730,6 +4407,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3730
4407
 
3731
4408
  @property
3732
4409
  def ChannelId(self):
4410
+ """ID of channel bound to data subscription instance
4411
+ :rtype: str
4412
+ """
3733
4413
  return self._ChannelId
3734
4414
 
3735
4415
  @ChannelId.setter
@@ -3738,6 +4418,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3738
4418
 
3739
4419
  @property
3740
4420
  def Product(self):
4421
+ """Name of product bound to data subscription instance
4422
+ :rtype: str
4423
+ """
3741
4424
  return self._Product
3742
4425
 
3743
4426
  @Product.setter
@@ -3746,6 +4429,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3746
4429
 
3747
4430
  @property
3748
4431
  def InstanceId(self):
4432
+ """ID of database instance bound to data subscription instance
4433
+ :rtype: str
4434
+ """
3749
4435
  return self._InstanceId
3750
4436
 
3751
4437
  @InstanceId.setter
@@ -3754,6 +4440,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3754
4440
 
3755
4441
  @property
3756
4442
  def InstanceStatus(self):
4443
+ """Status of database instance bound to data subscription instance
4444
+ :rtype: str
4445
+ """
3757
4446
  return self._InstanceStatus
3758
4447
 
3759
4448
  @InstanceStatus.setter
@@ -3762,6 +4451,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3762
4451
 
3763
4452
  @property
3764
4453
  def SubsStatus(self):
4454
+ """Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
4455
+ :rtype: str
4456
+ """
3765
4457
  return self._SubsStatus
3766
4458
 
3767
4459
  @SubsStatus.setter
@@ -3770,6 +4462,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3770
4462
 
3771
4463
  @property
3772
4464
  def ModifyTime(self):
4465
+ """Last modified time
4466
+ :rtype: str
4467
+ """
3773
4468
  return self._ModifyTime
3774
4469
 
3775
4470
  @ModifyTime.setter
@@ -3778,6 +4473,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3778
4473
 
3779
4474
  @property
3780
4475
  def CreateTime(self):
4476
+ """Creation time
4477
+ :rtype: str
4478
+ """
3781
4479
  return self._CreateTime
3782
4480
 
3783
4481
  @CreateTime.setter
@@ -3786,6 +4484,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3786
4484
 
3787
4485
  @property
3788
4486
  def IsolateTime(self):
4487
+ """Isolation time
4488
+ :rtype: str
4489
+ """
3789
4490
  return self._IsolateTime
3790
4491
 
3791
4492
  @IsolateTime.setter
@@ -3794,6 +4495,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3794
4495
 
3795
4496
  @property
3796
4497
  def ExpireTime(self):
4498
+ """Expiration time
4499
+ :rtype: str
4500
+ """
3797
4501
  return self._ExpireTime
3798
4502
 
3799
4503
  @ExpireTime.setter
@@ -3802,6 +4506,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3802
4506
 
3803
4507
  @property
3804
4508
  def OfflineTime(self):
4509
+ """Deactivation time
4510
+ :rtype: str
4511
+ """
3805
4512
  return self._OfflineTime
3806
4513
 
3807
4514
  @OfflineTime.setter
@@ -3810,6 +4517,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3810
4517
 
3811
4518
  @property
3812
4519
  def ConsumeStartTime(self):
4520
+ """Last modified consumption starting time point. If it has never been modified, this field is 0
4521
+ :rtype: str
4522
+ """
3813
4523
  return self._ConsumeStartTime
3814
4524
 
3815
4525
  @ConsumeStartTime.setter
@@ -3818,6 +4528,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3818
4528
 
3819
4529
  @property
3820
4530
  def Region(self):
4531
+ """Data subscription instance region
4532
+ :rtype: str
4533
+ """
3821
4534
  return self._Region
3822
4535
 
3823
4536
  @Region.setter
@@ -3826,6 +4539,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3826
4539
 
3827
4540
  @property
3828
4541
  def PayType(self):
4542
+ """Billing mode. 1: pay-as-you-go
4543
+ :rtype: int
4544
+ """
3829
4545
  return self._PayType
3830
4546
 
3831
4547
  @PayType.setter
@@ -3834,6 +4550,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3834
4550
 
3835
4551
  @property
3836
4552
  def Vip(self):
4553
+ """Data subscription instance VIP
4554
+ :rtype: str
4555
+ """
3837
4556
  return self._Vip
3838
4557
 
3839
4558
  @Vip.setter
@@ -3842,6 +4561,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3842
4561
 
3843
4562
  @property
3844
4563
  def Vport(self):
4564
+ """Data subscription instance Vport
4565
+ :rtype: int
4566
+ """
3845
4567
  return self._Vport
3846
4568
 
3847
4569
  @Vport.setter
@@ -3850,6 +4572,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3850
4572
 
3851
4573
  @property
3852
4574
  def UniqVpcId(self):
4575
+ """Unique ID of the VPC where the data subscription instance VIP resides
4576
+ :rtype: str
4577
+ """
3853
4578
  return self._UniqVpcId
3854
4579
 
3855
4580
  @UniqVpcId.setter
@@ -3858,6 +4583,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3858
4583
 
3859
4584
  @property
3860
4585
  def UniqSubnetId(self):
4586
+ """Unique ID of the subnet where the data subscription instance VIP resides
4587
+ :rtype: str
4588
+ """
3861
4589
  return self._UniqSubnetId
3862
4590
 
3863
4591
  @UniqSubnetId.setter
@@ -3866,6 +4594,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3866
4594
 
3867
4595
  @property
3868
4596
  def Status(self):
4597
+ """Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining, offline
4598
+ :rtype: str
4599
+ """
3869
4600
  return self._Status
3870
4601
 
3871
4602
  @Status.setter
@@ -3874,6 +4605,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3874
4605
 
3875
4606
  @property
3876
4607
  def SdkConsumedTime(self):
4608
+ """Timestamp of the last message confirmed by the SDK. If the SDK keeps consuming, this field can also be used as the current consumption time point of the SDK
4609
+ :rtype: str
4610
+ """
3877
4611
  return self._SdkConsumedTime
3878
4612
 
3879
4613
  @SdkConsumedTime.setter
@@ -3882,6 +4616,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3882
4616
 
3883
4617
  @property
3884
4618
  def Tags(self):
4619
+ """Tag
4620
+ Note: this field may return `null`, indicating that no valid values can be obtained.
4621
+ :rtype: list of TagItem
4622
+ """
3885
4623
  return self._Tags
3886
4624
 
3887
4625
  @Tags.setter
@@ -3890,6 +4628,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3890
4628
 
3891
4629
  @property
3892
4630
  def AutoRenewFlag(self):
4631
+ """Whether auto-renewal is enabled. 0: do not enable; 1: enable
4632
+ Note: this field may return `null`, indicating that no valid values can be obtained.
4633
+ :rtype: int
4634
+ """
3893
4635
  return self._AutoRenewFlag
3894
4636
 
3895
4637
  @AutoRenewFlag.setter
@@ -3898,6 +4640,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
3898
4640
 
3899
4641
  @property
3900
4642
  def SubscribeVersion(self):
4643
+ """Subscription instance edition. ·`txdts`: legacy data subscription; `kafka`: data subscription in Kafka edition
4644
+ Note: this field may return `null`, indicating that no valid values can be obtained.
4645
+ :rtype: str
4646
+ """
3901
4647
  return self._SubscribeVersion
3902
4648
 
3903
4649
  @SubscribeVersion.setter
@@ -3968,6 +4714,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3968
4714
 
3969
4715
  @property
3970
4716
  def ObjectsType(self):
4717
+ """Data subscription object type. 0: database, 1: database table
4718
+ Note: this field may return null, indicating that no valid values can be obtained.
4719
+ :rtype: int
4720
+ """
3971
4721
  return self._ObjectsType
3972
4722
 
3973
4723
  @ObjectsType.setter
@@ -3976,6 +4726,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3976
4726
 
3977
4727
  @property
3978
4728
  def DatabaseName(self):
4729
+ """Name of subscribed database
4730
+ Note: this field may return null, indicating that no valid values can be obtained.
4731
+ :rtype: str
4732
+ """
3979
4733
  return self._DatabaseName
3980
4734
 
3981
4735
  @DatabaseName.setter
@@ -3984,6 +4738,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3984
4738
 
3985
4739
  @property
3986
4740
  def TableNames(self):
4741
+ """Array of table names in subscribed database
4742
+ Note: this field may return null, indicating that no valid values can be obtained.
4743
+ :rtype: list of str
4744
+ """
3987
4745
  return self._TableNames
3988
4746
 
3989
4747
  @TableNames.setter
@@ -4036,6 +4794,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4036
4794
 
4037
4795
  @property
4038
4796
  def RegionName(self):
4797
+ """Region name, such as Guangzhou
4798
+ Note: this field may return null, indicating that no valid values can be obtained.
4799
+ :rtype: str
4800
+ """
4039
4801
  return self._RegionName
4040
4802
 
4041
4803
  @RegionName.setter
@@ -4044,6 +4806,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4044
4806
 
4045
4807
  @property
4046
4808
  def Region(self):
4809
+ """Region ID, such as ap-guangzhou
4810
+ Note: this field may return null, indicating that no valid values can be obtained.
4811
+ :rtype: str
4812
+ """
4047
4813
  return self._Region
4048
4814
 
4049
4815
  @Region.setter
@@ -4052,6 +4818,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4052
4818
 
4053
4819
  @property
4054
4820
  def Area(self):
4821
+ """Region name, such as South China
4822
+ Note: this field may return null, indicating that no valid values can be obtained.
4823
+ :rtype: str
4824
+ """
4055
4825
  return self._Area
4056
4826
 
4057
4827
  @Area.setter
@@ -4060,6 +4830,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4060
4830
 
4061
4831
  @property
4062
4832
  def IsDefaultRegion(self):
4833
+ """Whether it is the default region. 0: no, 1: yes
4834
+ Note: this field may return null, indicating that no valid values can be obtained.
4835
+ :rtype: int
4836
+ """
4063
4837
  return self._IsDefaultRegion
4064
4838
 
4065
4839
  @IsDefaultRegion.setter
@@ -4068,6 +4842,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4068
4842
 
4069
4843
  @property
4070
4844
  def Status(self):
4845
+ """Purchasable status of current region. 1: normal, 2: beta test, 3: not purchasable
4846
+ Note: this field may return null, indicating that no valid values can be obtained.
4847
+ :rtype: int
4848
+ """
4071
4849
  return self._Status
4072
4850
 
4073
4851
  @Status.setter
@@ -4108,6 +4886,9 @@ class TagFilter(AbstractModel):
4108
4886
 
4109
4887
  @property
4110
4888
  def TagKey(self):
4889
+ """Tag key value
4890
+ :rtype: str
4891
+ """
4111
4892
  return self._TagKey
4112
4893
 
4113
4894
  @TagKey.setter
@@ -4116,6 +4897,9 @@ class TagFilter(AbstractModel):
4116
4897
 
4117
4898
  @property
4118
4899
  def TagValue(self):
4900
+ """Tag value
4901
+ :rtype: list of str
4902
+ """
4119
4903
  return self._TagValue
4120
4904
 
4121
4905
  @TagValue.setter
@@ -4154,6 +4938,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
4154
4938
 
4155
4939
  @property
4156
4940
  def TagKey(self):
4941
+ """Tag key value
4942
+ :rtype: str
4943
+ """
4157
4944
  return self._TagKey
4158
4945
 
4159
4946
  @TagKey.setter
@@ -4162,6 +4949,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
4162
4949
 
4163
4950
  @property
4164
4951
  def TagValue(self):
4952
+ """Tag value
4953
+ Note: this field may return `null`, indicating that no valid values can be obtained.
4954
+ :rtype: str
4955
+ """
4165
4956
  return self._TagValue
4166
4957
 
4167
4958
  @TagValue.setter