tccli 3.0.1391.1__py2.py3-none-any.whl → 3.0.1414.1__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 tccli might be problematic. Click here for more details.

Files changed (226) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +2 -1
  3. tccli/services/ai3d/v20250513/api.json +22 -4
  4. tccli/services/aiart/aiart_client.py +173 -67
  5. tccli/services/aiart/v20221229/api.json +193 -0
  6. tccli/services/aiart/v20221229/examples.json +16 -0
  7. tccli/services/apm/apm_client.py +53 -0
  8. tccli/services/apm/v20210622/api.json +354 -0
  9. tccli/services/apm/v20210622/examples.json +8 -0
  10. tccli/services/asr/v20190614/api.json +3 -3
  11. tccli/services/autoscaling/v20180419/api.json +24 -2
  12. tccli/services/batch/v20170312/api.json +1 -1
  13. tccli/services/bda/bda_client.py +15 -704
  14. tccli/services/bda/v20200324/api.json +107 -1819
  15. tccli/services/bda/v20200324/examples.json +0 -176
  16. tccli/services/billing/billing_client.py +326 -8
  17. tccli/services/billing/v20180709/api.json +2200 -255
  18. tccli/services/billing/v20180709/examples.json +48 -0
  19. tccli/services/cam/v20190116/api.json +4 -4
  20. tccli/services/captcha/v20190722/api.json +3 -3
  21. tccli/services/cat/v20180409/api.json +7 -7
  22. tccli/services/ccc/ccc_client.py +235 -76
  23. tccli/services/ccc/v20200210/api.json +502 -18
  24. tccli/services/ccc/v20200210/examples.json +24 -0
  25. tccli/services/cdb/cdb_client.py +106 -0
  26. tccli/services/cdb/v20170320/api.json +257 -44
  27. tccli/services/cdb/v20170320/examples.json +22 -6
  28. tccli/services/cdn/cdn_client.py +4 -163
  29. tccli/services/cdn/v20180606/api.json +61 -310
  30. tccli/services/cdn/v20180606/examples.json +1 -25
  31. tccli/services/cdwdoris/v20211228/api.json +51 -12
  32. tccli/services/cdwpg/v20201230/api.json +11 -1
  33. tccli/services/cdwpg/v20201230/examples.json +1 -1
  34. tccli/services/cfg/v20210820/api.json +11 -1
  35. tccli/services/cfs/cfs_client.py +41 -94
  36. tccli/services/cfs/v20190719/api.json +171 -55
  37. tccli/services/cfs/v20190719/examples.json +1 -9
  38. tccli/services/cfw/v20190904/api.json +122 -10
  39. tccli/services/ckafka/ckafka_client.py +188 -29
  40. tccli/services/ckafka/v20190819/api.json +277 -4
  41. tccli/services/ckafka/v20190819/examples.json +25 -1
  42. tccli/services/clb/clb_client.py +0 -265
  43. tccli/services/clb/v20180317/api.json +130 -296
  44. tccli/services/clb/v20180317/examples.json +12 -40
  45. tccli/services/cloudapp/v20220530/api.json +55 -0
  46. tccli/services/cloudaudit/v20190319/api.json +11 -0
  47. tccli/services/cloudhsm/v20191112/api.json +10 -10
  48. tccli/services/cls/v20201016/api.json +63 -45
  49. tccli/services/cls/v20201016/examples.json +10 -4
  50. tccli/services/csip/v20221121/api.json +53 -3
  51. tccli/services/ctem/v20231128/api.json +320 -0
  52. tccli/services/ctem/v20231128/examples.json +3 -3
  53. tccli/services/cvm/cvm_client.py +0 -212
  54. tccli/services/cvm/v20170312/api.json +91 -843
  55. tccli/services/cvm/v20170312/examples.json +32 -58
  56. tccli/services/cynosdb/cynosdb_client.py +167 -8
  57. tccli/services/cynosdb/v20190107/api.json +1126 -148
  58. tccli/services/cynosdb/v20190107/examples.json +31 -7
  59. tccli/services/dbbrain/dbbrain_client.py +246 -87
  60. tccli/services/dbbrain/v20191016/api.json +74 -62
  61. tccli/services/dbbrain/v20191016/examples.json +1 -1
  62. tccli/services/dbbrain/v20210527/api.json +601 -177
  63. tccli/services/dbbrain/v20210527/examples.json +28 -4
  64. tccli/services/dc/v20180410/api.json +101 -3
  65. tccli/services/dcdb/v20180411/api.json +1 -1
  66. tccli/services/dlc/dlc_client.py +53 -0
  67. tccli/services/dlc/v20210125/api.json +237 -24
  68. tccli/services/dlc/v20210125/examples.json +12 -4
  69. tccli/services/dnspod/dnspod_client.py +106 -0
  70. tccli/services/dnspod/v20210323/api.json +126 -20
  71. tccli/services/dnspod/v20210323/examples.json +17 -7
  72. tccli/services/dsgc/v20190723/api.json +73 -15
  73. tccli/services/dts/v20180330/api.json +4 -4
  74. tccli/services/dts/v20211206/api.json +408 -127
  75. tccli/services/dts/v20211206/examples.json +15 -9
  76. tccli/services/eb/v20210416/api.json +41 -1
  77. tccli/services/eb/v20210416/examples.json +1 -1
  78. tccli/services/emr/v20190103/api.json +56 -9
  79. tccli/services/emr/v20190103/examples.json +5 -5
  80. tccli/services/es/es_client.py +273 -8
  81. tccli/services/es/v20180416/api.json +845 -33
  82. tccli/services/es/v20180416/examples.json +33 -1
  83. tccli/services/es/v20250101/api.json +135 -2
  84. tccli/services/es/v20250101/examples.json +8 -0
  85. tccli/services/ess/ess_client.py +509 -32
  86. tccli/services/ess/v20201111/api.json +1366 -113
  87. tccli/services/ess/v20201111/examples.json +94 -10
  88. tccli/services/essbasic/v20210526/api.json +265 -27
  89. tccli/services/essbasic/v20210526/examples.json +12 -12
  90. tccli/services/facefusion/v20220927/api.json +1 -1
  91. tccli/services/gaap/v20180529/api.json +18 -8
  92. tccli/services/gme/gme_client.py +53 -0
  93. tccli/services/gme/v20180711/api.json +241 -1
  94. tccli/services/gme/v20180711/examples.json +8 -0
  95. tccli/services/gs/gs_client.py +216 -4
  96. tccli/services/gs/v20191118/api.json +202 -1
  97. tccli/services/gs/v20191118/examples.json +32 -0
  98. tccli/services/gwlb/gwlb_client.py +53 -0
  99. tccli/services/gwlb/v20240906/api.json +150 -0
  100. tccli/services/gwlb/v20240906/examples.json +8 -0
  101. tccli/services/hai/v20230812/api.json +5 -5
  102. tccli/services/hunyuan/v20230901/api.json +3 -3
  103. tccli/services/hunyuan/v20230901/examples.json +1 -1
  104. tccli/services/iai/v20180301/api.json +227 -207
  105. tccli/services/iai/v20180301/examples.json +26 -26
  106. tccli/services/iai/v20200303/api.json +4 -4
  107. tccli/services/iai/v20200303/examples.json +1 -1
  108. tccli/services/ioa/ioa_client.py +265 -0
  109. tccli/services/ioa/v20220601/api.json +781 -85
  110. tccli/services/ioa/v20220601/examples.json +46 -0
  111. tccli/services/iotexplorer/iotexplorer_client.py +387 -16
  112. tccli/services/iotexplorer/v20190423/api.json +1183 -63
  113. tccli/services/iotexplorer/v20190423/examples.json +92 -0
  114. tccli/services/keewidb/v20220308/api.json +69 -17
  115. tccli/services/keewidb/v20220308/examples.json +5 -5
  116. tccli/services/lcic/v20220817/api.json +61 -15
  117. tccli/services/lighthouse/v20200324/api.json +193 -24
  118. tccli/services/lighthouse/v20200324/examples.json +9 -3
  119. tccli/services/live/v20180801/api.json +6 -6
  120. tccli/services/live/v20180801/examples.json +7 -1
  121. tccli/services/lke/lke_client.py +40 -93
  122. tccli/services/lke/v20231130/api.json +943 -390
  123. tccli/services/lke/v20231130/examples.json +38 -46
  124. tccli/services/lkeap/v20240522/api.json +39 -12
  125. tccli/services/lkeap/v20240522/examples.json +12 -0
  126. tccli/services/mariadb/v20170312/api.json +1 -1
  127. tccli/services/mna/v20210119/api.json +11 -2
  128. tccli/services/mna/v20210119/examples.json +1 -1
  129. tccli/services/mongodb/mongodb_client.py +334 -16
  130. tccli/services/mongodb/v20190725/api.json +1092 -383
  131. tccli/services/mongodb/v20190725/examples.json +69 -21
  132. tccli/services/monitor/monitor_client.py +106 -0
  133. tccli/services/monitor/v20180724/api.json +383 -12
  134. tccli/services/monitor/v20180724/examples.json +24 -2
  135. tccli/services/mps/mps_client.py +220 -8
  136. tccli/services/mps/v20190612/api.json +1999 -179
  137. tccli/services/mps/v20190612/examples.json +56 -6
  138. tccli/services/mqtt/v20240516/api.json +10 -0
  139. tccli/services/mqtt/v20240516/examples.json +3 -9
  140. tccli/services/nlp/v20190408/api.json +6 -6
  141. tccli/services/oceanus/oceanus_client.py +318 -0
  142. tccli/services/oceanus/v20190422/api.json +461 -26
  143. tccli/services/oceanus/v20190422/examples.json +50 -2
  144. tccli/services/ocr/ocr_client.py +41 -253
  145. tccli/services/ocr/v20181119/api.json +153 -659
  146. tccli/services/ocr/v20181119/examples.json +8 -40
  147. tccli/services/omics/v20221128/api.json +90 -7
  148. tccli/services/organization/v20210331/api.json +46 -7
  149. tccli/services/postgres/v20170312/api.json +333 -77
  150. tccli/services/postgres/v20170312/examples.json +37 -31
  151. tccli/services/privatedns/privatedns_client.py +641 -58
  152. tccli/services/privatedns/v20201028/api.json +930 -19
  153. tccli/services/privatedns/v20201028/examples.json +91 -3
  154. tccli/services/pts/v20210728/api.json +2 -2
  155. tccli/services/redis/v20180412/api.json +303 -109
  156. tccli/services/redis/v20180412/examples.json +12 -12
  157. tccli/services/region/v20220627/api.json +1 -1
  158. tccli/services/rum/v20210622/api.json +22 -4
  159. tccli/services/rum/v20210622/examples.json +2 -2
  160. tccli/services/sms/v20190711/api.json +12 -12
  161. tccli/services/sms/v20190711/examples.json +9 -3
  162. tccli/services/sms/v20210111/api.json +13 -13
  163. tccli/services/sms/v20210111/examples.json +8 -2
  164. tccli/services/sqlserver/v20180328/api.json +46 -7
  165. tccli/services/sqlserver/v20180328/examples.json +2 -2
  166. tccli/services/ssl/v20191205/api.json +28 -0
  167. tccli/services/svp/v20240125/api.json +14 -4
  168. tccli/services/tag/v20180813/api.json +3 -3
  169. tccli/services/tat/v20201028/api.json +22 -3
  170. tccli/services/tcb/v20180608/api.json +1 -1
  171. tccli/services/tcss/tcss_client.py +228 -69
  172. tccli/services/tcss/v20201101/api.json +273 -25
  173. tccli/services/tcss/v20201101/examples.json +26 -2
  174. tccli/services/teo/teo_client.py +317 -52
  175. tccli/services/teo/v20220901/api.json +1824 -242
  176. tccli/services/teo/v20220901/examples.json +109 -21
  177. tccli/services/thpc/thpc_client.py +57 -4
  178. tccli/services/thpc/v20230321/api.json +163 -21
  179. tccli/services/thpc/v20230321/examples.json +13 -5
  180. tccli/services/tione/tione_client.py +163 -4
  181. tccli/services/tione/v20211111/api.json +285 -21
  182. tccli/services/tione/v20211111/examples.json +27 -3
  183. tccli/services/tke/tke_client.py +8 -8
  184. tccli/services/tke/v20180525/api.json +168 -130
  185. tccli/services/tke/v20180525/examples.json +20 -20
  186. tccli/services/tke/v20220501/api.json +215 -3
  187. tccli/services/tke/v20220501/examples.json +8 -0
  188. tccli/services/tms/tms_client.py +106 -0
  189. tccli/services/tms/v20201229/api.json +249 -3
  190. tccli/services/tms/v20201229/examples.json +16 -0
  191. tccli/services/tmt/v20180321/api.json +78 -1
  192. tccli/services/trabbit/v20230418/api.json +271 -4
  193. tccli/services/trabbit/v20230418/examples.json +9 -3
  194. tccli/services/trocket/v20230308/api.json +4 -4
  195. tccli/services/trro/trro_client.py +106 -0
  196. tccli/services/trro/v20220325/api.json +456 -0
  197. tccli/services/trro/v20220325/examples.json +16 -0
  198. tccli/services/trtc/v20190722/api.json +197 -49
  199. tccli/services/trtc/v20190722/examples.json +4 -4
  200. tccli/services/tse/v20201207/api.json +69 -2
  201. tccli/services/tse/v20201207/examples.json +3 -3
  202. tccli/services/tsf/v20180326/api.json +70 -7
  203. tccli/services/tsf/v20180326/examples.json +2 -2
  204. tccli/services/vclm/v20240523/api.json +145 -0
  205. tccli/services/vclm/v20240523/examples.json +16 -0
  206. tccli/services/vclm/vclm_client.py +106 -0
  207. tccli/services/vcube/v20220410/api.json +1 -1
  208. tccli/services/vod/v20180717/api.json +7 -7
  209. tccli/services/vpc/v20170312/api.json +1216 -70
  210. tccli/services/vpc/v20170312/examples.json +139 -3
  211. tccli/services/vpc/vpc_client.py +1023 -122
  212. tccli/services/vrs/v20200824/api.json +11 -11
  213. tccli/services/vrs/v20200824/examples.json +1 -1
  214. tccli/services/vtc/v20240223/api.json +14 -14
  215. tccli/services/waf/v20180125/api.json +812 -143
  216. tccli/services/waf/v20180125/examples.json +2 -2
  217. tccli/services/wedata/v20210820/api.json +1281 -601
  218. tccli/services/wedata/v20210820/examples.json +127 -157
  219. tccli/services/wedata/v20250806/api.json +19335 -0
  220. tccli/services/wedata/v20250806/examples.json +999 -0
  221. tccli/services/wedata/wedata_client.py +7072 -1131
  222. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/METADATA +9 -7
  223. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/RECORD +226 -224
  224. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/WHEEL +1 -1
  225. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/entry_points.txt +0 -0
  226. {tccli-3.0.1391.1.dist-info/license_files → tccli-3.0.1414.1.dist-info/licenses}/LICENSE +0 -0
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "CompleteMigrateJob": {
4
- "document": "本接口(CompleteMigrateJob)用于完成数据迁移任务。\n选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。\n通过DescribeMigrationJobs接口查询到任务的状态为准备完成(Status=\"readyComplete\")时,此时可以调用本接口完成迁移任务。\n",
4
+ "document": "本接口(CompleteMigrateJob)用于完成数据迁移任务。\n选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。\n通过DescribeMigrationJobs接口查询到任务的状态为准备完成(Status=\"readyComplete\")时,此时可以调用本接口完成迁移任务。",
5
5
  "input": "CompleteMigrateJobRequest",
6
6
  "name": "完成数据迁移任务",
7
7
  "output": "CompleteMigrateJobResponse",
@@ -50,16 +50,16 @@
50
50
  "status": "online"
51
51
  },
52
52
  "CreateConsumerGroup": {
53
- "document": "为订阅实例创建消费者组",
53
+ "document": "为订阅实例创建消费者组。\n只有状态为运行中的实例支持创建消费组。",
54
54
  "input": "CreateConsumerGroupRequest",
55
55
  "name": "创建消费组",
56
56
  "output": "CreateConsumerGroupResponse",
57
57
  "status": "online"
58
58
  },
59
59
  "CreateMigrateCheckJob": {
60
- "document": "校验迁移任务,\n在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看,\n校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移\n",
60
+ "document": "创建校验迁移任务,\n在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看,\n校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移",
61
61
  "input": "CreateMigrateCheckJobRequest",
62
- "name": "校验迁移任务",
62
+ "name": "创建校验迁移任务",
63
63
  "output": "CreateMigrateCheckJobResponse",
64
64
  "status": "online"
65
65
  },
@@ -127,7 +127,7 @@
127
127
  "status": "online"
128
128
  },
129
129
  "DescribeCompareTasks": {
130
- "document": "查询一致性校验任务列表,调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。",
130
+ "document": "查询一致性校验任务列表。",
131
131
  "input": "DescribeCompareTasksRequest",
132
132
  "name": "查询一致性校验任务列表",
133
133
  "output": "DescribeCompareTasksResponse",
@@ -239,7 +239,7 @@
239
239
  "status": "online"
240
240
  },
241
241
  "IsolateMigrateJob": {
242
- "document": " 隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。",
242
+ "document": "隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrateJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。",
243
243
  "input": "IsolateMigrateJobRequest",
244
244
  "name": "隔离数据迁移任务",
245
245
  "output": "IsolateMigrateJobResponse",
@@ -253,7 +253,7 @@
253
253
  "status": "online"
254
254
  },
255
255
  "IsolateSyncJob": {
256
- "document": "隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。",
256
+ "document": "隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。",
257
257
  "input": "IsolateSyncJobRequest",
258
258
  "name": "隔离同步任务",
259
259
  "output": "IsolateSyncJobResponse",
@@ -288,7 +288,7 @@
288
288
  "status": "online"
289
289
  },
290
290
  "ModifyMigrateJobSpec": {
291
- "document": "调整实例规格,此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
291
+ "document": "调整实例规格,此接口只支持按量计费任务的调整,且仅在计费或者待计费状态下支持修改。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
292
292
  "input": "ModifyMigrateJobSpecRequest",
293
293
  "name": "调整实例规格",
294
294
  "output": "ModifyMigrateJobSpecResponse",
@@ -302,7 +302,7 @@
302
302
  "status": "online"
303
303
  },
304
304
  "ModifyMigrateRateLimit": {
305
- "document": "用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率",
305
+ "document": "用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率;此操作仅在任务运行中可执行。",
306
306
  "input": "ModifyMigrateRateLimitRequest",
307
307
  "name": "修改迁移任务的传输速率",
308
308
  "output": "ModifyMigrateRateLimitResponse",
@@ -316,7 +316,7 @@
316
316
  "status": "online"
317
317
  },
318
318
  "ModifyMigrationJob": {
319
- "document": "配置迁移服务,配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。",
319
+ "document": "配置迁移服务,配置成功后可通过`CreateMigrateCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。",
320
320
  "input": "ModifyMigrationJobRequest",
321
321
  "name": "配置迁移服务",
322
322
  "output": "ModifyMigrationJobResponse",
@@ -379,7 +379,7 @@
379
379
  "status": "online"
380
380
  },
381
381
  "RecoverSyncJob": {
382
- "document": "解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。",
382
+ "document": "解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。注意,此接口只支持按量计费实例。",
383
383
  "input": "RecoverSyncJobRequest",
384
384
  "name": "解除隔离同步任务",
385
385
  "output": "RecoverSyncJobResponse",
@@ -393,7 +393,7 @@
393
393
  "status": "online"
394
394
  },
395
395
  "ResetSubscribe": {
396
- "document": "本接口(ResetSubscribe)用于重置订阅实例,重置后,可以重新配置订阅任务。\n可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。",
396
+ "document": "本接口(ResetSubscribe)用于重置订阅实例,重置后,可以重新配置订阅任务。\n可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。",
397
397
  "input": "ResetSubscribeRequest",
398
398
  "name": "重置订阅任务",
399
399
  "output": "ResetSubscribeResponse",
@@ -414,7 +414,7 @@
414
414
  "status": "online"
415
415
  },
416
416
  "ResumeMigrateJob": {
417
- "document": "重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。注意:此操作跳过校验阶段,直接重新发起任务,相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
417
+ "document": "重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。",
418
418
  "input": "ResumeMigrateJobRequest",
419
419
  "name": "重试迁移任务",
420
420
  "output": "ResumeMigrateJobResponse",
@@ -449,14 +449,14 @@
449
449
  "status": "online"
450
450
  },
451
451
  "StartCompare": {
452
- "document": "启动一致性校验任务,启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务,启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态",
452
+ "document": "启动一致性校验任务,启动之前需要先通过接口 [CreateCompareTask](https://cloud.tencent.com/document/product/571/82093) 创建一致性校验任务,启动后可通过接口 [DescribeCompareTasks](https://cloud.tencent.com/document/product/571/82088) 查询一致性校验任务列表来获得启动后的状态",
453
453
  "input": "StartCompareRequest",
454
454
  "name": "启动一致性校验任务",
455
455
  "output": "StartCompareResponse",
456
456
  "status": "online"
457
457
  },
458
458
  "StartMigrateJob": {
459
- "document": "本接口(StartMigrationJob)用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
459
+ "document": "本接口(StartMigrateJob)用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
460
460
  "input": "StartMigrateJobRequest",
461
461
  "name": "启动数据迁移任务",
462
462
  "output": "StartMigrateJobResponse",
@@ -491,7 +491,7 @@
491
491
  "status": "online"
492
492
  },
493
493
  "StopMigrateJob": {
494
- "document": "本接口(StopMigrateJob)用于终止数据迁移任务。\n调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
494
+ "document": "本接口(StopMigrateJob)用于终止数据迁移任务。当任务状态为运行中、准备运行、准备完成、错误、暂停、未知等状态时可调用此接口终止任务。\n调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
495
495
  "input": "StopMigrateJobRequest",
496
496
  "name": "终止数据迁移任务",
497
497
  "output": "StopMigrateJobResponse",
@@ -923,6 +923,26 @@
923
923
  "output_required": false,
924
924
  "type": "object",
925
925
  "value_allowed_null": false
926
+ },
927
+ {
928
+ "disabled": false,
929
+ "document": "表结构不一致详情,pg用",
930
+ "example": "无",
931
+ "member": "DifferenceSchemaDetail",
932
+ "name": "DifferenceSchema",
933
+ "output_required": false,
934
+ "type": "object",
935
+ "value_allowed_null": false
936
+ },
937
+ {
938
+ "disabled": false,
939
+ "document": "对象owner不一致详情,pg用",
940
+ "example": "无",
941
+ "member": "DifferenceOwnerDetail",
942
+ "name": "DifferenceOwner",
943
+ "output_required": false,
944
+ "type": "object",
945
+ "value_allowed_null": false
926
946
  }
927
947
  ],
928
948
  "usage": "out"
@@ -1084,6 +1104,50 @@
1084
1104
  "required": false,
1085
1105
  "type": "int",
1086
1106
  "value_allowed_null": false
1107
+ },
1108
+ {
1109
+ "disabled": false,
1110
+ "document": "对比类型:builtin(内置校验)、independent(独立校验)。默认为builtin,mongodb及redis链路不支持独立校验。",
1111
+ "example": "builtin",
1112
+ "member": "string",
1113
+ "name": "Type",
1114
+ "output_required": false,
1115
+ "required": false,
1116
+ "type": "string",
1117
+ "value_allowed_null": false
1118
+ },
1119
+ {
1120
+ "disabled": false,
1121
+ "document": "校验类型,枚举值:structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验,Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) ",
1122
+ "example": "[\"full\",\"increment\"]",
1123
+ "member": "string",
1124
+ "name": "CompareMode",
1125
+ "output_required": false,
1126
+ "required": false,
1127
+ "type": "list",
1128
+ "value_allowed_null": false
1129
+ },
1130
+ {
1131
+ "disabled": false,
1132
+ "document": "复检次数",
1133
+ "example": "3",
1134
+ "member": "int64",
1135
+ "name": "ReCheckTime",
1136
+ "output_required": false,
1137
+ "required": false,
1138
+ "type": "int",
1139
+ "value_allowed_null": false
1140
+ },
1141
+ {
1142
+ "disabled": false,
1143
+ "document": "复检时间间隔,单位为分钟,取值 1-60",
1144
+ "example": "5",
1145
+ "member": "int64",
1146
+ "name": "ReCheckInterval",
1147
+ "output_required": false,
1148
+ "required": false,
1149
+ "type": "int",
1150
+ "value_allowed_null": false
1087
1151
  }
1088
1152
  ],
1089
1153
  "usage": "both"
@@ -1321,7 +1385,7 @@
1321
1385
  "members": [
1322
1386
  {
1323
1387
  "disabled": false,
1324
- "document": "数据迁移任务ID",
1388
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
1325
1389
  "example": "dts-1kl0iy0v",
1326
1390
  "member": "string",
1327
1391
  "name": "JobId",
@@ -1357,7 +1421,7 @@
1357
1421
  "members": [
1358
1422
  {
1359
1423
  "disabled": false,
1360
- "document": "数据订阅实例的 ID",
1424
+ "document": "数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
1361
1425
  "example": "subs-xxxxxx",
1362
1426
  "member": "string",
1363
1427
  "name": "SubscribeId",
@@ -1474,7 +1538,7 @@
1474
1538
  "members": [
1475
1539
  {
1476
1540
  "disabled": false,
1477
- "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23",
1541
+ "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
1478
1542
  "example": "sync-werwfs23",
1479
1543
  "member": "string",
1480
1544
  "name": "JobId",
@@ -1483,7 +1547,7 @@
1483
1547
  },
1484
1548
  {
1485
1549
  "disabled": false,
1486
- "document": "源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路",
1550
+ "document": "源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路",
1487
1551
  "example": "cdb",
1488
1552
  "member": "string",
1489
1553
  "name": "SrcAccessType",
@@ -1492,7 +1556,7 @@
1492
1556
  },
1493
1557
  {
1494
1558
  "disabled": false,
1495
- "document": "目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路",
1559
+ "document": "目标端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路",
1496
1560
  "example": "extranet",
1497
1561
  "member": "string",
1498
1562
  "name": "DstAccessType",
@@ -1656,7 +1720,7 @@
1656
1720
  },
1657
1721
  {
1658
1722
  "disabled": false,
1659
- "document": "条件覆盖操作",
1723
+ "document": "条件覆盖操作,目前仅支持>",
1660
1724
  "example": ">",
1661
1725
  "member": "string",
1662
1726
  "name": "ConditionOperator",
@@ -1667,7 +1731,7 @@
1667
1731
  },
1668
1732
  {
1669
1733
  "disabled": false,
1670
- "document": "条件覆盖优先级处理",
1734
+ "document": "条件覆盖优先级处理,支持类型有>,<,=",
1671
1735
  "example": ">",
1672
1736
  "member": "string",
1673
1737
  "name": "ConditionOrderInSrcAndDst",
@@ -1692,6 +1756,39 @@
1692
1756
  "required": false,
1693
1757
  "type": "string",
1694
1758
  "value_allowed_null": false
1759
+ },
1760
+ {
1761
+ "disabled": false,
1762
+ "document": "校验对象选择。枚举值:sameAsMigrate-与迁移同步任务相同、custom-用户自定义,搭配Objects操作",
1763
+ "example": "custom",
1764
+ "member": "string",
1765
+ "name": "ObjectMode",
1766
+ "output_required": false,
1767
+ "required": false,
1768
+ "type": "string",
1769
+ "value_allowed_null": false
1770
+ },
1771
+ {
1772
+ "disabled": false,
1773
+ "document": "校验对象\n注意:此字段可能返回 null,表示取不到有效值。",
1774
+ "example": "无",
1775
+ "member": "DatabaseTableObject",
1776
+ "name": "Objects",
1777
+ "output_required": false,
1778
+ "required": false,
1779
+ "type": "object",
1780
+ "value_allowed_null": true
1781
+ },
1782
+ {
1783
+ "disabled": false,
1784
+ "document": "校验配置",
1785
+ "example": "无",
1786
+ "member": "CompareOptions",
1787
+ "name": "Options",
1788
+ "output_required": false,
1789
+ "required": false,
1790
+ "type": "object",
1791
+ "value_allowed_null": false
1695
1792
  }
1696
1793
  ],
1697
1794
  "usage": "both"
@@ -1701,7 +1798,7 @@
1701
1798
  "members": [
1702
1799
  {
1703
1800
  "disabled": false,
1704
- "document": "数据迁移任务ID",
1801
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
1705
1802
  "example": "dts-xxxxxxxx",
1706
1803
  "member": "string",
1707
1804
  "name": "JobId",
@@ -1728,7 +1825,7 @@
1728
1825
  "members": [
1729
1826
  {
1730
1827
  "disabled": false,
1731
- "document": "同步任务id",
1828
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
1732
1829
  "example": "sync-xxxxxx",
1733
1830
  "member": "string",
1734
1831
  "name": "JobId",
@@ -1755,7 +1852,7 @@
1755
1852
  "members": [
1756
1853
  {
1757
1854
  "disabled": false,
1758
- "document": "同步任务id",
1855
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
1759
1856
  "example": "sync-n8deuq7e",
1760
1857
  "member": "string",
1761
1858
  "name": "JobId",
@@ -1782,7 +1879,7 @@
1782
1879
  "members": [
1783
1880
  {
1784
1881
  "disabled": false,
1785
- "document": "任务 Id",
1882
+ "document": "任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
1786
1883
  "example": "dts-p1sposne",
1787
1884
  "member": "string",
1788
1885
  "name": "JobId",
@@ -1855,7 +1952,7 @@
1855
1952
  "members": [
1856
1953
  {
1857
1954
  "disabled": false,
1858
- "document": "订阅实例id",
1955
+ "document": "订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。\n",
1859
1956
  "example": "subs-jvxbbos7c0",
1860
1957
  "member": "string",
1861
1958
  "name": "SubscribeId",
@@ -1918,7 +2015,7 @@
1918
2015
  "members": [
1919
2016
  {
1920
2017
  "disabled": false,
1921
- "document": "数据迁移任务ID",
2018
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
1922
2019
  "example": "dts-1kl0iy0v",
1923
2020
  "member": "string",
1924
2021
  "name": "JobId",
@@ -2045,7 +2142,7 @@
2045
2142
  "members": [
2046
2143
  {
2047
2144
  "disabled": false,
2048
- "document": "同步任务id",
2145
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
2049
2146
  "example": "sync-cxsasdaq",
2050
2147
  "member": "string",
2051
2148
  "name": "JobId",
@@ -2072,7 +2169,7 @@
2072
2169
  "members": [
2073
2170
  {
2074
2171
  "disabled": false,
2075
- "document": "数据订阅实例的 ID",
2172
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
2076
2173
  "example": "subs-xxxxxx",
2077
2174
  "member": "string",
2078
2175
  "name": "SubscribeId",
@@ -2244,7 +2341,7 @@
2244
2341
  },
2245
2342
  {
2246
2343
  "disabled": false,
2247
- "document": "同步任务规格,Standard:标准版",
2344
+ "document": "同步任务规格,Standard:标准版,目前仅支持Standard规格。",
2248
2345
  "example": "Standard",
2249
2346
  "member": "string",
2250
2347
  "name": "Specification",
@@ -2323,7 +2420,7 @@
2323
2420
  {
2324
2421
  "disabled": false,
2325
2422
  "document": "同步任务ids",
2326
- "example": "sync-btso140",
2423
+ "example": "[\"sync-btso140\"]",
2327
2424
  "member": "string",
2328
2425
  "name": "JobIds",
2329
2426
  "output_required": true,
@@ -3149,7 +3246,7 @@
3149
3246
  },
3150
3247
  {
3151
3248
  "disabled": false,
3152
- "document": "高级对象类型,如trigger、function、procedure、event。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型\n注意:此字段可能返回 null,表示取不到有效值。",
3249
+ "document": "高级对象类型,如trigger(触发器)、function(函数)、procedure(存储过程)、event(事件)。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型。\n\n> 当前支持高级对象迁移的场景为MySQL、TDSQL-CMySQL、MariaDB、Percona之间的数据迁移。\n注意:此字段可能返回 null,表示取不到有效值。",
3153
3250
  "example": "[\"trigger\"]",
3154
3251
  "member": "string",
3155
3252
  "name": "AdvancedObjects",
@@ -3194,7 +3291,7 @@
3194
3291
  "members": [
3195
3292
  {
3196
3293
  "disabled": false,
3197
- "document": "迁移任务 Id",
3294
+ "document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
3198
3295
  "example": "dts-8yv4w2i1",
3199
3296
  "member": "string",
3200
3297
  "name": "JobId",
@@ -3203,7 +3300,7 @@
3203
3300
  },
3204
3301
  {
3205
3302
  "disabled": false,
3206
- "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
3303
+ "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9。可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
3207
3304
  "example": "dts-8yv4w2i1-cmp-37skmii9",
3208
3305
  "member": "string",
3209
3306
  "name": "CompareTaskId",
@@ -3230,7 +3327,7 @@
3230
3327
  "members": [
3231
3328
  {
3232
3329
  "disabled": false,
3233
- "document": "数据订阅实例的 ID",
3330
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。\n",
3234
3331
  "example": "subs-9jyki7hniw",
3235
3332
  "member": "string",
3236
3333
  "name": "SubscribeId",
@@ -3239,7 +3336,7 @@
3239
3336
  },
3240
3337
  {
3241
3338
  "disabled": false,
3242
- "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。\n请务必保证消费组名称正确。",
3339
+ "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。\n请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
3243
3340
  "example": "consumer-grp-subs-9jyki7hniw-test",
3244
3341
  "member": "string",
3245
3342
  "name": "ConsumerGroupName",
@@ -3248,7 +3345,7 @@
3248
3345
  },
3249
3346
  {
3250
3347
  "disabled": false,
3251
- "document": "账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。\n请务必保证账户名称正确。",
3348
+ "document": "账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。\n请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
3252
3349
  "example": "account-subs-9jyki7hniw-test",
3253
3350
  "member": "string",
3254
3351
  "name": "AccountName",
@@ -3275,7 +3372,7 @@
3275
3372
  "members": [
3276
3373
  {
3277
3374
  "disabled": false,
3278
- "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填",
3375
+ "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
3279
3376
  "example": "sync-werwfs23",
3280
3377
  "member": "string",
3281
3378
  "name": "JobId",
@@ -3331,7 +3428,7 @@
3331
3428
  {
3332
3429
  "disabled": false,
3333
3430
  "document": "步骤信息\n注意:此字段可能返回 null,表示取不到有效值。",
3334
- "example": "StepInfos",
3431
+ "example": "",
3335
3432
  "member": "StepInfo",
3336
3433
  "name": "StepInfos",
3337
3434
  "output_required": true,
@@ -3352,7 +3449,7 @@
3352
3449
  "members": [
3353
3450
  {
3354
3451
  "disabled": false,
3355
- "document": "迁移任务 Id",
3452
+ "document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
3356
3453
  "example": "dts-amm1jw5q",
3357
3454
  "member": "string",
3358
3455
  "name": "JobId",
@@ -3361,7 +3458,7 @@
3361
3458
  },
3362
3459
  {
3363
3460
  "disabled": false,
3364
- "document": "校验任务 Id",
3461
+ "document": "校验任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
3365
3462
  "example": "dts-amm1jw5q-cmp-bmuum7jk",
3366
3463
  "member": "string",
3367
3464
  "name": "CompareTaskId",
@@ -3480,7 +3577,7 @@
3480
3577
  "members": [
3481
3578
  {
3482
3579
  "disabled": false,
3483
- "document": "迁移任务 Id",
3580
+ "document": "迁移任务 Id,可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。\n",
3484
3581
  "example": "dts-e7ukka6g",
3485
3582
  "member": "string",
3486
3583
  "name": "JobId",
@@ -3563,7 +3660,7 @@
3563
3660
  "members": [
3564
3661
  {
3565
3662
  "disabled": false,
3566
- "document": "订阅实例id",
3663
+ "document": "订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
3567
3664
  "example": "subs-47damshnra",
3568
3665
  "member": "string",
3569
3666
  "name": "SubscribeId",
@@ -3628,7 +3725,7 @@
3628
3725
  "members": [
3629
3726
  {
3630
3727
  "disabled": false,
3631
- "document": "数据库类型,如mysql,redis",
3728
+ "document": "数据库类型,如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。",
3632
3729
  "example": "mysql",
3633
3730
  "member": "string",
3634
3731
  "name": "DatabaseType",
@@ -3646,7 +3743,7 @@
3646
3743
  },
3647
3744
  {
3648
3745
  "disabled": false,
3649
- "document": "云数据库实例ID",
3746
+ "document": "云数据库实例ID,可通过对应业务实例列表获取实例信息。",
3650
3747
  "example": "cdb-ktexpqjo",
3651
3748
  "member": "string",
3652
3749
  "name": "InstanceId",
@@ -3655,7 +3752,7 @@
3655
3752
  },
3656
3753
  {
3657
3754
  "disabled": false,
3658
- "document": "云数据库名称",
3755
+ "document": "云数据库名称,可通过对应业务实例列表获取实例信息。",
3659
3756
  "example": "cdb-name1",
3660
3757
  "member": "string",
3661
3758
  "name": "InstanceName",
@@ -3756,7 +3853,7 @@
3756
3853
  "members": [
3757
3854
  {
3758
3855
  "disabled": false,
3759
- "document": "任务id",
3856
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
3760
3857
  "example": "dts-1ewjspuw",
3761
3858
  "member": "string",
3762
3859
  "name": "JobId",
@@ -3823,7 +3920,7 @@
3823
3920
  "members": [
3824
3921
  {
3825
3922
  "disabled": false,
3826
- "document": "数据迁移任务ID",
3923
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
3827
3924
  "example": "dts-amm1jw5q",
3828
3925
  "member": "string",
3829
3926
  "name": "JobId",
@@ -4252,7 +4349,7 @@
4252
4349
  "members": [
4253
4350
  {
4254
4351
  "disabled": false,
4255
- "document": "同步任务id",
4352
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
4256
4353
  "example": "sync-csasweee",
4257
4354
  "member": "string",
4258
4355
  "name": "JobId",
@@ -4329,7 +4426,7 @@
4329
4426
  "members": [
4330
4427
  {
4331
4428
  "disabled": false,
4332
- "document": "数据订阅实例的 ID",
4429
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
4333
4430
  "example": "subs-9jyki7hniw",
4334
4431
  "member": "string",
4335
4432
  "name": "SubscribeId",
@@ -4375,7 +4472,7 @@
4375
4472
  "members": [
4376
4473
  {
4377
4474
  "disabled": false,
4378
- "document": "数据订阅实例的 ID",
4475
+ "document": "数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
4379
4476
  "example": "subs-l4d3a7izai",
4380
4477
  "member": "string",
4381
4478
  "name": "SubscribeId",
@@ -4410,7 +4507,7 @@
4410
4507
  },
4411
4508
  {
4412
4509
  "disabled": false,
4413
- "document": "任务运行状态,可能值为 running,failed,success",
4510
+ "document": "任务运行状态,可能值为 running(运行中),failed(失败),success(成功),unknown(未知状态)。",
4414
4511
  "example": "success",
4415
4512
  "member": "string",
4416
4513
  "name": "Status",
@@ -4472,7 +4569,7 @@
4472
4569
  "members": [
4473
4570
  {
4474
4571
  "disabled": false,
4475
- "document": "订阅实例ID",
4572
+ "document": "订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
4476
4573
  "example": "subs-xxxxxx",
4477
4574
  "member": "string",
4478
4575
  "name": "SubscribeId",
@@ -4974,7 +5071,7 @@
4974
5071
  "members": [
4975
5072
  {
4976
5073
  "disabled": false,
4977
- "document": "数据订阅实例的ID",
5074
+ "document": "数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
4978
5075
  "example": "subs-9jyki7hniw",
4979
5076
  "member": "string",
4980
5077
  "name": "SubscribeId",
@@ -5021,7 +5118,7 @@
5021
5118
  "members": [
5022
5119
  {
5023
5120
  "disabled": false,
5024
- "document": "同步任务id,如sync-werwfs23",
5121
+ "document": "同步任务id,如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
5025
5122
  "example": "sync-n3gh7md9",
5026
5123
  "member": "string",
5027
5124
  "name": "JobId",
@@ -5030,7 +5127,7 @@
5030
5127
  },
5031
5128
  {
5032
5129
  "disabled": false,
5033
- "document": "同步任务id列表,如sync-werwfs23",
5130
+ "document": "同步任务id列表,如[\"sync-n3gh7md9\"]",
5034
5131
  "example": "[\"sync-n3gh7md9\"]",
5035
5132
  "member": "string",
5036
5133
  "name": "JobIds",
@@ -5048,7 +5145,7 @@
5048
5145
  },
5049
5146
  {
5050
5147
  "disabled": false,
5051
- "document": "排序字段,可以取值为CreateTime",
5148
+ "document": "排序字段,目前仅支持CreateTime字段排序",
5052
5149
  "example": "CreateTime",
5053
5150
  "member": "string",
5054
5151
  "name": "Order",
@@ -5084,8 +5181,8 @@
5084
5181
  },
5085
5182
  {
5086
5183
  "disabled": false,
5087
- "document": "状态集合,如Initialized,CheckPass,Running,ResumableErr,Stopped",
5088
- "example": "Running",
5184
+ "document": "状态集合,如Initialized(初始化),CheckPass(校验通过),Running(运行中),ResumableErr(恢复中),Stopped(已结束)",
5185
+ "example": "[\"Running\"]",
5089
5186
  "member": "string",
5090
5187
  "name": "Status",
5091
5188
  "required": false,
@@ -5102,7 +5199,7 @@
5102
5199
  },
5103
5200
  {
5104
5201
  "disabled": false,
5105
- "document": "任务类型,如mysql2mysql:msyql同步到mysql",
5202
+ "document": "任务类型,如mysql2mysql:msyql同步到mysql;可取值有mysql2mysql、mysql2kafka、tdsqlmysql2kafka、tdsqlmysql2tdsqlmysql、tdsqlmysql2mysql、mysql2tdsqlmysql、mysql2mariadb、mariadb2mariadb、mariadb2kafka、cynosdbmysql2kafka、cynosdbmysql2cynosdbmysql、cynosdbmysql2mysql、mysql2cynosdbmysql、mariadb2tdsqlmysql、tdsqlmysql2cynosdbmysql、cynosdbmysql2tdsqlmysql、tdstore2mysql、tdstore2percona、tdstore2mariadb、tdstore2cynosdbmysql、cynosdbmysql2mariadb、mariadb2cynosdbmysql、tdsqlmysql2mariadb、mariadb2mysql、percona2mariadb、postgresql2postgresql、tdstore2tdsqlmysql、mongodb2mongodb",
5106
5203
  "example": "mysql2mysql",
5107
5204
  "member": "string",
5108
5205
  "name": "JobType",
@@ -5185,7 +5282,7 @@
5185
5282
  "members": [
5186
5283
  {
5187
5284
  "disabled": false,
5188
- "document": "数据订阅实例的ID",
5285
+ "document": "数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
5189
5286
  "example": "subs-9jyki7hniw",
5190
5287
  "member": "string",
5191
5288
  "name": "SubscribeId",
@@ -5212,7 +5309,7 @@
5212
5309
  "members": [
5213
5310
  {
5214
5311
  "disabled": false,
5215
- "document": "任务id",
5312
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
5216
5313
  "example": "dts-j7bt5sid",
5217
5314
  "member": "string",
5218
5315
  "name": "JobId",
@@ -5239,7 +5336,7 @@
5239
5336
  "members": [
5240
5337
  {
5241
5338
  "disabled": false,
5242
- "document": "同步任务id",
5339
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
5243
5340
  "example": "sync-werwfs23",
5244
5341
  "member": "string",
5245
5342
  "name": "JobId",
@@ -5436,6 +5533,16 @@
5436
5533
  "type": "string",
5437
5534
  "value_allowed_null": false
5438
5535
  },
5536
+ {
5537
+ "disabled": false,
5538
+ "document": "创建时间",
5539
+ "example": "2023-10-26 18:49:00",
5540
+ "member": "string",
5541
+ "name": "CreatedAt",
5542
+ "output_required": false,
5543
+ "type": "string",
5544
+ "value_allowed_null": false
5545
+ },
5439
5546
  {
5440
5547
  "disabled": false,
5441
5548
  "document": "更新时间",
@@ -5617,6 +5724,32 @@
5617
5724
  ],
5618
5725
  "usage": "out"
5619
5726
  },
5727
+ "DifferenceOwnerDetail": {
5728
+ "document": "pg owner不一致性详情",
5729
+ "members": [
5730
+ {
5731
+ "disabled": false,
5732
+ "document": "owner不一致总数",
5733
+ "example": "1",
5734
+ "member": "int64",
5735
+ "name": "TotalCount",
5736
+ "output_required": false,
5737
+ "type": "int",
5738
+ "value_allowed_null": false
5739
+ },
5740
+ {
5741
+ "disabled": false,
5742
+ "document": "owner不一致详情\n注意:此字段可能返回 null,表示取不到有效值。",
5743
+ "example": "无",
5744
+ "member": "OwnerDifference",
5745
+ "name": "Items",
5746
+ "output_required": false,
5747
+ "type": "list",
5748
+ "value_allowed_null": true
5749
+ }
5750
+ ],
5751
+ "usage": "out"
5752
+ },
5620
5753
  "DifferenceRowDetail": {
5621
5754
  "document": "mongodb行数校验不一致性详情结果",
5622
5755
  "members": [
@@ -5643,6 +5776,32 @@
5643
5776
  ],
5644
5777
  "usage": "out"
5645
5778
  },
5779
+ "DifferenceSchemaDetail": {
5780
+ "document": "表结构不一致信息",
5781
+ "members": [
5782
+ {
5783
+ "disabled": false,
5784
+ "document": "表结构不一致的数量",
5785
+ "example": "1",
5786
+ "member": "int64",
5787
+ "name": "TotalCount",
5788
+ "output_required": false,
5789
+ "type": "int",
5790
+ "value_allowed_null": false
5791
+ },
5792
+ {
5793
+ "disabled": false,
5794
+ "document": "表结构不一致信息\n注意:此字段可能返回 null,表示取不到有效值。",
5795
+ "example": "无",
5796
+ "member": "SchemaDifference",
5797
+ "name": "Items",
5798
+ "output_required": false,
5799
+ "type": "list",
5800
+ "value_allowed_null": true
5801
+ }
5802
+ ],
5803
+ "usage": "out"
5804
+ },
5646
5805
  "DistributeRule": {
5647
5806
  "document": "订阅任务的kafka分区规则。符合库名和表名正则表达式的数据将按照RuleType计算该条数据将被投递的kafka分区。如果配置了多个规则,将按照配置的顺序,第一条命中的规则生效。",
5648
5807
  "members": [
@@ -6541,7 +6700,7 @@
6541
6700
  "members": [
6542
6701
  {
6543
6702
  "disabled": false,
6544
- "document": "任务id",
6703
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
6545
6704
  "example": "dts-amm1jw5q",
6546
6705
  "member": "string",
6547
6706
  "name": "JobId",
@@ -6568,7 +6727,7 @@
6568
6727
  "members": [
6569
6728
  {
6570
6729
  "disabled": false,
6571
- "document": "订阅实例ID",
6730
+ "document": "订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
6572
6731
  "example": "subs-9jyki7hniw",
6573
6732
  "member": "string",
6574
6733
  "name": "SubscribeId",
@@ -6595,7 +6754,7 @@
6595
6754
  "members": [
6596
6755
  {
6597
6756
  "disabled": false,
6598
- "document": "同步任务id",
6757
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
6599
6758
  "example": "sync-werwfs23",
6600
6759
  "member": "string",
6601
6760
  "name": "JobId",
@@ -7177,7 +7336,7 @@
7177
7336
  "members": [
7178
7337
  {
7179
7338
  "disabled": false,
7180
- "document": "迁移任务 Id",
7339
+ "document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7181
7340
  "example": "dts-8yv4w2i1",
7182
7341
  "member": "string",
7183
7342
  "name": "JobId",
@@ -7186,7 +7345,7 @@
7186
7345
  },
7187
7346
  {
7188
7347
  "disabled": false,
7189
- "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
7348
+ "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7190
7349
  "example": "dts-8yv4w2i1-cmp-37skmii9",
7191
7350
  "member": "string",
7192
7351
  "name": "CompareTaskId",
@@ -7222,7 +7381,7 @@
7222
7381
  "members": [
7223
7382
  {
7224
7383
  "disabled": false,
7225
- "document": "任务 Id",
7384
+ "document": "任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7226
7385
  "example": "dts-45jhpmjh",
7227
7386
  "member": "string",
7228
7387
  "name": "JobId",
@@ -7231,7 +7390,7 @@
7231
7390
  },
7232
7391
  {
7233
7392
  "disabled": false,
7234
- "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
7393
+ "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7235
7394
  "example": "dts-45jhpmjh-cmp-k7uhq1v3",
7236
7395
  "member": "string",
7237
7396
  "name": "CompareTaskId",
@@ -7294,7 +7453,7 @@
7294
7453
  "members": [
7295
7454
  {
7296
7455
  "disabled": false,
7297
- "document": "数据订阅实例的 ID",
7456
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
7298
7457
  "example": "subs-9jyki7hniw",
7299
7458
  "member": "string",
7300
7459
  "name": "SubscribeId",
@@ -7303,7 +7462,7 @@
7303
7462
  },
7304
7463
  {
7305
7464
  "disabled": false,
7306
- "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。\n请务必保证消费组名称正确。",
7465
+ "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。\n请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
7307
7466
  "example": "consumer-grp-subs-9jyki7hniw-group-1",
7308
7467
  "member": "string",
7309
7468
  "name": "ConsumerGroupName",
@@ -7312,7 +7471,7 @@
7312
7471
  },
7313
7472
  {
7314
7473
  "disabled": false,
7315
- "document": "账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。\n请务必保证账户名称正确。",
7474
+ "document": "账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。\n请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
7316
7475
  "example": "account-subs-9jyki7hniw-jason",
7317
7476
  "member": "string",
7318
7477
  "name": "AccountName",
@@ -7348,7 +7507,7 @@
7348
7507
  "members": [
7349
7508
  {
7350
7509
  "disabled": false,
7351
- "document": "数据订阅实例的 ID",
7510
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。\n",
7352
7511
  "example": "subs-9jyki7hniw",
7353
7512
  "member": "string",
7354
7513
  "name": "SubscribeId",
@@ -7357,7 +7516,7 @@
7357
7516
  },
7358
7517
  {
7359
7518
  "disabled": false,
7360
- "document": "账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}",
7519
+ "document": "账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
7361
7520
  "example": "account-subs-9jyki7hniw-jason",
7362
7521
  "member": "string",
7363
7522
  "name": "AccountName",
@@ -7366,7 +7525,7 @@
7366
7525
  },
7367
7526
  {
7368
7527
  "disabled": false,
7369
- "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}",
7528
+ "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。",
7370
7529
  "example": "consumer-grp-subs-9jyki7hniw-group-1",
7371
7530
  "member": "string",
7372
7531
  "name": "ConsumerGroupName",
@@ -7402,7 +7561,7 @@
7402
7561
  "members": [
7403
7562
  {
7404
7563
  "disabled": false,
7405
- "document": "任务id",
7564
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7406
7565
  "example": "dts-j7bt5sid",
7407
7566
  "member": "string",
7408
7567
  "name": "JobId",
@@ -7438,7 +7597,7 @@
7438
7597
  "members": [
7439
7598
  {
7440
7599
  "disabled": false,
7441
- "document": "迁移任务id",
7600
+ "document": "迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7442
7601
  "example": "dts-7itt1j4w",
7443
7602
  "member": "string",
7444
7603
  "name": "JobId",
@@ -7474,7 +7633,7 @@
7474
7633
  "members": [
7475
7634
  {
7476
7635
  "disabled": false,
7477
- "document": "迁移任务ID",
7636
+ "document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
7478
7637
  "example": "dts-saasxa",
7479
7638
  "member": "string",
7480
7639
  "name": "JobId",
@@ -7546,7 +7705,7 @@
7546
7705
  "members": [
7547
7706
  {
7548
7707
  "disabled": false,
7549
- "document": "迁移任务id,如:dts-2rgv0f09",
7708
+ "document": "迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7550
7709
  "example": "dts-7itt1j4w",
7551
7710
  "member": "string",
7552
7711
  "name": "JobId",
@@ -7582,7 +7741,7 @@
7582
7741
  "members": [
7583
7742
  {
7584
7743
  "disabled": false,
7585
- "document": "任务id",
7744
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
7586
7745
  "example": "dts-1ewjspuw",
7587
7746
  "member": "string",
7588
7747
  "name": "JobId",
@@ -7681,7 +7840,7 @@
7681
7840
  "members": [
7682
7841
  {
7683
7842
  "disabled": false,
7684
- "document": "订阅实例ID",
7843
+ "document": "订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
7685
7844
  "example": "subs-9jyki7hniw",
7686
7845
  "member": "string",
7687
7846
  "name": "SubscribeId",
@@ -7717,7 +7876,7 @@
7717
7876
  "members": [
7718
7877
  {
7719
7878
  "disabled": false,
7720
- "document": "数据订阅实例的ID",
7879
+ "document": "数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
7721
7880
  "example": "subs-9jyki7hniw",
7722
7881
  "member": "string",
7723
7882
  "name": "SubscribeId",
@@ -7753,7 +7912,7 @@
7753
7912
  "members": [
7754
7913
  {
7755
7914
  "disabled": false,
7756
- "document": "数据订阅实例的ID",
7915
+ "document": "数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
7757
7916
  "example": "subs-9jyki7hniw",
7758
7917
  "member": "string",
7759
7918
  "name": "SubscribeId",
@@ -7771,7 +7930,7 @@
7771
7930
  },
7772
7931
  {
7773
7932
  "disabled": false,
7774
- "document": "修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。",
7933
+ "document": "修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。",
7775
7934
  "example": "无",
7776
7935
  "member": "ModifiedSubscribeObject",
7777
7936
  "name": "Objects",
@@ -7825,7 +7984,7 @@
7825
7984
  "members": [
7826
7985
  {
7827
7986
  "disabled": false,
7828
- "document": "同步任务id",
7987
+ "document": "同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
7829
7988
  "example": "sync-adasasww",
7830
7989
  "member": "string",
7831
7990
  "name": "JobId",
@@ -7870,8 +8029,8 @@
7870
8029
  "members": [
7871
8030
  {
7872
8031
  "disabled": false,
7873
- "document": "迁移任务ID",
7874
- "example": "dts-saasxa",
8032
+ "document": "同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
8033
+ "example": "sync-saasxa",
7875
8034
  "member": "string",
7876
8035
  "name": "JobId",
7877
8036
  "required": true,
@@ -7888,7 +8047,7 @@
7888
8047
  },
7889
8048
  {
7890
8049
  "disabled": false,
7891
- "document": "同步任务全量导出的 Rps 限制、需要大于 0",
8050
+ "document": "同步任务全量导出的 Rps 限制、需要大于 0;对于mongodb最大值为20000,其他数据库最大值为50000000",
7892
8051
  "example": "20000",
7893
8052
  "member": "int64",
7894
8053
  "name": "DumpRps",
@@ -8064,7 +8223,7 @@
8064
8223
  "members": [
8065
8224
  {
8066
8225
  "disabled": false,
8067
- "document": "状态",
8226
+ "document": "状态,ON-启用,OFF-不启用。",
8068
8227
  "example": "ON",
8069
8228
  "member": "string",
8070
8229
  "name": "Status",
@@ -8225,6 +8384,72 @@
8225
8384
  ],
8226
8385
  "usage": "both"
8227
8386
  },
8387
+ "OwnerDifference": {
8388
+ "document": "pg对象owner不一致信息",
8389
+ "members": [
8390
+ {
8391
+ "disabled": false,
8392
+ "document": "owner不一致的pg对象所在库",
8393
+ "example": "db1",
8394
+ "member": "string",
8395
+ "name": "Db",
8396
+ "output_required": false,
8397
+ "type": "string",
8398
+ "value_allowed_null": false
8399
+ },
8400
+ {
8401
+ "disabled": false,
8402
+ "document": "owner不一致的pg对象所在schema",
8403
+ "example": "schema1",
8404
+ "member": "string",
8405
+ "name": "Schema",
8406
+ "output_required": false,
8407
+ "type": "string",
8408
+ "value_allowed_null": false
8409
+ },
8410
+ {
8411
+ "disabled": false,
8412
+ "document": "owner不一致的pg对象名",
8413
+ "example": "tab1",
8414
+ "member": "string",
8415
+ "name": "ObjectName",
8416
+ "output_required": false,
8417
+ "type": "string",
8418
+ "value_allowed_null": false
8419
+ },
8420
+ {
8421
+ "disabled": false,
8422
+ "document": "owner不一致的pg对象类型",
8423
+ "example": "tableSchema",
8424
+ "member": "string",
8425
+ "name": "ObjectType",
8426
+ "output_required": false,
8427
+ "type": "string",
8428
+ "value_allowed_null": false
8429
+ },
8430
+ {
8431
+ "disabled": false,
8432
+ "document": "源库对象owner",
8433
+ "example": "root",
8434
+ "member": "string",
8435
+ "name": "SrcOwner",
8436
+ "output_required": false,
8437
+ "type": "string",
8438
+ "value_allowed_null": false
8439
+ },
8440
+ {
8441
+ "disabled": false,
8442
+ "document": "目标库对象owner",
8443
+ "example": "user_123",
8444
+ "member": "string",
8445
+ "name": "DstOwner",
8446
+ "output_required": false,
8447
+ "type": "string",
8448
+ "value_allowed_null": false
8449
+ }
8450
+ ],
8451
+ "usage": "out"
8452
+ },
8228
8453
  "PartitionAssignment": {
8229
8454
  "document": "数据订阅中kafka消费者组的分区分配情况。该数据是实时查询的,如果需要最新数据,需重新掉接口查询。",
8230
8455
  "members": [
@@ -8256,7 +8481,7 @@
8256
8481
  "members": [
8257
8482
  {
8258
8483
  "disabled": false,
8259
- "document": "数据迁移任务ID",
8484
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
8260
8485
  "example": "dts-xxxxxxxx",
8261
8486
  "member": "string",
8262
8487
  "name": "JobId",
@@ -8283,7 +8508,7 @@
8283
8508
  "members": [
8284
8509
  {
8285
8510
  "disabled": false,
8286
- "document": "同步任务id",
8511
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
8287
8512
  "example": "sync-xxxxxx",
8288
8513
  "member": "string",
8289
8514
  "name": "JobId",
@@ -8567,7 +8792,7 @@
8567
8792
  "members": [
8568
8793
  {
8569
8794
  "disabled": false,
8570
- "document": "任务id",
8795
+ "document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
8571
8796
  "example": "dts-7o16y2qy",
8572
8797
  "member": "string",
8573
8798
  "name": "JobId",
@@ -8594,7 +8819,7 @@
8594
8819
  "members": [
8595
8820
  {
8596
8821
  "disabled": false,
8597
- "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23",
8822
+ "document": "同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
8598
8823
  "example": "sync-werwfs23",
8599
8824
  "member": "string",
8600
8825
  "name": "JobId",
@@ -8621,7 +8846,7 @@
8621
8846
  "members": [
8622
8847
  {
8623
8848
  "disabled": false,
8624
- "document": "订阅实例id",
8849
+ "document": "订阅实例id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
8625
8850
  "example": "subs-7l2ly86kao",
8626
8851
  "member": "string",
8627
8852
  "name": "SubscribeId",
@@ -8630,7 +8855,7 @@
8630
8855
  },
8631
8856
  {
8632
8857
  "disabled": false,
8633
- "document": "订阅的kafka topic",
8858
+ "document": "订阅的kafka topic,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
8634
8859
  "example": "topic-subs-7l2ly86kao-cdb-5jr9ms95",
8635
8860
  "member": "string",
8636
8861
  "name": "TopicName",
@@ -8639,7 +8864,7 @@
8639
8864
  },
8640
8865
  {
8641
8866
  "disabled": false,
8642
- "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}",
8867
+ "document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/api/571/102947)接口获取。",
8643
8868
  "example": "consumer-grp-subs-7l2ly86kao-group-1",
8644
8869
  "member": "string",
8645
8870
  "name": "ConsumerGroupName",
@@ -8648,7 +8873,7 @@
8648
8873
  },
8649
8874
  {
8650
8875
  "disabled": false,
8651
- "document": "需要修改offset的分区编号",
8876
+ "document": "需要修改offset的分区编号,可通过[DescribeOffsetByTime](https://cloud.tencent.com/document/api/571/102946)接口获取。",
8652
8877
  "example": "[0,1,2,3]",
8653
8878
  "member": "int64",
8654
8879
  "name": "PartitionNos",
@@ -8693,7 +8918,7 @@
8693
8918
  "members": [
8694
8919
  {
8695
8920
  "disabled": false,
8696
- "document": "数据订阅实例的ID",
8921
+ "document": "数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。\n",
8697
8922
  "example": "subs-9jyki7hniw",
8698
8923
  "member": "string",
8699
8924
  "name": "SubscribeId",
@@ -8747,7 +8972,7 @@
8747
8972
  "members": [
8748
8973
  {
8749
8974
  "disabled": false,
8750
- "document": "同步任务id",
8975
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
8751
8976
  "example": "sync-werwfs23",
8752
8977
  "member": "string",
8753
8978
  "name": "JobId",
@@ -8756,7 +8981,7 @@
8756
8981
  },
8757
8982
  {
8758
8983
  "disabled": false,
8759
- "document": "任务规格",
8984
+ "document": "任务规格,可选值包括micro,small,medium,large",
8760
8985
  "example": "small",
8761
8986
  "member": "string",
8762
8987
  "name": "NewInstanceClass",
@@ -8783,7 +9008,7 @@
8783
9008
  "members": [
8784
9009
  {
8785
9010
  "disabled": false,
8786
- "document": "数据迁移任务ID",
9011
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
8787
9012
  "example": "dts-1kl0iy0v",
8788
9013
  "member": "string",
8789
9014
  "name": "JobId",
@@ -8793,7 +9018,7 @@
8793
9018
  {
8794
9019
  "disabled": false,
8795
9020
  "document": "恢复任务的模式,目前的取值有:clearData 清空目标实例数据,overwrite 以覆盖写的方式执行任务,normal 跟正常流程一样,不做额外动作;注意,clearData、overwrite仅对redis生效,normal仅针对非redis链路生效",
8796
- "example": "overwrite ",
9021
+ "example": "overwrite",
8797
9022
  "member": "string",
8798
9023
  "name": "ResumeOption",
8799
9024
  "required": false,
@@ -8819,7 +9044,7 @@
8819
9044
  "members": [
8820
9045
  {
8821
9046
  "disabled": false,
8822
- "document": "数据订阅实例的 ID",
9047
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
8823
9048
  "example": "subs-9jyki7hniw",
8824
9049
  "member": "string",
8825
9050
  "name": "SubscribeId",
@@ -8846,7 +9071,7 @@
8846
9071
  "members": [
8847
9072
  {
8848
9073
  "disabled": false,
8849
- "document": "同步任务id",
9074
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
8850
9075
  "example": "sync-09vy1os1",
8851
9076
  "member": "string",
8852
9077
  "name": "JobId",
@@ -8942,12 +9167,68 @@
8942
9167
  ],
8943
9168
  "usage": "out"
8944
9169
  },
9170
+ "SchemaDifference": {
9171
+ "document": "结构不一致详情",
9172
+ "members": [
9173
+ {
9174
+ "disabled": false,
9175
+ "document": "结构不一致的表所在库",
9176
+ "example": "db1",
9177
+ "member": "string",
9178
+ "name": "Db",
9179
+ "output_required": false,
9180
+ "type": "string",
9181
+ "value_allowed_null": false
9182
+ },
9183
+ {
9184
+ "disabled": false,
9185
+ "document": "结构不一致的表所在schema",
9186
+ "example": "schema1",
9187
+ "member": "string",
9188
+ "name": "Schema",
9189
+ "output_required": false,
9190
+ "type": "string",
9191
+ "value_allowed_null": false
9192
+ },
9193
+ {
9194
+ "disabled": false,
9195
+ "document": "结构不一致的表",
9196
+ "example": "tab1",
9197
+ "member": "string",
9198
+ "name": "Table",
9199
+ "output_required": false,
9200
+ "type": "string",
9201
+ "value_allowed_null": false
9202
+ },
9203
+ {
9204
+ "disabled": false,
9205
+ "document": "源库表结构",
9206
+ "example": "create table tab1...",
9207
+ "member": "string",
9208
+ "name": "SrcSchema",
9209
+ "output_required": false,
9210
+ "type": "string",
9211
+ "value_allowed_null": false
9212
+ },
9213
+ {
9214
+ "disabled": false,
9215
+ "document": "目标库表结构",
9216
+ "example": "create table tab1...",
9217
+ "member": "string",
9218
+ "name": "DstSchema",
9219
+ "output_required": false,
9220
+ "type": "string",
9221
+ "value_allowed_null": false
9222
+ }
9223
+ ],
9224
+ "usage": "out"
9225
+ },
8945
9226
  "SkipCheckItemRequest": {
8946
9227
  "document": "SkipCheckItem请求参数结构体",
8947
9228
  "members": [
8948
9229
  {
8949
9230
  "disabled": false,
8950
- "document": "数据迁移任务ID",
9231
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
8951
9232
  "example": "dts-1kl0iy0v",
8952
9233
  "member": "string",
8953
9234
  "name": "JobId",
@@ -8956,7 +9237,7 @@
8956
9237
  },
8957
9238
  {
8958
9239
  "disabled": false,
8959
- "document": "需要跳过校验项的步骤id,需要通过DescribeMigrationCheckJob接口返回StepInfo[i].StepId字段获取,例如:[\"OptimizeCheck\"]",
9240
+ "document": "需要跳过校验项的步骤id,需要通过[DescribeMigrationCheckJob](https://cloud.tencent.com/document/product/571/82086)接口返回StepInfo[i].StepId字段获取,例如:[\"OptimizeCheck\"]",
8960
9241
  "example": "[\"OptimizeCheck\"]",
8961
9242
  "member": "string",
8962
9243
  "name": "StepIds",
@@ -9002,7 +9283,7 @@
9002
9283
  "members": [
9003
9284
  {
9004
9285
  "disabled": false,
9005
- "document": "任务id,如:sync-4ddgid2",
9286
+ "document": "任务id,如:sync-4ddgid2,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
9006
9287
  "example": "sync-4ddgid2",
9007
9288
  "member": "string",
9008
9289
  "name": "JobId",
@@ -9110,7 +9391,7 @@
9110
9391
  "members": [
9111
9392
  {
9112
9393
  "disabled": false,
9113
- "document": "迁移任务 Id",
9394
+ "document": "迁移任务 ID,可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。\n",
9114
9395
  "example": "dts-8yv4w2i1",
9115
9396
  "member": "string",
9116
9397
  "name": "JobId",
@@ -9119,7 +9400,7 @@
9119
9400
  },
9120
9401
  {
9121
9402
  "disabled": false,
9122
- "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
9403
+ "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。\n",
9123
9404
  "example": "dts-8yv4w2i1-cmp-37skmii9",
9124
9405
  "member": "string",
9125
9406
  "name": "CompareTaskId",
@@ -9146,7 +9427,7 @@
9146
9427
  "members": [
9147
9428
  {
9148
9429
  "disabled": false,
9149
- "document": "数据迁移任务ID",
9430
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
9150
9431
  "example": "dts-1kl0iy0v",
9151
9432
  "member": "string",
9152
9433
  "name": "JobId",
@@ -9173,7 +9454,7 @@
9173
9454
  "members": [
9174
9455
  {
9175
9456
  "disabled": false,
9176
- "document": "同步任务id",
9457
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
9177
9458
  "example": "sync-csasssww",
9178
9459
  "member": "string",
9179
9460
  "name": "JobId",
@@ -9200,7 +9481,7 @@
9200
9481
  "members": [
9201
9482
  {
9202
9483
  "disabled": false,
9203
- "document": "数据订阅实例的 ID",
9484
+ "document": "数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。",
9204
9485
  "example": "subs-xxxxxx",
9205
9486
  "member": "string",
9206
9487
  "name": "SubscribeId",
@@ -9227,7 +9508,7 @@
9227
9508
  "members": [
9228
9509
  {
9229
9510
  "disabled": false,
9230
- "document": "同步任务id",
9511
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
9231
9512
  "example": "sync-werwfs23",
9232
9513
  "member": "string",
9233
9514
  "name": "JobId",
@@ -9505,7 +9786,7 @@
9505
9786
  "members": [
9506
9787
  {
9507
9788
  "disabled": false,
9508
- "document": "迁移任务 Id",
9789
+ "document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
9509
9790
  "example": "dts-amm1jw5q",
9510
9791
  "member": "string",
9511
9792
  "name": "JobId",
@@ -9514,7 +9795,7 @@
9514
9795
  },
9515
9796
  {
9516
9797
  "disabled": false,
9517
- "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
9798
+ "document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
9518
9799
  "example": "dts-8yv4w2i1-cmp-37skmii9",
9519
9800
  "member": "string",
9520
9801
  "name": "CompareTaskId",
@@ -9523,7 +9804,7 @@
9523
9804
  },
9524
9805
  {
9525
9806
  "disabled": false,
9526
- "document": "是否强制停止。如果填true,同步任务增量阶段会跳过一致性校验产生的binlog,达到快速恢复任务的效果",
9807
+ "document": "是否强制停止。默认值为false,表示不强制停止;如果填true,同步任务增量阶段会跳过一致性校验产生的binlog,达到快速恢复任务的效果",
9527
9808
  "example": "true",
9528
9809
  "member": "bool",
9529
9810
  "name": "ForceStop",
@@ -9550,7 +9831,7 @@
9550
9831
  "members": [
9551
9832
  {
9552
9833
  "disabled": false,
9553
- "document": "数据迁移任务ID",
9834
+ "document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
9554
9835
  "example": "dts-1kl0iy0v",
9555
9836
  "member": "string",
9556
9837
  "name": "JobId",
@@ -9577,7 +9858,7 @@
9577
9858
  "members": [
9578
9859
  {
9579
9860
  "disabled": false,
9580
- "document": "同步任务id",
9861
+ "document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
9581
9862
  "example": "sync-n8deuq7e",
9582
9863
  "member": "string",
9583
9864
  "name": "JobId",
@@ -9670,7 +9951,7 @@
9670
9951
  },
9671
9952
  {
9672
9953
  "disabled": false,
9673
- "document": "当前步骤状态,可能值为 notStarted,running,finished,failed",
9954
+ "document": "当前步骤状态,可能值为 notStarted-未开始,running-运行中,finished-已完成,failed-失败,unknown-未知",
9674
9955
  "example": "running",
9675
9956
  "member": "string",
9676
9957
  "name": "Status",
@@ -10253,7 +10534,7 @@
10253
10534
  {
10254
10535
  "disabled": false,
10255
10536
  "document": "支持的所有操作",
10256
- "example": "[\"pause\",\"stop\",\"limitRate\",\"view\",\"resize\",\"isolate\",\"postPay2prePay\",\"configureOptObj\",\"modifyPosition\"]",
10537
+ "example": "[\"pause(暂停)\",\"stop(终止)\",\"limitRate(限速)\",\"view(查看)\",\"resize(调整规格)\",\"isolate(隔离)\",\"postPay2prePay(按量转包年包月)\",\"configureOptObj(修改同步对象)\"]",
10257
10538
  "member": "string",
10258
10539
  "name": "AllActions",
10259
10540
  "output_required": true,
@@ -10263,7 +10544,7 @@
10263
10544
  {
10264
10545
  "disabled": false,
10265
10546
  "document": "当前状态能进行的操作\n注意:此字段可能返回 null,表示取不到有效值。",
10266
- "example": "[\"pause\",\"stop\",\"limitRate\",\"view\",\"resize\",\"isolate\",\"postPay2prePay\",\"configureOptObj\"]",
10547
+ "example": "[\"pause(暂停)\",\"stop(终止)\",\"limitRate(限速)\",\"view(查看)\",\"resize(调整规格)\",\"isolate(隔离)\",\"postPay2prePay(按量转包年包月)\",\"configureOptObj(修改同步对象)\"]",
10267
10548
  "member": "string",
10268
10549
  "name": "Actions",
10269
10550
  "output_required": true,
@@ -10322,7 +10603,7 @@
10322
10603
  },
10323
10604
  {
10324
10605
  "disabled": false,
10325
- "document": "源端数据库类型,mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等",
10606
+ "document": "源端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。",
10326
10607
  "example": "mysql",
10327
10608
  "member": "string",
10328
10609
  "name": "SrcDatabaseType",
@@ -10332,7 +10613,7 @@
10332
10613
  },
10333
10614
  {
10334
10615
  "disabled": false,
10335
- "document": "源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)",
10616
+ "document": "源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)",
10336
10617
  "example": "cdb",
10337
10618
  "member": "string",
10338
10619
  "name": "SrcAccessType",
@@ -10382,7 +10663,7 @@
10382
10663
  },
10383
10664
  {
10384
10665
  "disabled": false,
10385
- "document": "目标端数据库类型,mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等",
10666
+ "document": "目标端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。",
10386
10667
  "example": "mysql",
10387
10668
  "member": "string",
10388
10669
  "name": "DstDatabaseType",