tccli 3.0.1407.1__py2.py3-none-any.whl → 3.0.1409.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.
- tccli/__init__.py +1 -1
- tccli/services/ccc/v20200210/api.json +9 -0
- tccli/services/cdb/cdb_client.py +53 -0
- tccli/services/cdb/v20170320/api.json +73 -1
- tccli/services/cdb/v20170320/examples.json +11 -3
- tccli/services/cfg/v20210820/api.json +11 -1
- tccli/services/cfw/v20190904/api.json +1 -1
- tccli/services/ckafka/v20190819/api.json +1 -1
- tccli/services/csip/v20221121/api.json +51 -1
- tccli/services/dbbrain/v20210527/api.json +7 -7
- tccli/services/dcdb/v20180411/api.json +1 -1
- tccli/services/dts/v20211206/api.json +144 -67
- tccli/services/dts/v20211206/examples.json +13 -7
- tccli/services/es/v20180416/api.json +99 -4
- tccli/services/essbasic/v20210526/api.json +3 -3
- tccli/services/essbasic/v20210526/examples.json +6 -6
- tccli/services/gaap/v20180529/api.json +13 -3
- tccli/services/ioa/ioa_client.py +61 -8
- tccli/services/ioa/v20220601/api.json +126 -0
- tccli/services/ioa/v20220601/examples.json +8 -0
- tccli/services/lighthouse/v20200324/api.json +36 -0
- tccli/services/lighthouse/v20200324/examples.json +1 -1
- tccli/services/live/v20180801/examples.json +6 -0
- tccli/services/mariadb/v20170312/api.json +1 -1
- tccli/services/monitor/monitor_client.py +53 -0
- tccli/services/monitor/v20180724/api.json +100 -3
- tccli/services/monitor/v20180724/examples.json +9 -1
- tccli/services/mps/v20190612/api.json +26 -4
- tccli/services/oceanus/v20190422/api.json +9 -12
- tccli/services/oceanus/v20190422/examples.json +2 -2
- tccli/services/ocr/v20181119/api.json +10 -10
- tccli/services/pts/v20210728/api.json +2 -2
- tccli/services/rum/v20210622/api.json +18 -0
- tccli/services/teo/v20220901/api.json +5 -5
- tccli/services/tke/v20180525/api.json +3 -3
- tccli/services/tmt/v20180321/api.json +78 -1
- tccli/services/tsf/v20180326/api.json +3 -0
- tccli/services/vcube/v20220410/api.json +1 -1
- tccli/services/vpc/v20170312/api.json +819 -0
- tccli/services/vpc/v20170312/examples.json +96 -0
- tccli/services/vpc/vpc_client.py +669 -33
- tccli/services/wedata/v20250806/api.json +43 -4
- {tccli-3.0.1407.1.dist-info → tccli-3.0.1409.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1407.1.dist-info → tccli-3.0.1409.1.dist-info}/RECORD +47 -47
- {tccli-3.0.1407.1.dist-info → tccli-3.0.1409.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1407.1.dist-info → tccli-3.0.1409.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1407.1.dist-info → tccli-3.0.1409.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"actions": {
|
|
3
3
|
"CompleteMigrateJob": {
|
|
4
|
-
"document": "本接口(CompleteMigrateJob)用于完成数据迁移任务。\n选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。\n通过DescribeMigrationJobs接口查询到任务的状态为准备完成(Status=\"readyComplete\"
|
|
4
|
+
"document": "本接口(CompleteMigrateJob)用于完成数据迁移任务。\n选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。\n通过DescribeMigrationJobs接口查询到任务的状态为准备完成(Status=\"readyComplete\")时,此时可以调用本接口完成迁移任务。",
|
|
5
5
|
"input": "CompleteMigrateJobRequest",
|
|
6
6
|
"name": "完成数据迁移任务",
|
|
7
7
|
"output": "CompleteMigrateJobResponse",
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
"status": "online"
|
|
128
128
|
},
|
|
129
129
|
"DescribeCompareTasks": {
|
|
130
|
-
"document": "
|
|
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": "
|
|
242
|
+
"document": "隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrateJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。",
|
|
243
243
|
"input": "IsolateMigrateJobRequest",
|
|
244
244
|
"name": "隔离数据迁移任务",
|
|
245
245
|
"output": "IsolateMigrateJobResponse",
|
|
@@ -288,7 +288,7 @@
|
|
|
288
288
|
"status": "online"
|
|
289
289
|
},
|
|
290
290
|
"ModifyMigrateJobSpec": {
|
|
291
|
-
"document": "
|
|
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": "配置迁移服务,配置成功后可通过`
|
|
319
|
+
"document": "配置迁移服务,配置成功后可通过`CreateMigrateCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。",
|
|
320
320
|
"input": "ModifyMigrationJobRequest",
|
|
321
321
|
"name": "配置迁移服务",
|
|
322
322
|
"output": "ModifyMigrationJobResponse",
|
|
@@ -414,7 +414,7 @@
|
|
|
414
414
|
"status": "online"
|
|
415
415
|
},
|
|
416
416
|
"ResumeMigrateJob": {
|
|
417
|
-
"document": "重试数据迁移任务,针对异常情况可进行重试,对于redis
|
|
417
|
+
"document": "重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。",
|
|
418
418
|
"input": "ResumeMigrateJobRequest",
|
|
419
419
|
"name": "重试迁移任务",
|
|
420
420
|
"output": "ResumeMigrateJobResponse",
|
|
@@ -456,7 +456,7 @@
|
|
|
456
456
|
"status": "online"
|
|
457
457
|
},
|
|
458
458
|
"StartMigrateJob": {
|
|
459
|
-
"document": "本接口(
|
|
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
|
|
494
|
+
"document": "本接口(StopMigrateJob)用于终止数据迁移任务。当任务状态为运行中、准备运行、准备完成、错误、暂停、未知等状态时可调用此接口终止任务。\n调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。",
|
|
495
495
|
"input": "StopMigrateJobRequest",
|
|
496
496
|
"name": "终止数据迁移任务",
|
|
497
497
|
"output": "StopMigrateJobResponse",
|
|
@@ -1084,6 +1084,50 @@
|
|
|
1084
1084
|
"required": false,
|
|
1085
1085
|
"type": "int",
|
|
1086
1086
|
"value_allowed_null": false
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"disabled": false,
|
|
1090
|
+
"document": "对比类型:builtin(内置校验)、independent(独立校验)。默认为builtin,mongodb及redis链路不支持独立校验。",
|
|
1091
|
+
"example": "builtin",
|
|
1092
|
+
"member": "string",
|
|
1093
|
+
"name": "Type",
|
|
1094
|
+
"output_required": false,
|
|
1095
|
+
"required": false,
|
|
1096
|
+
"type": "string",
|
|
1097
|
+
"value_allowed_null": false
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"disabled": false,
|
|
1101
|
+
"document": "校验类型,枚举值:structureCheck-结构校验(目前仅postgresql支持)、full-全量校验、increment-增量校验(如果勾选了增量校验,Method只能选dataCheck)、advanceObject-数据库信息校验(目前仅mongodb支持) ",
|
|
1102
|
+
"example": "[\"full\",\"increment\"]",
|
|
1103
|
+
"member": "string",
|
|
1104
|
+
"name": "CompareMode",
|
|
1105
|
+
"output_required": false,
|
|
1106
|
+
"required": false,
|
|
1107
|
+
"type": "list",
|
|
1108
|
+
"value_allowed_null": false
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"disabled": false,
|
|
1112
|
+
"document": "复检次数",
|
|
1113
|
+
"example": "3",
|
|
1114
|
+
"member": "int64",
|
|
1115
|
+
"name": "ReCheckTime",
|
|
1116
|
+
"output_required": false,
|
|
1117
|
+
"required": false,
|
|
1118
|
+
"type": "int",
|
|
1119
|
+
"value_allowed_null": false
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
"disabled": false,
|
|
1123
|
+
"document": "复检时间间隔,单位为分钟,取值 1-60",
|
|
1124
|
+
"example": "5",
|
|
1125
|
+
"member": "int64",
|
|
1126
|
+
"name": "ReCheckInterval",
|
|
1127
|
+
"output_required": false,
|
|
1128
|
+
"required": false,
|
|
1129
|
+
"type": "int",
|
|
1130
|
+
"value_allowed_null": false
|
|
1087
1131
|
}
|
|
1088
1132
|
],
|
|
1089
1133
|
"usage": "both"
|
|
@@ -1321,7 +1365,7 @@
|
|
|
1321
1365
|
"members": [
|
|
1322
1366
|
{
|
|
1323
1367
|
"disabled": false,
|
|
1324
|
-
"document": "数据迁移任务ID",
|
|
1368
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
1325
1369
|
"example": "dts-1kl0iy0v",
|
|
1326
1370
|
"member": "string",
|
|
1327
1371
|
"name": "JobId",
|
|
@@ -1357,7 +1401,7 @@
|
|
|
1357
1401
|
"members": [
|
|
1358
1402
|
{
|
|
1359
1403
|
"disabled": false,
|
|
1360
|
-
"document": "数据订阅实例的 ID",
|
|
1404
|
+
"document": "数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
1361
1405
|
"example": "subs-xxxxxx",
|
|
1362
1406
|
"member": "string",
|
|
1363
1407
|
"name": "SubscribeId",
|
|
@@ -1656,7 +1700,7 @@
|
|
|
1656
1700
|
},
|
|
1657
1701
|
{
|
|
1658
1702
|
"disabled": false,
|
|
1659
|
-
"document": "
|
|
1703
|
+
"document": "条件覆盖操作,目前仅支持>",
|
|
1660
1704
|
"example": ">",
|
|
1661
1705
|
"member": "string",
|
|
1662
1706
|
"name": "ConditionOperator",
|
|
@@ -1667,7 +1711,7 @@
|
|
|
1667
1711
|
},
|
|
1668
1712
|
{
|
|
1669
1713
|
"disabled": false,
|
|
1670
|
-
"document": "
|
|
1714
|
+
"document": "条件覆盖优先级处理,支持类型有>,<,=",
|
|
1671
1715
|
"example": ">",
|
|
1672
1716
|
"member": "string",
|
|
1673
1717
|
"name": "ConditionOrderInSrcAndDst",
|
|
@@ -1692,6 +1736,39 @@
|
|
|
1692
1736
|
"required": false,
|
|
1693
1737
|
"type": "string",
|
|
1694
1738
|
"value_allowed_null": false
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"disabled": false,
|
|
1742
|
+
"document": "校验对象选择。枚举值:sameAsMigrate-与迁移同步任务相同、custom-用户自定义,搭配Objects操作",
|
|
1743
|
+
"example": "custom",
|
|
1744
|
+
"member": "string",
|
|
1745
|
+
"name": "ObjectMode",
|
|
1746
|
+
"output_required": false,
|
|
1747
|
+
"required": false,
|
|
1748
|
+
"type": "string",
|
|
1749
|
+
"value_allowed_null": false
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"disabled": false,
|
|
1753
|
+
"document": "校验对象\n注意:此字段可能返回 null,表示取不到有效值。",
|
|
1754
|
+
"example": "无",
|
|
1755
|
+
"member": "DatabaseTableObject",
|
|
1756
|
+
"name": "Objects",
|
|
1757
|
+
"output_required": false,
|
|
1758
|
+
"required": false,
|
|
1759
|
+
"type": "object",
|
|
1760
|
+
"value_allowed_null": true
|
|
1761
|
+
},
|
|
1762
|
+
{
|
|
1763
|
+
"disabled": false,
|
|
1764
|
+
"document": "校验配置",
|
|
1765
|
+
"example": "无",
|
|
1766
|
+
"member": "CompareOptions",
|
|
1767
|
+
"name": "Options",
|
|
1768
|
+
"output_required": false,
|
|
1769
|
+
"required": false,
|
|
1770
|
+
"type": "object",
|
|
1771
|
+
"value_allowed_null": false
|
|
1695
1772
|
}
|
|
1696
1773
|
],
|
|
1697
1774
|
"usage": "both"
|
|
@@ -1782,7 +1859,7 @@
|
|
|
1782
1859
|
"members": [
|
|
1783
1860
|
{
|
|
1784
1861
|
"disabled": false,
|
|
1785
|
-
"document": "任务 Id",
|
|
1862
|
+
"document": "任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
1786
1863
|
"example": "dts-p1sposne",
|
|
1787
1864
|
"member": "string",
|
|
1788
1865
|
"name": "JobId",
|
|
@@ -2244,7 +2321,7 @@
|
|
|
2244
2321
|
},
|
|
2245
2322
|
{
|
|
2246
2323
|
"disabled": false,
|
|
2247
|
-
"document": "同步任务规格,Standard
|
|
2324
|
+
"document": "同步任务规格,Standard:标准版,目前仅支持Standard规格。",
|
|
2248
2325
|
"example": "Standard",
|
|
2249
2326
|
"member": "string",
|
|
2250
2327
|
"name": "Specification",
|
|
@@ -2323,7 +2400,7 @@
|
|
|
2323
2400
|
{
|
|
2324
2401
|
"disabled": false,
|
|
2325
2402
|
"document": "同步任务ids",
|
|
2326
|
-
"example": "sync-btso140",
|
|
2403
|
+
"example": "[\"sync-btso140\"]",
|
|
2327
2404
|
"member": "string",
|
|
2328
2405
|
"name": "JobIds",
|
|
2329
2406
|
"output_required": true,
|
|
@@ -3149,7 +3226,7 @@
|
|
|
3149
3226
|
},
|
|
3150
3227
|
{
|
|
3151
3228
|
"disabled": false,
|
|
3152
|
-
"document": "高级对象类型,如trigger、function、procedure、event
|
|
3229
|
+
"document": "高级对象类型,如trigger(触发器)、function(函数)、procedure(存储过程)、event(事件)。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型。\n\n> 当前支持高级对象迁移的场景为MySQL、TDSQL-CMySQL、MariaDB、Percona之间的数据迁移。\n注意:此字段可能返回 null,表示取不到有效值。",
|
|
3153
3230
|
"example": "[\"trigger\"]",
|
|
3154
3231
|
"member": "string",
|
|
3155
3232
|
"name": "AdvancedObjects",
|
|
@@ -3194,7 +3271,7 @@
|
|
|
3194
3271
|
"members": [
|
|
3195
3272
|
{
|
|
3196
3273
|
"disabled": false,
|
|
3197
|
-
"document": "迁移任务 Id",
|
|
3274
|
+
"document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
|
|
3198
3275
|
"example": "dts-8yv4w2i1",
|
|
3199
3276
|
"member": "string",
|
|
3200
3277
|
"name": "JobId",
|
|
@@ -3203,7 +3280,7 @@
|
|
|
3203
3280
|
},
|
|
3204
3281
|
{
|
|
3205
3282
|
"disabled": false,
|
|
3206
|
-
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
|
|
3283
|
+
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9。可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
|
|
3207
3284
|
"example": "dts-8yv4w2i1-cmp-37skmii9",
|
|
3208
3285
|
"member": "string",
|
|
3209
3286
|
"name": "CompareTaskId",
|
|
@@ -3480,7 +3557,7 @@
|
|
|
3480
3557
|
"members": [
|
|
3481
3558
|
{
|
|
3482
3559
|
"disabled": false,
|
|
3483
|
-
"document": "迁移任务 Id",
|
|
3560
|
+
"document": "迁移任务 Id,可通过 [DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084) 接口获取。\n",
|
|
3484
3561
|
"example": "dts-e7ukka6g",
|
|
3485
3562
|
"member": "string",
|
|
3486
3563
|
"name": "JobId",
|
|
@@ -3628,7 +3705,7 @@
|
|
|
3628
3705
|
"members": [
|
|
3629
3706
|
{
|
|
3630
3707
|
"disabled": false,
|
|
3631
|
-
"document": "数据库类型,如mysql,redis
|
|
3708
|
+
"document": "数据库类型,如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。",
|
|
3632
3709
|
"example": "mysql",
|
|
3633
3710
|
"member": "string",
|
|
3634
3711
|
"name": "DatabaseType",
|
|
@@ -3646,7 +3723,7 @@
|
|
|
3646
3723
|
},
|
|
3647
3724
|
{
|
|
3648
3725
|
"disabled": false,
|
|
3649
|
-
"document": "云数据库实例ID",
|
|
3726
|
+
"document": "云数据库实例ID,可通过对应业务实例列表获取实例信息。",
|
|
3650
3727
|
"example": "cdb-ktexpqjo",
|
|
3651
3728
|
"member": "string",
|
|
3652
3729
|
"name": "InstanceId",
|
|
@@ -3655,7 +3732,7 @@
|
|
|
3655
3732
|
},
|
|
3656
3733
|
{
|
|
3657
3734
|
"disabled": false,
|
|
3658
|
-
"document": "
|
|
3735
|
+
"document": "云数据库名称,可通过对应业务实例列表获取实例信息。",
|
|
3659
3736
|
"example": "cdb-name1",
|
|
3660
3737
|
"member": "string",
|
|
3661
3738
|
"name": "InstanceName",
|
|
@@ -3823,7 +3900,7 @@
|
|
|
3823
3900
|
"members": [
|
|
3824
3901
|
{
|
|
3825
3902
|
"disabled": false,
|
|
3826
|
-
"document": "数据迁移任务ID",
|
|
3903
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
3827
3904
|
"example": "dts-amm1jw5q",
|
|
3828
3905
|
"member": "string",
|
|
3829
3906
|
"name": "JobId",
|
|
@@ -4375,7 +4452,7 @@
|
|
|
4375
4452
|
"members": [
|
|
4376
4453
|
{
|
|
4377
4454
|
"disabled": false,
|
|
4378
|
-
"document": "数据订阅实例的 ID",
|
|
4455
|
+
"document": "数据订阅实例的 ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
4379
4456
|
"example": "subs-l4d3a7izai",
|
|
4380
4457
|
"member": "string",
|
|
4381
4458
|
"name": "SubscribeId",
|
|
@@ -4410,7 +4487,7 @@
|
|
|
4410
4487
|
},
|
|
4411
4488
|
{
|
|
4412
4489
|
"disabled": false,
|
|
4413
|
-
"document": "任务运行状态,可能值为 running,failed,success",
|
|
4490
|
+
"document": "任务运行状态,可能值为 running(运行中),failed(失败),success(成功),unknown(未知状态)。",
|
|
4414
4491
|
"example": "success",
|
|
4415
4492
|
"member": "string",
|
|
4416
4493
|
"name": "Status",
|
|
@@ -5021,7 +5098,7 @@
|
|
|
5021
5098
|
"members": [
|
|
5022
5099
|
{
|
|
5023
5100
|
"disabled": false,
|
|
5024
|
-
"document": "同步任务id,如sync-werwfs23",
|
|
5101
|
+
"document": "同步任务id,如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
|
|
5025
5102
|
"example": "sync-n3gh7md9",
|
|
5026
5103
|
"member": "string",
|
|
5027
5104
|
"name": "JobId",
|
|
@@ -5030,7 +5107,7 @@
|
|
|
5030
5107
|
},
|
|
5031
5108
|
{
|
|
5032
5109
|
"disabled": false,
|
|
5033
|
-
"document": "同步任务id列表,如sync-
|
|
5110
|
+
"document": "同步任务id列表,如[\"sync-n3gh7md9\"]",
|
|
5034
5111
|
"example": "[\"sync-n3gh7md9\"]",
|
|
5035
5112
|
"member": "string",
|
|
5036
5113
|
"name": "JobIds",
|
|
@@ -5048,7 +5125,7 @@
|
|
|
5048
5125
|
},
|
|
5049
5126
|
{
|
|
5050
5127
|
"disabled": false,
|
|
5051
|
-
"document": "
|
|
5128
|
+
"document": "排序字段,目前仅支持CreateTime字段排序",
|
|
5052
5129
|
"example": "CreateTime",
|
|
5053
5130
|
"member": "string",
|
|
5054
5131
|
"name": "Order",
|
|
@@ -5084,8 +5161,8 @@
|
|
|
5084
5161
|
},
|
|
5085
5162
|
{
|
|
5086
5163
|
"disabled": false,
|
|
5087
|
-
"document": "状态集合,如Initialized,CheckPass,Running,ResumableErr,Stopped",
|
|
5088
|
-
"example": "Running",
|
|
5164
|
+
"document": "状态集合,如Initialized(初始化),CheckPass(校验通过),Running(运行中),ResumableErr(恢复中),Stopped(已结束)",
|
|
5165
|
+
"example": "[\"Running\"]",
|
|
5089
5166
|
"member": "string",
|
|
5090
5167
|
"name": "Status",
|
|
5091
5168
|
"required": false,
|
|
@@ -5102,7 +5179,7 @@
|
|
|
5102
5179
|
},
|
|
5103
5180
|
{
|
|
5104
5181
|
"disabled": false,
|
|
5105
|
-
"document": "任务类型,如mysql2mysql:msyql同步到mysql",
|
|
5182
|
+
"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
5183
|
"example": "mysql2mysql",
|
|
5107
5184
|
"member": "string",
|
|
5108
5185
|
"name": "JobType",
|
|
@@ -6551,7 +6628,7 @@
|
|
|
6551
6628
|
"members": [
|
|
6552
6629
|
{
|
|
6553
6630
|
"disabled": false,
|
|
6554
|
-
"document": "任务id",
|
|
6631
|
+
"document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
6555
6632
|
"example": "dts-amm1jw5q",
|
|
6556
6633
|
"member": "string",
|
|
6557
6634
|
"name": "JobId",
|
|
@@ -7187,7 +7264,7 @@
|
|
|
7187
7264
|
"members": [
|
|
7188
7265
|
{
|
|
7189
7266
|
"disabled": false,
|
|
7190
|
-
"document": "迁移任务 Id",
|
|
7267
|
+
"document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7191
7268
|
"example": "dts-8yv4w2i1",
|
|
7192
7269
|
"member": "string",
|
|
7193
7270
|
"name": "JobId",
|
|
@@ -7196,7 +7273,7 @@
|
|
|
7196
7273
|
},
|
|
7197
7274
|
{
|
|
7198
7275
|
"disabled": false,
|
|
7199
|
-
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
|
|
7276
|
+
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7200
7277
|
"example": "dts-8yv4w2i1-cmp-37skmii9",
|
|
7201
7278
|
"member": "string",
|
|
7202
7279
|
"name": "CompareTaskId",
|
|
@@ -7232,7 +7309,7 @@
|
|
|
7232
7309
|
"members": [
|
|
7233
7310
|
{
|
|
7234
7311
|
"disabled": false,
|
|
7235
|
-
"document": "任务 Id",
|
|
7312
|
+
"document": "任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7236
7313
|
"example": "dts-45jhpmjh",
|
|
7237
7314
|
"member": "string",
|
|
7238
7315
|
"name": "JobId",
|
|
@@ -7241,7 +7318,7 @@
|
|
|
7241
7318
|
},
|
|
7242
7319
|
{
|
|
7243
7320
|
"disabled": false,
|
|
7244
|
-
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9",
|
|
7321
|
+
"document": "对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7245
7322
|
"example": "dts-45jhpmjh-cmp-k7uhq1v3",
|
|
7246
7323
|
"member": "string",
|
|
7247
7324
|
"name": "CompareTaskId",
|
|
@@ -7412,7 +7489,7 @@
|
|
|
7412
7489
|
"members": [
|
|
7413
7490
|
{
|
|
7414
7491
|
"disabled": false,
|
|
7415
|
-
"document": "任务id",
|
|
7492
|
+
"document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7416
7493
|
"example": "dts-j7bt5sid",
|
|
7417
7494
|
"member": "string",
|
|
7418
7495
|
"name": "JobId",
|
|
@@ -7448,7 +7525,7 @@
|
|
|
7448
7525
|
"members": [
|
|
7449
7526
|
{
|
|
7450
7527
|
"disabled": false,
|
|
7451
|
-
"document": "迁移任务id",
|
|
7528
|
+
"document": "迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7452
7529
|
"example": "dts-7itt1j4w",
|
|
7453
7530
|
"member": "string",
|
|
7454
7531
|
"name": "JobId",
|
|
@@ -7484,7 +7561,7 @@
|
|
|
7484
7561
|
"members": [
|
|
7485
7562
|
{
|
|
7486
7563
|
"disabled": false,
|
|
7487
|
-
"document": "迁移任务
|
|
7564
|
+
"document": "迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。",
|
|
7488
7565
|
"example": "dts-saasxa",
|
|
7489
7566
|
"member": "string",
|
|
7490
7567
|
"name": "JobId",
|
|
@@ -7556,7 +7633,7 @@
|
|
|
7556
7633
|
"members": [
|
|
7557
7634
|
{
|
|
7558
7635
|
"disabled": false,
|
|
7559
|
-
"document": "迁移任务id
|
|
7636
|
+
"document": "迁移任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7560
7637
|
"example": "dts-7itt1j4w",
|
|
7561
7638
|
"member": "string",
|
|
7562
7639
|
"name": "JobId",
|
|
@@ -7592,7 +7669,7 @@
|
|
|
7592
7669
|
"members": [
|
|
7593
7670
|
{
|
|
7594
7671
|
"disabled": false,
|
|
7595
|
-
"document": "任务id",
|
|
7672
|
+
"document": "任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
7596
7673
|
"example": "dts-1ewjspuw",
|
|
7597
7674
|
"member": "string",
|
|
7598
7675
|
"name": "JobId",
|
|
@@ -7835,7 +7912,7 @@
|
|
|
7835
7912
|
"members": [
|
|
7836
7913
|
{
|
|
7837
7914
|
"disabled": false,
|
|
7838
|
-
"document": "同步任务
|
|
7915
|
+
"document": "同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
7839
7916
|
"example": "sync-adasasww",
|
|
7840
7917
|
"member": "string",
|
|
7841
7918
|
"name": "JobId",
|
|
@@ -7880,8 +7957,8 @@
|
|
|
7880
7957
|
"members": [
|
|
7881
7958
|
{
|
|
7882
7959
|
"disabled": false,
|
|
7883
|
-
"document": "
|
|
7884
|
-
"example": "
|
|
7960
|
+
"document": "同步任务ID,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
7961
|
+
"example": "sync-saasxa",
|
|
7885
7962
|
"member": "string",
|
|
7886
7963
|
"name": "JobId",
|
|
7887
7964
|
"required": true,
|
|
@@ -7898,7 +7975,7 @@
|
|
|
7898
7975
|
},
|
|
7899
7976
|
{
|
|
7900
7977
|
"disabled": false,
|
|
7901
|
-
"document": "同步任务全量导出的 Rps 限制、需要大于 0",
|
|
7978
|
+
"document": "同步任务全量导出的 Rps 限制、需要大于 0;对于mongodb最大值为20000,其他数据库最大值为50000000",
|
|
7902
7979
|
"example": "20000",
|
|
7903
7980
|
"member": "int64",
|
|
7904
7981
|
"name": "DumpRps",
|
|
@@ -8074,7 +8151,7 @@
|
|
|
8074
8151
|
"members": [
|
|
8075
8152
|
{
|
|
8076
8153
|
"disabled": false,
|
|
8077
|
-
"document": "
|
|
8154
|
+
"document": "状态,ON-启用,OFF-不启用。",
|
|
8078
8155
|
"example": "ON",
|
|
8079
8156
|
"member": "string",
|
|
8080
8157
|
"name": "Status",
|
|
@@ -8631,7 +8708,7 @@
|
|
|
8631
8708
|
"members": [
|
|
8632
8709
|
{
|
|
8633
8710
|
"disabled": false,
|
|
8634
|
-
"document": "订阅实例id",
|
|
8711
|
+
"document": "订阅实例id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
8635
8712
|
"example": "subs-7l2ly86kao",
|
|
8636
8713
|
"member": "string",
|
|
8637
8714
|
"name": "SubscribeId",
|
|
@@ -8640,7 +8717,7 @@
|
|
|
8640
8717
|
},
|
|
8641
8718
|
{
|
|
8642
8719
|
"disabled": false,
|
|
8643
|
-
"document": "订阅的kafka topic",
|
|
8720
|
+
"document": "订阅的kafka topic,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
8644
8721
|
"example": "topic-subs-7l2ly86kao-cdb-5jr9ms95",
|
|
8645
8722
|
"member": "string",
|
|
8646
8723
|
"name": "TopicName",
|
|
@@ -8649,7 +8726,7 @@
|
|
|
8649
8726
|
},
|
|
8650
8727
|
{
|
|
8651
8728
|
"disabled": false,
|
|
8652
|
-
"document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}",
|
|
8729
|
+
"document": "消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/api/571/102947)接口获取。",
|
|
8653
8730
|
"example": "consumer-grp-subs-7l2ly86kao-group-1",
|
|
8654
8731
|
"member": "string",
|
|
8655
8732
|
"name": "ConsumerGroupName",
|
|
@@ -8658,7 +8735,7 @@
|
|
|
8658
8735
|
},
|
|
8659
8736
|
{
|
|
8660
8737
|
"disabled": false,
|
|
8661
|
-
"document": "需要修改offset
|
|
8738
|
+
"document": "需要修改offset的分区编号,可通过[DescribeOffsetByTime](https://cloud.tencent.com/document/api/571/102946)接口获取。",
|
|
8662
8739
|
"example": "[0,1,2,3]",
|
|
8663
8740
|
"member": "int64",
|
|
8664
8741
|
"name": "PartitionNos",
|
|
@@ -8757,7 +8834,7 @@
|
|
|
8757
8834
|
"members": [
|
|
8758
8835
|
{
|
|
8759
8836
|
"disabled": false,
|
|
8760
|
-
"document": "同步任务id",
|
|
8837
|
+
"document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
|
|
8761
8838
|
"example": "sync-werwfs23",
|
|
8762
8839
|
"member": "string",
|
|
8763
8840
|
"name": "JobId",
|
|
@@ -8766,7 +8843,7 @@
|
|
|
8766
8843
|
},
|
|
8767
8844
|
{
|
|
8768
8845
|
"disabled": false,
|
|
8769
|
-
"document": "
|
|
8846
|
+
"document": "任务规格,可选值包括micro,small,medium,large",
|
|
8770
8847
|
"example": "small",
|
|
8771
8848
|
"member": "string",
|
|
8772
8849
|
"name": "NewInstanceClass",
|
|
@@ -8793,7 +8870,7 @@
|
|
|
8793
8870
|
"members": [
|
|
8794
8871
|
{
|
|
8795
8872
|
"disabled": false,
|
|
8796
|
-
"document": "数据迁移任务ID",
|
|
8873
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
8797
8874
|
"example": "dts-1kl0iy0v",
|
|
8798
8875
|
"member": "string",
|
|
8799
8876
|
"name": "JobId",
|
|
@@ -8803,7 +8880,7 @@
|
|
|
8803
8880
|
{
|
|
8804
8881
|
"disabled": false,
|
|
8805
8882
|
"document": "恢复任务的模式,目前的取值有:clearData 清空目标实例数据,overwrite 以覆盖写的方式执行任务,normal 跟正常流程一样,不做额外动作;注意,clearData、overwrite仅对redis生效,normal仅针对非redis链路生效",
|
|
8806
|
-
"example": "overwrite
|
|
8883
|
+
"example": "overwrite",
|
|
8807
8884
|
"member": "string",
|
|
8808
8885
|
"name": "ResumeOption",
|
|
8809
8886
|
"required": false,
|
|
@@ -8957,7 +9034,7 @@
|
|
|
8957
9034
|
"members": [
|
|
8958
9035
|
{
|
|
8959
9036
|
"disabled": false,
|
|
8960
|
-
"document": "数据迁移任务ID",
|
|
9037
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
8961
9038
|
"example": "dts-1kl0iy0v",
|
|
8962
9039
|
"member": "string",
|
|
8963
9040
|
"name": "JobId",
|
|
@@ -8966,7 +9043,7 @@
|
|
|
8966
9043
|
},
|
|
8967
9044
|
{
|
|
8968
9045
|
"disabled": false,
|
|
8969
|
-
"document": "需要跳过校验项的步骤id,需要通过DescribeMigrationCheckJob接口返回StepInfo[i].StepId字段获取,例如:[\"OptimizeCheck\"]",
|
|
9046
|
+
"document": "需要跳过校验项的步骤id,需要通过[DescribeMigrationCheckJob](https://cloud.tencent.com/document/product/571/82086)接口返回StepInfo[i].StepId字段获取,例如:[\"OptimizeCheck\"]",
|
|
8970
9047
|
"example": "[\"OptimizeCheck\"]",
|
|
8971
9048
|
"member": "string",
|
|
8972
9049
|
"name": "StepIds",
|
|
@@ -9012,7 +9089,7 @@
|
|
|
9012
9089
|
"members": [
|
|
9013
9090
|
{
|
|
9014
9091
|
"disabled": false,
|
|
9015
|
-
"document": "任务id,如:sync-4ddgid2",
|
|
9092
|
+
"document": "任务id,如:sync-4ddgid2,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。\n",
|
|
9016
9093
|
"example": "sync-4ddgid2",
|
|
9017
9094
|
"member": "string",
|
|
9018
9095
|
"name": "JobId",
|
|
@@ -9156,7 +9233,7 @@
|
|
|
9156
9233
|
"members": [
|
|
9157
9234
|
{
|
|
9158
9235
|
"disabled": false,
|
|
9159
|
-
"document": "数据迁移任务ID",
|
|
9236
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
9160
9237
|
"example": "dts-1kl0iy0v",
|
|
9161
9238
|
"member": "string",
|
|
9162
9239
|
"name": "JobId",
|
|
@@ -9237,7 +9314,7 @@
|
|
|
9237
9314
|
"members": [
|
|
9238
9315
|
{
|
|
9239
9316
|
"disabled": false,
|
|
9240
|
-
"document": "同步任务id",
|
|
9317
|
+
"document": "同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。",
|
|
9241
9318
|
"example": "sync-werwfs23",
|
|
9242
9319
|
"member": "string",
|
|
9243
9320
|
"name": "JobId",
|
|
@@ -9560,7 +9637,7 @@
|
|
|
9560
9637
|
"members": [
|
|
9561
9638
|
{
|
|
9562
9639
|
"disabled": false,
|
|
9563
|
-
"document": "数据迁移任务ID",
|
|
9640
|
+
"document": "数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。\n",
|
|
9564
9641
|
"example": "dts-1kl0iy0v",
|
|
9565
9642
|
"member": "string",
|
|
9566
9643
|
"name": "JobId",
|
|
@@ -9680,7 +9757,7 @@
|
|
|
9680
9757
|
},
|
|
9681
9758
|
{
|
|
9682
9759
|
"disabled": false,
|
|
9683
|
-
"document": "当前步骤状态,可能值为 notStarted
|
|
9760
|
+
"document": "当前步骤状态,可能值为 notStarted-未开始,running-运行中,finished-已完成,failed-失败,unknown-未知",
|
|
9684
9761
|
"example": "running",
|
|
9685
9762
|
"member": "string",
|
|
9686
9763
|
"name": "Status",
|
|
@@ -10263,7 +10340,7 @@
|
|
|
10263
10340
|
{
|
|
10264
10341
|
"disabled": false,
|
|
10265
10342
|
"document": "支持的所有操作",
|
|
10266
|
-
"example": "[\"pause
|
|
10343
|
+
"example": "[\"pause(暂停)\",\"stop(终止)\",\"limitRate(限速)\",\"view(查看)\",\"resize(调整规格)\",\"isolate(隔离)\",\"postPay2prePay(按量转包年包月)\",\"configureOptObj(修改同步对象)\"]",
|
|
10267
10344
|
"member": "string",
|
|
10268
10345
|
"name": "AllActions",
|
|
10269
10346
|
"output_required": true,
|
|
@@ -10273,7 +10350,7 @@
|
|
|
10273
10350
|
{
|
|
10274
10351
|
"disabled": false,
|
|
10275
10352
|
"document": "当前状态能进行的操作\n注意:此字段可能返回 null,表示取不到有效值。",
|
|
10276
|
-
"example": "[\"pause
|
|
10353
|
+
"example": "[\"pause(暂停)\",\"stop(终止)\",\"limitRate(限速)\",\"view(查看)\",\"resize(调整规格)\",\"isolate(隔离)\",\"postPay2prePay(按量转包年包月)\",\"configureOptObj(修改同步对象)\"]",
|
|
10277
10354
|
"member": "string",
|
|
10278
10355
|
"name": "Actions",
|
|
10279
10356
|
"output_required": true,
|
|
@@ -10332,7 +10409,7 @@
|
|
|
10332
10409
|
},
|
|
10333
10410
|
{
|
|
10334
10411
|
"disabled": false,
|
|
10335
|
-
"document": "源端数据库类型,mysql,cynosdbmysql,
|
|
10412
|
+
"document": "源端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。",
|
|
10336
10413
|
"example": "mysql",
|
|
10337
10414
|
"member": "string",
|
|
10338
10415
|
"name": "SrcDatabaseType",
|
|
@@ -10342,7 +10419,7 @@
|
|
|
10342
10419
|
},
|
|
10343
10420
|
{
|
|
10344
10421
|
"disabled": false,
|
|
10345
|
-
"document": "源端接入类型,cdb(云数据库)、cvm(
|
|
10422
|
+
"document": "源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)",
|
|
10346
10423
|
"example": "cdb",
|
|
10347
10424
|
"member": "string",
|
|
10348
10425
|
"name": "SrcAccessType",
|
|
@@ -10392,7 +10469,7 @@
|
|
|
10392
10469
|
},
|
|
10393
10470
|
{
|
|
10394
10471
|
"disabled": false,
|
|
10395
|
-
"document": "目标端数据库类型,mysql,cynosdbmysql,
|
|
10472
|
+
"document": "目标端数据库类型,mysql,tdsqlmysql,mariadb,cynosdbmysql(表示tdsql-c实例),tdstore,percona,postgresql,mongodb等。",
|
|
10396
10473
|
"example": "mysql",
|
|
10397
10474
|
"member": "string",
|
|
10398
10475
|
"name": "DstDatabaseType",
|