tencentcloud-sdk-nodejs 4.0.470 → 4.0.471

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/CHANGELOG.md +230 -0
  2. package/SERVICE_CHANGELOG.md +404 -265
  3. package/package.json +1 -1
  4. package/products.md +40 -40
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ccc/v20200210/ccc_client.ts +143 -70
  7. package/src/services/ccc/v20200210/ccc_models.ts +1373 -1083
  8. package/src/services/ckafka/v20190819/ckafka_client.ts +1 -0
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +17 -0
  10. package/src/services/dts/index.ts +2 -0
  11. package/src/services/dts/v20211206/dts_client.ts +520 -0
  12. package/src/services/dts/v20211206/dts_models.ts +3518 -0
  13. package/src/services/dts/v20211206/index.ts +6 -0
  14. package/src/services/ess/v20201111/ess_models.ts +6 -1
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +5 -0
  16. package/src/services/ivld/v20210903/ivld_models.ts +3 -3
  17. package/src/services/soe/v20180724/soe_models.ts +70 -0
  18. package/src/services/teo/v20220901/teo_models.ts +39 -26
  19. package/tencentcloud/common/sdk_version.d.ts +1 -1
  20. package/tencentcloud/common/sdk_version.js +1 -1
  21. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +31 -7
  22. package/tencentcloud/services/ccc/v20200210/ccc_client.js +45 -9
  23. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1260 -1015
  24. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +15 -0
  25. package/tencentcloud/services/dts/index.d.ts +4 -0
  26. package/tencentcloud/services/dts/index.js +2 -0
  27. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +163 -0
  28. package/tencentcloud/services/dts/v20211206/dts_client.js +256 -0
  29. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +2989 -0
  30. package/tencentcloud/services/dts/v20211206/dts_models.js +18 -0
  31. package/tencentcloud/services/dts/v20211206/index.d.ts +6 -0
  32. package/tencentcloud/services/dts/v20211206/index.js +9 -0
  33. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +6 -1
  34. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +5 -0
  35. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +3 -3
  36. package/tencentcloud/services/soe/v20180724/soe_models.d.ts +58 -0
  37. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +36 -26
  38. package/test/ccc.v20200210.test.js +66 -6
  39. package/test/dts.v20211206.test.js +381 -0
@@ -0,0 +1,3518 @@
1
+ /*
2
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing,
11
+ * software distributed under the License is distributed on an
12
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
+ * KIND, either express or implied. See the License for the
14
+ * specific language governing permissions and limitations
15
+ * under the License.
16
+ */
17
+
18
+ /**
19
+ * ModifyCompareTask返回参数结构体
20
+ */
21
+ export interface ModifyCompareTaskResponse {
22
+ /**
23
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string
26
+ }
27
+
28
+ /**
29
+ * DescribeSyncJobs返回参数结构体
30
+ */
31
+ export interface DescribeSyncJobsResponse {
32
+ /**
33
+ * 任务数目
34
+ 注意:此字段可能返回 null,表示取不到有效值。
35
+ */
36
+ TotalCount: number
37
+
38
+ /**
39
+ * 任务详情数组
40
+ 注意:此字段可能返回 null,表示取不到有效值。
41
+ */
42
+ JobList: Array<SyncJobInfo>
43
+
44
+ /**
45
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
46
+ */
47
+ RequestId?: string
48
+ }
49
+
50
+ /**
51
+ * ModifyMigrationJob返回参数结构体
52
+ */
53
+ export interface ModifyMigrationJobResponse {
54
+ /**
55
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
56
+ */
57
+ RequestId?: string
58
+ }
59
+
60
+ /**
61
+ * ModifyMigrateJobSpec请求参数结构体
62
+ */
63
+ export interface ModifyMigrateJobSpecRequest {
64
+ /**
65
+ * 任务id
66
+ */
67
+ JobId: string
68
+
69
+ /**
70
+ * 新实例规格大小,包括:micro、small、medium、large、xlarge、2xlarge
71
+ */
72
+ NewInstanceClass: string
73
+ }
74
+
75
+ /**
76
+ * StartMigrateJob请求参数结构体
77
+ */
78
+ export interface StartMigrateJobRequest {
79
+ /**
80
+ * 数据迁移任务ID
81
+ */
82
+ JobId: string
83
+ }
84
+
85
+ /**
86
+ * 当前步骤错误信息或者警告信息
87
+ */
88
+ export interface StepTip {
89
+ /**
90
+ * 错误码
91
+ 注意:此字段可能返回 null,表示取不到有效值。
92
+ */
93
+ Code?: string
94
+
95
+ /**
96
+ * 错误信息
97
+ 注意:此字段可能返回 null,表示取不到有效值。
98
+ */
99
+ Message?: string
100
+
101
+ /**
102
+ * 解决方式
103
+ 注意:此字段可能返回 null,表示取不到有效值。
104
+ */
105
+ Solution?: string
106
+
107
+ /**
108
+ * 帮助文档
109
+ 注意:此字段可能返回 null,表示取不到有效值。
110
+ */
111
+ HelpDoc?: string
112
+ }
113
+
114
+ /**
115
+ * DestroyMigrateJob请求参数结构体
116
+ */
117
+ export interface DestroyMigrateJobRequest {
118
+ /**
119
+ * 任务id
120
+ */
121
+ JobId?: string
122
+ }
123
+
124
+ /**
125
+ * ResizeSyncJob返回参数结构体
126
+ */
127
+ export interface ResizeSyncJobResponse {
128
+ /**
129
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
130
+ */
131
+ RequestId?: string
132
+ }
133
+
134
+ /**
135
+ * ResumeMigrateJob返回参数结构体
136
+ */
137
+ export interface ResumeMigrateJobResponse {
138
+ /**
139
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
140
+ */
141
+ RequestId?: string
142
+ }
143
+
144
+ /**
145
+ * 校验不一致的表详情
146
+ */
147
+ export interface DifferenceItem {
148
+ /**
149
+ * 数据库名
150
+ 注意:此字段可能返回 null,表示取不到有效值。
151
+ */
152
+ Db: string
153
+
154
+ /**
155
+ * 表名
156
+ 注意:此字段可能返回 null,表示取不到有效值。
157
+ */
158
+ Table: string
159
+
160
+ /**
161
+ * 分块号
162
+ 注意:此字段可能返回 null,表示取不到有效值。
163
+ */
164
+ Chunk: number
165
+
166
+ /**
167
+ * 源库数值
168
+ 注意:此字段可能返回 null,表示取不到有效值。
169
+ */
170
+ SrcItem: string
171
+
172
+ /**
173
+ * 目标库数值
174
+ 注意:此字段可能返回 null,表示取不到有效值。
175
+ */
176
+ DstItem: string
177
+
178
+ /**
179
+ * 索引名称
180
+ 注意:此字段可能返回 null,表示取不到有效值。
181
+ */
182
+ IndexName: string
183
+
184
+ /**
185
+ * 索引下边界
186
+ 注意:此字段可能返回 null,表示取不到有效值。
187
+ */
188
+ LowerBoundary: string
189
+
190
+ /**
191
+ * 索引上边界
192
+ 注意:此字段可能返回 null,表示取不到有效值。
193
+ */
194
+ UpperBoundary: string
195
+
196
+ /**
197
+ * 对比消耗时间,单位为 ms
198
+ 注意:此字段可能返回 null,表示取不到有效值。
199
+ */
200
+ CostTime: number
201
+
202
+ /**
203
+ * 完成时间
204
+ 注意:此字段可能返回 null,表示取不到有效值。
205
+ */
206
+ FinishedAt: string
207
+ }
208
+
209
+ /**
210
+ * IsolateSyncJob请求参数结构体
211
+ */
212
+ export interface IsolateSyncJobRequest {
213
+ /**
214
+ * 同步任务id
215
+ */
216
+ JobId: string
217
+ }
218
+
219
+ /**
220
+ * DescribeCheckSyncJobResult请求参数结构体
221
+ */
222
+ export interface DescribeCheckSyncJobResultRequest {
223
+ /**
224
+ * 同步任务id
225
+ */
226
+ JobId?: string
227
+ }
228
+
229
+ /**
230
+ * DestroySyncJob返回参数结构体
231
+ */
232
+ export interface DestroySyncJobResponse {
233
+ /**
234
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
235
+ */
236
+ RequestId?: string
237
+ }
238
+
239
+ /**
240
+ * DescribeCompareReport返回参数结构体
241
+ */
242
+ export interface DescribeCompareReportResponse {
243
+ /**
244
+ * 一致性校验摘要信息
245
+ 注意:此字段可能返回 null,表示取不到有效值。
246
+ */
247
+ Abstract: CompareAbstractInfo
248
+
249
+ /**
250
+ * 一致性校验详细信息
251
+ 注意:此字段可能返回 null,表示取不到有效值。
252
+ */
253
+ Detail: CompareDetailInfo
254
+
255
+ /**
256
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
257
+ */
258
+ RequestId?: string
259
+ }
260
+
261
+ /**
262
+ * IsolateMigrateJob请求参数结构体
263
+ */
264
+ export interface IsolateMigrateJobRequest {
265
+ /**
266
+ * 任务id
267
+ */
268
+ JobId: string
269
+ }
270
+
271
+ /**
272
+ * StopMigrateJob返回参数结构体
273
+ */
274
+ export interface StopMigrateJobResponse {
275
+ /**
276
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
277
+ */
278
+ RequestId?: string
279
+ }
280
+
281
+ /**
282
+ * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
283
+ */
284
+ export interface TableItem {
285
+ /**
286
+ * 迁移的表名
287
+ 注意:此字段可能返回 null,表示取不到有效值。
288
+ */
289
+ TableName?: string
290
+
291
+ /**
292
+ * 迁移后的表名,当TableEditMode为rename时此项必填
293
+ 注意:此字段可能返回 null,表示取不到有效值。
294
+ */
295
+ NewTableName?: string
296
+
297
+ /**
298
+ * 迁移临时表,针对pt-osc等工具在迁移过程中产生的临时表同步,需要提前将可能的临时表配置在这里,当TableEditMode为pt时此项必填
299
+ 注意:此字段可能返回 null,表示取不到有效值。
300
+ */
301
+ TmpTables?: Array<string>
302
+
303
+ /**
304
+ * 编辑表类型,rename(表映射),pt(同步附加表)
305
+ 注意:此字段可能返回 null,表示取不到有效值。
306
+ */
307
+ TableEditMode?: string
308
+ }
309
+
310
+ /**
311
+ * ModifyCompareTaskName请求参数结构体
312
+ */
313
+ export interface ModifyCompareTaskNameRequest {
314
+ /**
315
+ * 迁移任务 Id
316
+ */
317
+ JobId: string
318
+
319
+ /**
320
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
321
+ */
322
+ CompareTaskId: string
323
+
324
+ /**
325
+ * 一致性校验任务名称
326
+ */
327
+ TaskName: string
328
+ }
329
+
330
+ /**
331
+ * CompleteMigrateJob返回参数结构体
332
+ */
333
+ export interface CompleteMigrateJobResponse {
334
+ /**
335
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
336
+ */
337
+ RequestId?: string
338
+ }
339
+
340
+ /**
341
+ * DescribeMigrateDBInstances返回参数结构体
342
+ */
343
+ export interface DescribeMigrateDBInstancesResponse {
344
+ /**
345
+ * 符合筛选条件的数量
346
+ 注意:此字段可能返回 null,表示取不到有效值。
347
+ */
348
+ TotalCount: number
349
+
350
+ /**
351
+ * 实例列表
352
+ 注意:此字段可能返回 null,表示取不到有效值。
353
+ */
354
+ Instances: Array<MigrateDBItem>
355
+
356
+ /**
357
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
358
+ */
359
+ RequestId?: string
360
+ }
361
+
362
+ /**
363
+ * 存放配置时的额外信息
364
+ */
365
+ export interface KeyValuePairOption {
366
+ /**
367
+ * 选项key
368
+ 注意:此字段可能返回 null,表示取不到有效值。
369
+ */
370
+ Key?: string
371
+
372
+ /**
373
+ * 选项value
374
+ 注意:此字段可能返回 null,表示取不到有效值。
375
+ */
376
+ Value?: string
377
+ }
378
+
379
+ /**
380
+ * CreateCheckSyncJob请求参数结构体
381
+ */
382
+ export interface CreateCheckSyncJobRequest {
383
+ /**
384
+ * 同步任务id
385
+ */
386
+ JobId: string
387
+ }
388
+
389
+ /**
390
+ * StopSyncJob请求参数结构体
391
+ */
392
+ export interface StopSyncJobRequest {
393
+ /**
394
+ * 同步任务id
395
+ */
396
+ JobId: string
397
+ }
398
+
399
+ /**
400
+ * DescribeMigrationDetail请求参数结构体
401
+ */
402
+ export interface DescribeMigrationDetailRequest {
403
+ /**
404
+ * 数据迁移任务ID
405
+ */
406
+ JobId: string
407
+ }
408
+
409
+ /**
410
+ * DestroySyncJob请求参数结构体
411
+ */
412
+ export interface DestroySyncJobRequest {
413
+ /**
414
+ * 同步任务id
415
+ */
416
+ JobId: string
417
+ }
418
+
419
+ /**
420
+ * ResizeSyncJob请求参数结构体
421
+ */
422
+ export interface ResizeSyncJobRequest {
423
+ /**
424
+ * 同步任务id
425
+ */
426
+ JobId: string
427
+
428
+ /**
429
+ * 任务规格
430
+ */
431
+ NewInstanceClass: string
432
+ }
433
+
434
+ /**
435
+ * 数据同步中的ddl同步处理
436
+ */
437
+ export interface DdlOption {
438
+ /**
439
+ * ddl类型,如database,table,view等
440
+ 注意:此字段可能返回 null,表示取不到有效值。
441
+ */
442
+ DdlObject?: string
443
+
444
+ /**
445
+ * ddl具体值,如Create,Drop等
446
+ 注意:此字段可能返回 null,表示取不到有效值。
447
+ */
448
+ DdlValue?: Array<string>
449
+ }
450
+
451
+ /**
452
+ * 冲突处理里的详细描述
453
+ */
454
+ export interface ConflictHandleOption {
455
+ /**
456
+ * 条件覆盖的列
457
+ 注意:此字段可能返回 null,表示取不到有效值。
458
+ */
459
+ ConditionColumn?: string
460
+
461
+ /**
462
+ * 条件覆盖操作
463
+ 注意:此字段可能返回 null,表示取不到有效值。
464
+ */
465
+ ConditionOperator?: string
466
+
467
+ /**
468
+ * 条件覆盖优先级处理
469
+ 注意:此字段可能返回 null,表示取不到有效值。
470
+ */
471
+ ConditionOrderInSrcAndDst?: string
472
+ }
473
+
474
+ /**
475
+ * ResumeSyncJob返回参数结构体
476
+ */
477
+ export interface ResumeSyncJobResponse {
478
+ /**
479
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
480
+ */
481
+ RequestId?: string
482
+ }
483
+
484
+ /**
485
+ * ModifyCompareTaskName返回参数结构体
486
+ */
487
+ export interface ModifyCompareTaskNameResponse {
488
+ /**
489
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
490
+ */
491
+ RequestId?: string
492
+ }
493
+
494
+ /**
495
+ * CreateMigrateCheckJob返回参数结构体
496
+ */
497
+ export interface CreateMigrateCheckJobResponse {
498
+ /**
499
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
500
+ */
501
+ RequestId?: string
502
+ }
503
+
504
+ /**
505
+ * CreateMigrationService请求参数结构体
506
+ */
507
+ export interface CreateMigrationServiceRequest {
508
+ /**
509
+ * 源实例数据库类型,mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb
510
+ */
511
+ SrcDatabaseType: string
512
+
513
+ /**
514
+ * 目标实例数据库类型,mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb
515
+ */
516
+ DstDatabaseType: string
517
+
518
+ /**
519
+ * 源实例地域,如:ap-guangzhou
520
+ */
521
+ SrcRegion: string
522
+
523
+ /**
524
+ * 目标实例地域,如:ap-guangzhou。注意,目标地域必须和API请求地域保持一致。
525
+ */
526
+ DstRegion: string
527
+
528
+ /**
529
+ * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge
530
+ */
531
+ InstanceClass: string
532
+
533
+ /**
534
+ * 购买数量,范围为[1,15],默认为1
535
+ */
536
+ Count?: number
537
+
538
+ /**
539
+ * 迁移服务名称,最大长度128
540
+ */
541
+ JobName?: string
542
+
543
+ /**
544
+ * 标签信息
545
+ */
546
+ Tags?: Array<TagItem>
547
+ }
548
+
549
+ /**
550
+ * 每个检查步骤里的具体检查项
551
+ */
552
+ export interface DetailCheckItem {
553
+ /**
554
+ * 检查项的名称,如:源实例权限检查
555
+ 注意:此字段可能返回 null,表示取不到有效值。
556
+ */
557
+ CheckItemName: string
558
+
559
+ /**
560
+ * 检查项详细内容
561
+ 注意:此字段可能返回 null,表示取不到有效值。
562
+ */
563
+ Description: string
564
+
565
+ /**
566
+ * pass(通过),failed(失败), warning(校验有警告,但仍通过)
567
+ 注意:此字段可能返回 null,表示取不到有效值。
568
+ */
569
+ CheckResult: string
570
+
571
+ /**
572
+ * 检查项失败原因
573
+ 注意:此字段可能返回 null,表示取不到有效值。
574
+ */
575
+ FailureReason: string
576
+
577
+ /**
578
+ * 解决方案
579
+ 注意:此字段可能返回 null,表示取不到有效值。
580
+ */
581
+ Solution: string
582
+
583
+ /**
584
+ * 运行报错日志
585
+ 注意:此字段可能返回 null,表示取不到有效值。
586
+ */
587
+ ErrorLog: Array<string>
588
+
589
+ /**
590
+ * 详细帮助的文档链接
591
+ 注意:此字段可能返回 null,表示取不到有效值。
592
+ */
593
+ HelpDoc: Array<string>
594
+
595
+ /**
596
+ * 跳过风险文案
597
+ 注意:此字段可能返回 null,表示取不到有效值。
598
+ */
599
+ SkipInfo: string
600
+ }
601
+
602
+ /**
603
+ * DescribeCompareTasks请求参数结构体
604
+ */
605
+ export interface DescribeCompareTasksRequest {
606
+ /**
607
+ * 迁移任务 Id
608
+ */
609
+ JobId: string
610
+
611
+ /**
612
+ * 分页设置,表示每页显示多少条任务,默认为 20
613
+ */
614
+ Limit?: number
615
+
616
+ /**
617
+ * 分页偏移量
618
+ */
619
+ Offset?: number
620
+ }
621
+
622
+ /**
623
+ * 一致性对比对象配置
624
+ */
625
+ export interface CompareObject {
626
+ /**
627
+ * 迁移对象模式 all(所有迁移对象),partial(部分对象迁移)
628
+ 注意:此字段可能返回 null,表示取不到有效值。
629
+ */
630
+ ObjectMode: string
631
+
632
+ /**
633
+ * 迁移对象库表配置
634
+ 注意:此字段可能返回 null,表示取不到有效值。
635
+ */
636
+ ObjectItems?: Array<CompareObjectItem>
637
+ }
638
+
639
+ /**
640
+ * 任务错误信息
641
+ */
642
+ export interface ErrorInfoItem {
643
+ /**
644
+ * 错误码
645
+ 注意:此字段可能返回 null,表示取不到有效值。
646
+ */
647
+ Code: string
648
+
649
+ /**
650
+ * 解决方案
651
+ 注意:此字段可能返回 null,表示取不到有效值。
652
+ */
653
+ Solution: string
654
+
655
+ /**
656
+ * 错误日志信息
657
+ 注意:此字段可能返回 null,表示取不到有效值。
658
+ */
659
+ ErrorLog: string
660
+
661
+ /**
662
+ * 文档提示
663
+ 注意:此字段可能返回 null,表示取不到有效值。
664
+ */
665
+ HelpDoc: string
666
+ }
667
+
668
+ /**
669
+ * RecoverSyncJob返回参数结构体
670
+ */
671
+ export interface RecoverSyncJobResponse {
672
+ /**
673
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
674
+ */
675
+ RequestId?: string
676
+ }
677
+
678
+ /**
679
+ * 任务操作信息,包含迁移任务的所有操作列表,及迁移任务在当前状态下允许的操作列表
680
+ */
681
+ export interface MigrateAction {
682
+ /**
683
+ * 任务的所有操作列表
684
+ 注意:此字段可能返回 null,表示取不到有效值。
685
+ */
686
+ AllAction: Array<string>
687
+
688
+ /**
689
+ * 任务在当前状态下允许的操作列表
690
+ 注意:此字段可能返回 null,表示取不到有效值。
691
+ */
692
+ AllowedAction: Array<string>
693
+ }
694
+
695
+ /**
696
+ * DeleteCompareTask返回参数结构体
697
+ */
698
+ export interface DeleteCompareTaskResponse {
699
+ /**
700
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
701
+ */
702
+ RequestId?: string
703
+ }
704
+
705
+ /**
706
+ * 实例信息
707
+ */
708
+ export interface DBEndpointInfo {
709
+ /**
710
+ * 实例所在地域
711
+ 注意:此字段可能返回 null,表示取不到有效值。
712
+ */
713
+ Region: string
714
+
715
+ /**
716
+ * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
717
+ 注意:此字段可能返回 null,表示取不到有效值。
718
+ */
719
+ AccessType: string
720
+
721
+ /**
722
+ * 实例数据库类型,如:mysql,redis,mongodb,postgresql,mariadb,percona 等
723
+ 注意:此字段可能返回 null,表示取不到有效值。
724
+ */
725
+ DatabaseType: string
726
+
727
+ /**
728
+ * 节点类型,为空或者"simple":表示普通节点,"cluster": 集群节点
729
+ 注意:此字段可能返回 null,表示取不到有效值。
730
+ */
731
+ NodeType: string
732
+
733
+ /**
734
+ * 数据库信息
735
+ 注意:此字段可能返回 null,表示取不到有效值。
736
+ */
737
+ Info: Array<DBInfo>
738
+
739
+ /**
740
+ * 实例服务提供商,如:"aliyun","others"
741
+ 注意:此字段可能返回 null,表示取不到有效值。
742
+ */
743
+ Supplier?: string
744
+
745
+ /**
746
+ * MongoDB可定义如下的参数: ['AuthDatabase':'admin',
747
+ 'AuthFlag': "1", 'AuthMechanism':"SCRAM-SHA-1"]
748
+ 注意:此字段可能返回 null,表示取不到有效值。
749
+ */
750
+ ExtraAttr?: Array<KeyValuePairOption>
751
+ }
752
+
753
+ /**
754
+ * 数据同步中的选项
755
+ */
756
+ export interface Options {
757
+ /**
758
+ * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
759
+ 注意:此字段可能返回 null,表示取不到有效值。
760
+ */
761
+ InitType?: string
762
+
763
+ /**
764
+ * 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、InitializeAfterDelete(删除并重新初始化)、ExecuteAfterIgnore(忽略并继续执行)
765
+ 注意:此字段可能返回 null,表示取不到有效值。
766
+ */
767
+ DealOfExistSameTable?: string
768
+
769
+ /**
770
+ * 冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
771
+ 注意:此字段可能返回 null,表示取不到有效值。
772
+ */
773
+ ConflictHandleType?: string
774
+
775
+ /**
776
+ * 是否添加附加列
777
+ 注意:此字段可能返回 null,表示取不到有效值。
778
+ */
779
+ AddAdditionalColumn?: boolean
780
+
781
+ /**
782
+ * 所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), 不填(不选),PartialDDL(自定义,和DdlOptions一起起作用 )
783
+ 注意:此字段可能返回 null,表示取不到有效值。
784
+ */
785
+ OpTypes?: Array<string>
786
+
787
+ /**
788
+ * 冲突处理的详细选项,如条件覆盖中的条件行和条件操作
789
+ 注意:此字段可能返回 null,表示取不到有效值。
790
+ */
791
+ ConflictHandleOption?: ConflictHandleOption
792
+
793
+ /**
794
+ * DDL同步选项,具体描述要同步那些DDL
795
+ 注意:此字段可能返回 null,表示取不到有效值。
796
+ */
797
+ DdlOptions?: Array<DdlOption>
798
+ }
799
+
800
+ /**
801
+ * CompleteMigrateJob请求参数结构体
802
+ */
803
+ export interface CompleteMigrateJobRequest {
804
+ /**
805
+ * 数据迁移任务ID
806
+ */
807
+ JobId: string
808
+
809
+ /**
810
+ * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
811
+ */
812
+ CompleteMode?: string
813
+ }
814
+
815
+ /**
816
+ * DescribeCompareTasks返回参数结构体
817
+ */
818
+ export interface DescribeCompareTasksResponse {
819
+ /**
820
+ * 数量
821
+ 注意:此字段可能返回 null,表示取不到有效值。
822
+ */
823
+ TotalCount: number
824
+
825
+ /**
826
+ * 一致性校验列表
827
+ 注意:此字段可能返回 null,表示取不到有效值。
828
+ */
829
+ Items: Array<CompareTaskItem>
830
+
831
+ /**
832
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
833
+ */
834
+ RequestId?: string
835
+ }
836
+
837
+ /**
838
+ * StopCompare请求参数结构体
839
+ */
840
+ export interface StopCompareRequest {
841
+ /**
842
+ * 迁移任务 Id
843
+ */
844
+ JobId: string
845
+
846
+ /**
847
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
848
+ */
849
+ CompareTaskId: string
850
+ }
851
+
852
+ /**
853
+ * DescribeCheckSyncJobResult返回参数结构体
854
+ */
855
+ export interface DescribeCheckSyncJobResultResponse {
856
+ /**
857
+ * 校验结果
858
+ 注意:此字段可能返回 null,表示取不到有效值。
859
+ */
860
+ Status: string
861
+
862
+ /**
863
+ * 步骤总数
864
+ 注意:此字段可能返回 null,表示取不到有效值。
865
+ */
866
+ StepCount: number
867
+
868
+ /**
869
+ * 当前所在步骤
870
+ 注意:此字段可能返回 null,表示取不到有效值。
871
+ */
872
+ StepCur: number
873
+
874
+ /**
875
+ * 总体进度
876
+ 注意:此字段可能返回 null,表示取不到有效值。
877
+ */
878
+ Progress: number
879
+
880
+ /**
881
+ * 步骤信息
882
+ 注意:此字段可能返回 null,表示取不到有效值。
883
+ */
884
+ StepInfos: Array<StepInfo>
885
+
886
+ /**
887
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
888
+ */
889
+ RequestId?: string
890
+ }
891
+
892
+ /**
893
+ * StopSyncJob返回参数结构体
894
+ */
895
+ export interface StopSyncJobResponse {
896
+ /**
897
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
898
+ */
899
+ RequestId?: string
900
+ }
901
+
902
+ /**
903
+ * 跳过校验的表详情
904
+ */
905
+ export interface SkippedDetail {
906
+ /**
907
+ * 跳过的表数量
908
+ 注意:此字段可能返回 null,表示取不到有效值。
909
+ */
910
+ TotalCount: number
911
+
912
+ /**
913
+ * 跳过校验的表详情
914
+ 注意:此字段可能返回 null,表示取不到有效值。
915
+ */
916
+ Items: Array<SkippedItem>
917
+ }
918
+
919
+ /**
920
+ * 迁移选项,描述任务如何执行迁移等一系列配置信息
921
+ */
922
+ export interface MigrateOption {
923
+ /**
924
+ * 迁移对象选项,需要告知迁移服务迁移哪些库表对象
925
+ 注意:此字段可能返回 null,表示取不到有效值。
926
+ */
927
+ DatabaseTable: DatabaseTableObject
928
+
929
+ /**
930
+ * 迁移类型,full(全量迁移),structure(结构迁移),fullAndIncrement(全量加增量迁移), 默认为fullAndIncrement
931
+ 注意:此字段可能返回 null,表示取不到有效值。
932
+ */
933
+ MigrateType?: string
934
+
935
+ /**
936
+ * 数据一致性校验选项, 默认为不开启一致性校验
937
+ 注意:此字段可能返回 null,表示取不到有效值。
938
+ */
939
+ Consistency?: ConsistencyOption
940
+
941
+ /**
942
+ * 是否迁移账号,yes(迁移账号),no(不迁移账号)
943
+ 注意:此字段可能返回 null,表示取不到有效值。
944
+ */
945
+ IsMigrateAccount?: boolean
946
+
947
+ /**
948
+ * 是否用源库Root账户覆盖目标库,值包括:false-不覆盖,true-覆盖,选择库表或者结构迁移时应该为false,注意只对旧版迁移有效
949
+ 注意:此字段可能返回 null,表示取不到有效值。
950
+ */
951
+ IsOverrideRoot?: boolean
952
+
953
+ /**
954
+ * 是否在迁移时设置目标库只读(仅对mysql有效),true(设置只读)、false(不设置只读,默认此值)
955
+ 注意:此字段可能返回 null,表示取不到有效值。
956
+ */
957
+ IsDstReadOnly?: boolean
958
+
959
+ /**
960
+ * 其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
961
+ ["ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) ]
962
+ 注意:此字段可能返回 null,表示取不到有效值。
963
+ */
964
+ ExtraAttr?: Array<KeyValuePairOption>
965
+ }
966
+
967
+ /**
968
+ * ModifyMigrateName返回参数结构体
969
+ */
970
+ export interface ModifyMigrateNameResponse {
971
+ /**
972
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
973
+ */
974
+ RequestId?: string
975
+ }
976
+
977
+ /**
978
+ * DescribeMigrationJobs返回参数结构体
979
+ */
980
+ export interface DescribeMigrationJobsResponse {
981
+ /**
982
+ * 迁移任务数量
983
+ 注意:此字段可能返回 null,表示取不到有效值。
984
+ */
985
+ TotalCount: number
986
+
987
+ /**
988
+ * 迁移任务列表
989
+ 注意:此字段可能返回 null,表示取不到有效值。
990
+ */
991
+ JobList: Array<JobItem>
992
+
993
+ /**
994
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
995
+ */
996
+ RequestId?: string
997
+ }
998
+
999
+ /**
1000
+ * 跳过校验的表详情
1001
+ */
1002
+ export interface SkippedItem {
1003
+ /**
1004
+ * 数据库名
1005
+ 注意:此字段可能返回 null,表示取不到有效值。
1006
+ */
1007
+ Db: string
1008
+
1009
+ /**
1010
+ * 表名
1011
+ 注意:此字段可能返回 null,表示取不到有效值。
1012
+ */
1013
+ Table: string
1014
+
1015
+ /**
1016
+ * 未发起检查的原因
1017
+ 注意:此字段可能返回 null,表示取不到有效值。
1018
+ */
1019
+ Reason: string
1020
+ }
1021
+
1022
+ /**
1023
+ * DestroyMigrateJob返回参数结构体
1024
+ */
1025
+ export interface DestroyMigrateJobResponse {
1026
+ /**
1027
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1028
+ */
1029
+ RequestId?: string
1030
+ }
1031
+
1032
+ /**
1033
+ * 任务步骤信息
1034
+ */
1035
+ export interface ProcessProgress {
1036
+ /**
1037
+ * 步骤的状态, 包括:notStarted(未开始)、running(运行中)、success(成功)、failed(失败)等
1038
+ 注意:此字段可能返回 null,表示取不到有效值。
1039
+ */
1040
+ Status: string
1041
+
1042
+ /**
1043
+ * 进度信息
1044
+ 注意:此字段可能返回 null,表示取不到有效值。
1045
+ */
1046
+ Percent: number
1047
+
1048
+ /**
1049
+ * 总的步骤数
1050
+ 注意:此字段可能返回 null,表示取不到有效值。
1051
+ */
1052
+ StepAll: number
1053
+
1054
+ /**
1055
+ * 当前进行的步骤
1056
+ 注意:此字段可能返回 null,表示取不到有效值。
1057
+ */
1058
+ StepNow: number
1059
+
1060
+ /**
1061
+ * 当前步骤输出提示信息
1062
+ 注意:此字段可能返回 null,表示取不到有效值。
1063
+ */
1064
+ Message: string
1065
+
1066
+ /**
1067
+ * 步骤信息
1068
+ 注意:此字段可能返回 null,表示取不到有效值。
1069
+ */
1070
+ Steps: Array<StepDetailInfo>
1071
+ }
1072
+
1073
+ /**
1074
+ * IsolateSyncJob返回参数结构体
1075
+ */
1076
+ export interface IsolateSyncJobResponse {
1077
+ /**
1078
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1079
+ */
1080
+ RequestId?: string
1081
+ }
1082
+
1083
+ /**
1084
+ * CreateMigrateCheckJob请求参数结构体
1085
+ */
1086
+ export interface CreateMigrateCheckJobRequest {
1087
+ /**
1088
+ * 数据迁移任务ID
1089
+ */
1090
+ JobId: string
1091
+ }
1092
+
1093
+ /**
1094
+ * DescribeMigrationJobs请求参数结构体
1095
+ */
1096
+ export interface DescribeMigrationJobsRequest {
1097
+ /**
1098
+ * 数据迁移任务ID,如:dts-amm1jw5q
1099
+ */
1100
+ JobId?: string
1101
+
1102
+ /**
1103
+ * 数据迁移任务名称
1104
+ */
1105
+ JobName?: string
1106
+
1107
+ /**
1108
+ * 数据迁移任务状态,可取值包括:created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)
1109
+ */
1110
+ Status?: Array<string>
1111
+
1112
+ /**
1113
+ * 源实例ID,格式如:cdb-c1nl9rpv
1114
+ */
1115
+ SrcInstanceId?: string
1116
+
1117
+ /**
1118
+ * 源实例地域,如:ap-guangzhou
1119
+ */
1120
+ SrcRegion?: string
1121
+
1122
+ /**
1123
+ * 源实例数据库类型,如:sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql
1124
+ */
1125
+ SrcDatabaseType?: Array<string>
1126
+
1127
+ /**
1128
+ * 源实例接入类型,值包括:extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)
1129
+ */
1130
+ SrcAccessType?: Array<string>
1131
+
1132
+ /**
1133
+ * 目标实例ID,格式如:cdb-c1nl9rpv
1134
+ */
1135
+ DstInstanceId?: string
1136
+
1137
+ /**
1138
+ * 目标实例地域,如:ap-guangzhou
1139
+ */
1140
+ DstRegion?: string
1141
+
1142
+ /**
1143
+ * 目标源实例数据库类型,如:sqlserver,mysql,mongodb,redis,tendis,keewidb,clickhouse,cynosdbmysql,percona,tdsqlpercona,mariadb,tdsqlmysql,postgresql
1144
+ */
1145
+ DstDatabaseType?: Array<string>
1146
+
1147
+ /**
1148
+ * 目标实例接入类型,值包括:extranet(外网)、vpncloud(云vpn接入的实例)、dcg(专线接入的实例)、ccn(云联网接入的实例)、cdb(云上cdb实例)、cvm(cvm自建实例)
1149
+ */
1150
+ DstAccessType?: Array<string>
1151
+
1152
+ /**
1153
+ * 任务运行模式,值包括:immediate(立即运行),timed(定时运行)
1154
+ */
1155
+ RunMode?: string
1156
+
1157
+ /**
1158
+ * 排序方式,可能取值为asc、desc,默认按照创建时间倒序
1159
+ */
1160
+ OrderSeq?: string
1161
+
1162
+ /**
1163
+ * 返回实例数量,默认20,有效区间[1,100]
1164
+ */
1165
+ Limit?: number
1166
+
1167
+ /**
1168
+ * 偏移量,默认为0
1169
+ */
1170
+ Offset?: number
1171
+
1172
+ /**
1173
+ * 标签过滤
1174
+ */
1175
+ TagFilters?: Array<TagFilter>
1176
+ }
1177
+
1178
+ /**
1179
+ * 数据一致性校验结果
1180
+ */
1181
+ export interface CompareTaskInfo {
1182
+ /**
1183
+ * 一致性校验任务Id
1184
+ 注意:此字段可能返回 null,表示取不到有效值。
1185
+ */
1186
+ CompareTaskId: string
1187
+
1188
+ /**
1189
+ * 一致性校验结果,包括:unstart(未启动)、running(校验中)、canceled(已终止)、failed(校验任务失败)、inconsistent(不一致)、consistent(一致)、notexist(不存在校验任务)
1190
+ 注意:此字段可能返回 null,表示取不到有效值。
1191
+ */
1192
+ Status: string
1193
+ }
1194
+
1195
+ /**
1196
+ * CreateMigrationService返回参数结构体
1197
+ */
1198
+ export interface CreateMigrationServiceResponse {
1199
+ /**
1200
+ * 下单成功随机生成的迁移服务id列表,形如:dts-c1f6rs21
1201
+ 注意:此字段可能返回 null,表示取不到有效值。
1202
+ */
1203
+ JobIds: Array<string>
1204
+
1205
+ /**
1206
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1207
+ */
1208
+ RequestId?: string
1209
+ }
1210
+
1211
+ /**
1212
+ * StartSyncJob请求参数结构体
1213
+ */
1214
+ export interface StartSyncJobRequest {
1215
+ /**
1216
+ * 同步任务id
1217
+ */
1218
+ JobId?: string
1219
+ }
1220
+
1221
+ /**
1222
+ * DescribeMigrationCheckJob返回参数结构体
1223
+ */
1224
+ export interface DescribeMigrationCheckJobResponse {
1225
+ /**
1226
+ * 校验任务执行状态,如:notStarted(未开始)、running(校验中)、failed(校验任务失败)、success(任务成功)
1227
+ 注意:此字段可能返回 null,表示取不到有效值。
1228
+ */
1229
+ Status: string
1230
+
1231
+ /**
1232
+ * 校验任务结果输出简要信息
1233
+ 注意:此字段可能返回 null,表示取不到有效值。
1234
+ */
1235
+ BriefMsg: string
1236
+
1237
+ /**
1238
+ * 检查步骤
1239
+ 注意:此字段可能返回 null,表示取不到有效值。
1240
+ */
1241
+ StepInfo: Array<CheckStep>
1242
+
1243
+ /**
1244
+ * 校验结果,如:checkPass(校验通过)、checkNotPass(校验未通过)
1245
+ */
1246
+ CheckFlag: string
1247
+
1248
+ /**
1249
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1250
+ */
1251
+ RequestId?: string
1252
+ }
1253
+
1254
+ /**
1255
+ * 一致性校验库表对象
1256
+ */
1257
+ export interface CompareObjectItem {
1258
+ /**
1259
+ * 迁移的库
1260
+ 注意:此字段可能返回 null,表示取不到有效值。
1261
+ */
1262
+ DbName: string
1263
+
1264
+ /**
1265
+ * 数据库选择模式: all 为当前对象下的所有对象,partial 为部分对象
1266
+ 注意:此字段可能返回 null,表示取不到有效值。
1267
+ */
1268
+ DbMode: string
1269
+
1270
+ /**
1271
+ * 迁移的 schema
1272
+ 注意:此字段可能返回 null,表示取不到有效值。
1273
+ */
1274
+ SchemaName?: string
1275
+
1276
+ /**
1277
+ * 表选择模式: all 为当前对象下的所有表对象,partial 为部分表对象
1278
+ 注意:此字段可能返回 null,表示取不到有效值。
1279
+ */
1280
+ TableMode?: string
1281
+
1282
+ /**
1283
+ * 用于一致性校验的表配置,当 TableMode 为 partial 时,需要填写
1284
+ 注意:此字段可能返回 null,表示取不到有效值。
1285
+ */
1286
+ Tables?: Array<CompareTableItem>
1287
+
1288
+ /**
1289
+ * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
1290
+ 注意:此字段可能返回 null,表示取不到有效值。
1291
+ */
1292
+ ViewMode?: string
1293
+
1294
+ /**
1295
+ * 用于一致性校验的视图配置,当 ViewMode 为 partial 时, 需要填写
1296
+ 注意:此字段可能返回 null,表示取不到有效值。
1297
+ */
1298
+ Views?: Array<CompareViewItem>
1299
+ }
1300
+
1301
+ /**
1302
+ * 数据同步中的描述源端和目的端的信息
1303
+ */
1304
+ export interface Endpoint {
1305
+ /**
1306
+ * 地域英文名,如:ap-guangzhou
1307
+ 注意:此字段可能返回 null,表示取不到有效值。
1308
+ */
1309
+ Region?: string
1310
+
1311
+ /**
1312
+ * 数据库内核类型,tdsql中用于区分不同内核:percona,mariadb,mysql
1313
+ 注意:此字段可能返回 null,表示取不到有效值。
1314
+ */
1315
+ DbKernel?: string
1316
+
1317
+ /**
1318
+ * 数据库实例ID,格式如:cdb-powiqx8q
1319
+ 注意:此字段可能返回 null,表示取不到有效值。
1320
+ */
1321
+ InstanceId?: string
1322
+
1323
+ /**
1324
+ * 实例的IP地址,接入类型为非cdb时此项必填
1325
+ 注意:此字段可能返回 null,表示取不到有效值。
1326
+ */
1327
+ Ip?: string
1328
+
1329
+ /**
1330
+ * 实例端口,接入类型为非cdb时此项必填
1331
+ 注意:此字段可能返回 null,表示取不到有效值。
1332
+ */
1333
+ Port?: number
1334
+
1335
+ /**
1336
+ * 用户名,对于访问需要用户名密码认证的实例必填
1337
+ 注意:此字段可能返回 null,表示取不到有效值。
1338
+ */
1339
+ User?: string
1340
+
1341
+ /**
1342
+ * 密码,对于访问需要用户名密码认证的实例必填
1343
+ 注意:此字段可能返回 null,表示取不到有效值。
1344
+ */
1345
+ Password?: string
1346
+
1347
+ /**
1348
+ * 数据库名,数据库为cdwpg时,需要提供
1349
+ 注意:此字段可能返回 null,表示取不到有效值。
1350
+ */
1351
+ DbName?: string
1352
+
1353
+ /**
1354
+ * 私有网络ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:vpc-92jblxto
1355
+ 注意:此字段可能返回 null,表示取不到有效值。
1356
+ */
1357
+ VpcId?: string
1358
+
1359
+ /**
1360
+ * 私有网络下的子网ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:subnet-3paxmkdz
1361
+ 注意:此字段可能返回 null,表示取不到有效值。
1362
+ */
1363
+ SubnetId?: string
1364
+
1365
+ /**
1366
+ * CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
1367
+ 注意:此字段可能返回 null,表示取不到有效值。
1368
+ */
1369
+ CvmInstanceId?: string
1370
+
1371
+ /**
1372
+ * 专线网关ID,对于专线接入类型此项必填,格式如:dcg-0rxtqqxb
1373
+ 注意:此字段可能返回 null,表示取不到有效值。
1374
+ */
1375
+ UniqDcgId?: string
1376
+
1377
+ /**
1378
+ * VPN网关ID,对于vpn接入类型此项必填,格式如:vpngw-9ghexg7q
1379
+ 注意:此字段可能返回 null,表示取不到有效值。
1380
+ */
1381
+ UniqVpnGwId?: string
1382
+
1383
+ /**
1384
+ * 云联网ID,对于云联网接入类型此项必填,如:ccn-afp6kltc
1385
+ 注意:此字段可能返回 null,表示取不到有效值。
1386
+ */
1387
+ CcnId?: string
1388
+
1389
+ /**
1390
+ * 云厂商类型,当实例为RDS实例时,填写为aliyun, 其他情况均填写others,默认为others
1391
+ 注意:此字段可能返回 null,表示取不到有效值。
1392
+ */
1393
+ Supplier?: string
1394
+
1395
+ /**
1396
+ * 数据库版本,当实例为RDS实例时才有效,其他实例忽略,格式如:5.6或者5.7,默认为5.6
1397
+ 注意:此字段可能返回 null,表示取不到有效值。
1398
+ */
1399
+ EngineVersion?: string
1400
+
1401
+ /**
1402
+ * 资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)
1403
+ 注意:此字段可能返回 null,表示取不到有效值。
1404
+ */
1405
+ AccountMode?: string
1406
+
1407
+ /**
1408
+ * 实例所属账号,如果为跨账号实例此项必填
1409
+ 注意:此字段可能返回 null,表示取不到有效值。
1410
+ */
1411
+ Account?: string
1412
+
1413
+ /**
1414
+ * 跨账号同步时的角色,只允许[a-zA-Z0-9\-\_]+,如果为跨账号实例此项必填
1415
+ 注意:此字段可能返回 null,表示取不到有效值。
1416
+ */
1417
+ AccountRole?: string
1418
+
1419
+ /**
1420
+ * 临时秘钥Id,如果为跨账号实例此项必填
1421
+ 注意:此字段可能返回 null,表示取不到有效值。
1422
+ */
1423
+ TmpSecretId?: string
1424
+
1425
+ /**
1426
+ * 临时秘钥Key,如果为跨账号实例此项必填
1427
+ 注意:此字段可能返回 null,表示取不到有效值。
1428
+ */
1429
+ TmpSecretKey?: string
1430
+
1431
+ /**
1432
+ * 临时Token,如果为跨账号实例此项必填
1433
+ 注意:此字段可能返回 null,表示取不到有效值。
1434
+ */
1435
+ TmpToken?: string
1436
+ }
1437
+
1438
+ /**
1439
+ * 数据不一致的表详情
1440
+ */
1441
+ export interface DifferenceDetail {
1442
+ /**
1443
+ * 数据不一致的表数量
1444
+ 注意:此字段可能返回 null,表示取不到有效值。
1445
+ */
1446
+ TotalCount: number
1447
+
1448
+ /**
1449
+ * 校验不一致的表详情
1450
+ 注意:此字段可能返回 null,表示取不到有效值。
1451
+ */
1452
+ Items: Array<DifferenceItem>
1453
+ }
1454
+
1455
+ /**
1456
+ * CreateCheckSyncJob返回参数结构体
1457
+ */
1458
+ export interface CreateCheckSyncJobResponse {
1459
+ /**
1460
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1461
+ */
1462
+ RequestId?: string
1463
+ }
1464
+
1465
+ /**
1466
+ * 数据库信息
1467
+ */
1468
+ export interface DBInfo {
1469
+ /**
1470
+ * 表示节点角色,针对分布式数据库,如mongodb中的mongos节点
1471
+ 注意:此字段可能返回 null,表示取不到有效值。
1472
+ */
1473
+ Role?: string
1474
+
1475
+ /**
1476
+ * 内核版本,针对mariadb的不同内核版本等
1477
+ 注意:此字段可能返回 null,表示取不到有效值。
1478
+ */
1479
+ DbKernel?: string
1480
+
1481
+ /**
1482
+ * 实例的IP地址,对于公网、专线、VPN、云联网、自研上云、VPC等接入方式此项必填
1483
+ 注意:此字段可能返回 null,表示取不到有效值。
1484
+ */
1485
+ Host?: string
1486
+
1487
+ /**
1488
+ * 实例的端口,对于公网、云主机自建、专线、VPN、云联网、自研上云、VPC等接入方式此项必填
1489
+ 注意:此字段可能返回 null,表示取不到有效值。
1490
+ */
1491
+ Port?: number
1492
+
1493
+ /**
1494
+ * 实例的用户名
1495
+ 注意:此字段可能返回 null,表示取不到有效值。
1496
+ */
1497
+ User?: string
1498
+
1499
+ /**
1500
+ * 实例的密码
1501
+ 注意:此字段可能返回 null,表示取不到有效值。
1502
+ */
1503
+ Password?: string
1504
+
1505
+ /**
1506
+ * CVM实例短ID,格式如:ins-olgl39y8;与云服务器控制台页面显示的实例ID相同;如果接入类型为云主机自建的方式,此项必填
1507
+ 注意:此字段可能返回 null,表示取不到有效值。
1508
+ */
1509
+ CvmInstanceId?: string
1510
+
1511
+ /**
1512
+ * VPN网关ID,格式如:vpngw-9ghexg7q;如果接入类型为vpncloud的方式,此项必填
1513
+ 注意:此字段可能返回 null,表示取不到有效值。
1514
+ */
1515
+ UniqVpnGwId?: string
1516
+
1517
+ /**
1518
+ * 专线网关ID,格式如:dcg-0rxtqqxb;如果接入类型为专线接入的方式,此项必填
1519
+ 注意:此字段可能返回 null,表示取不到有效值。
1520
+ */
1521
+ UniqDcgId?: string
1522
+
1523
+ /**
1524
+ * 数据库实例ID,格式如:cdb-powiqx8q;如果接入类型为云数据库的方式,此项必填
1525
+ 注意:此字段可能返回 null,表示取不到有效值。
1526
+ */
1527
+ InstanceId?: string
1528
+
1529
+ /**
1530
+ * 云联网ID,如:ccn-afp6kltc 注意:此字段可能返回 null,表示取不到有效值。
1531
+ 注意:此字段可能返回 null,表示取不到有效值。
1532
+ */
1533
+ CcnGwId?: string
1534
+
1535
+ /**
1536
+ * 私有网络ID,格式如:vpc-92jblxto;如果接入类型为vpc、vpncloud、ccn、dcg的方式,此项必填
1537
+ 注意:此字段可能返回 null,表示取不到有效值。
1538
+ */
1539
+ VpcId?: string
1540
+
1541
+ /**
1542
+ * 私有网络下的子网ID,格式如:subnet-3paxmkdz;如果接入类型为vpc、vpncloud、ccn、dcg的方式,此项必填
1543
+ 注意:此字段可能返回 null,表示取不到有效值。
1544
+ */
1545
+ SubnetId?: string
1546
+
1547
+ /**
1548
+ * 数据库版本,当实例为RDS实例时才有效,格式如:5.6或者5.7,默认为5.6
1549
+ 注意:此字段可能返回 null,表示取不到有效值。
1550
+ */
1551
+ EngineVersion?: string
1552
+
1553
+ /**
1554
+ * 实例所属账号
1555
+ 注意:此字段可能返回 null,表示取不到有效值。
1556
+ */
1557
+ Account?: string
1558
+
1559
+ /**
1560
+ * 跨账号迁移时的角色,只允许[a-zA-Z0-9\-\_]+
1561
+ 注意:此字段可能返回 null,表示取不到有效值。
1562
+ */
1563
+ AccountRole?: string
1564
+
1565
+ /**
1566
+ * 资源所属账号 为空或self(表示本账号内资源)、other(表示其他账户资源)
1567
+ 注意:此字段可能返回 null,表示取不到有效值。
1568
+ */
1569
+ AccountMode?: string
1570
+
1571
+ /**
1572
+ * 临时秘钥Id
1573
+ 注意:此字段可能返回 null,表示取不到有效值。
1574
+ */
1575
+ TmpSecretId?: string
1576
+
1577
+ /**
1578
+ * 临时秘钥Key
1579
+ 注意:此字段可能返回 null,表示取不到有效值。
1580
+ */
1581
+ TmpSecretKey?: string
1582
+
1583
+ /**
1584
+ * 临时Token
1585
+ 注意:此字段可能返回 null,表示取不到有效值。
1586
+ */
1587
+ TmpToken?: string
1588
+ }
1589
+
1590
+ /**
1591
+ * ConfigureSyncJob请求参数结构体
1592
+ */
1593
+ export interface ConfigureSyncJobRequest {
1594
+ /**
1595
+ * 同步实例id(即标识一个同步作业),形如sync-werwfs23
1596
+ */
1597
+ JobId: string
1598
+
1599
+ /**
1600
+ * 源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、noProxy,注意具体可选值依赖当前链路
1601
+ */
1602
+ SrcAccessType: string
1603
+
1604
+ /**
1605
+ * 源端信息
1606
+ */
1607
+ SrcInfo: Endpoint
1608
+
1609
+ /**
1610
+ * 目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、noProxy,注意具体可选值依赖当前链路
1611
+ */
1612
+ DstAccessType: string
1613
+
1614
+ /**
1615
+ * 目标端信息
1616
+ */
1617
+ DstInfo: Endpoint
1618
+
1619
+ /**
1620
+ * 同步任务选项
1621
+ */
1622
+ Options: Options
1623
+
1624
+ /**
1625
+ * 同步库表对象信息
1626
+ */
1627
+ Objects: Objects
1628
+
1629
+ /**
1630
+ * 同步任务名称
1631
+ */
1632
+ JobName?: string
1633
+
1634
+ /**
1635
+ * 运行模式,取值如:Immediate(表示立即运行,默认为此项值)、Timed(表示定时运行)
1636
+ */
1637
+ RunMode?: string
1638
+
1639
+ /**
1640
+ * 期待启动时间,当RunMode取值为Timed时,此值必填,形如:"2006-01-02 15:04:05"
1641
+ */
1642
+ ExpectRunTime?: string
1643
+ }
1644
+
1645
+ /**
1646
+ * 查询迁移实例列表的实例对象
1647
+ */
1648
+ export interface MigrateDBItem {
1649
+ /**
1650
+ * 实例ID
1651
+ */
1652
+ InstanceId: string
1653
+
1654
+ /**
1655
+ * 实例名称
1656
+ */
1657
+ InstanceName: string
1658
+
1659
+ /**
1660
+ * 实例Vip
1661
+ */
1662
+ Vip: string
1663
+
1664
+ /**
1665
+ * 实例Vport
1666
+ */
1667
+ Vport: number
1668
+
1669
+ /**
1670
+ * 是否可以作为迁移对象,1-可以,0-不可以
1671
+ */
1672
+ Usable: number
1673
+
1674
+ /**
1675
+ * 不可以作为迁移对象的原因
1676
+ */
1677
+ Hint: string
1678
+ }
1679
+
1680
+ /**
1681
+ * DescribeMigrateDBInstances请求参数结构体
1682
+ */
1683
+ export interface DescribeMigrateDBInstancesRequest {
1684
+ /**
1685
+ * 数据库类型,如mysql
1686
+ */
1687
+ DatabaseType: string
1688
+
1689
+ /**
1690
+ * 实例作为迁移的源还是目标,src(表示源),dst(表示目标)
1691
+ */
1692
+ MigrateRole?: string
1693
+
1694
+ /**
1695
+ * 云数据库实例ID
1696
+ */
1697
+ InstanceId?: string
1698
+
1699
+ /**
1700
+ * 云数据库名称
1701
+ */
1702
+ InstanceName?: string
1703
+
1704
+ /**
1705
+ * 返回数量限制
1706
+ */
1707
+ Limit?: number
1708
+
1709
+ /**
1710
+ * 偏移量
1711
+ */
1712
+ Offset?: number
1713
+
1714
+ /**
1715
+ * 资源所属账号 为空值或self(表示本账号内资源)、other(表示其他账户资源)
1716
+ */
1717
+ AccountMode?: string
1718
+
1719
+ /**
1720
+ * 临时秘钥Id,若为跨账号资源此项必填
1721
+ */
1722
+ TmpSecretId?: string
1723
+
1724
+ /**
1725
+ * 临时秘钥Key,若为跨账号资源此项必填
1726
+ */
1727
+ TmpSecretKey?: string
1728
+
1729
+ /**
1730
+ * 临时秘钥Token,若为跨账号资源此项必填
1731
+ */
1732
+ TmpToken?: string
1733
+ }
1734
+
1735
+ /**
1736
+ * 校验任务运行详情
1737
+ */
1738
+ export interface CheckStepInfo {
1739
+ /**
1740
+ * 任务开始时间
1741
+ 注意:此字段可能返回 null,表示取不到有效值。
1742
+ */
1743
+ StartAt: string
1744
+
1745
+ /**
1746
+ * 任务结束时间
1747
+ 注意:此字段可能返回 null,表示取不到有效值。
1748
+ */
1749
+ EndAt: string
1750
+
1751
+ /**
1752
+ * 任务步骤信息
1753
+ 注意:此字段可能返回 null,表示取不到有效值。
1754
+ */
1755
+ Progress: ProcessProgress
1756
+ }
1757
+
1758
+ /**
1759
+ * 错误信息及告警信息对象
1760
+ */
1761
+ export interface ProcessStepTip {
1762
+ /**
1763
+ * 提示信息
1764
+ 注意:此字段可能返回 null,表示取不到有效值。
1765
+ */
1766
+ Message: string
1767
+
1768
+ /**
1769
+ * 解决方案
1770
+ 注意:此字段可能返回 null,表示取不到有效值。
1771
+ */
1772
+ Solution: string
1773
+
1774
+ /**
1775
+ * 文档提示
1776
+ 注意:此字段可能返回 null,表示取不到有效值。
1777
+ */
1778
+ HelpDoc: string
1779
+ }
1780
+
1781
+ /**
1782
+ * ModifyCompareTask请求参数结构体
1783
+ */
1784
+ export interface ModifyCompareTaskRequest {
1785
+ /**
1786
+ * 迁移任务 Id
1787
+ */
1788
+ JobId: string
1789
+
1790
+ /**
1791
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1792
+ */
1793
+ CompareTaskId: string
1794
+
1795
+ /**
1796
+ * 任务名称
1797
+ */
1798
+ TaskName?: string
1799
+
1800
+ /**
1801
+ * 数据对比对象模式,sameAsMigrate(全部迁移对象, **默认为此项配置**),custom(自定义模式)
1802
+ */
1803
+ ObjectMode?: string
1804
+
1805
+ /**
1806
+ * 对比对象,若CompareObjectMode取值为custom,则此项必填
1807
+ */
1808
+ Objects?: CompareObject
1809
+ }
1810
+
1811
+ /**
1812
+ * RecoverSyncJob请求参数结构体
1813
+ */
1814
+ export interface RecoverSyncJobRequest {
1815
+ /**
1816
+ * 同步实例id(即标识一个同步作业),形如sync-werwfs23
1817
+ */
1818
+ JobId: string
1819
+ }
1820
+
1821
+ /**
1822
+ * 需要同步的库表对象
1823
+ */
1824
+ export interface Database {
1825
+ /**
1826
+ * 需要迁移或同步的库名,当ObjectMode为Partial时,此项必填
1827
+ 注意:此字段可能返回 null,表示取不到有效值。
1828
+ */
1829
+ DbName?: string
1830
+
1831
+ /**
1832
+ * 迁移或同步后的库名,默认与源库相同
1833
+ 注意:此字段可能返回 null,表示取不到有效值。
1834
+ */
1835
+ NewDbName?: string
1836
+
1837
+ /**
1838
+ * DB选择模式: All(为当前对象下的所有对象),Partial(部分对象),当Mode为Partial时,此项必填。注意,高级对象的同步不依赖此值。
1839
+ 注意:此字段可能返回 null,表示取不到有效值。
1840
+ */
1841
+ DbMode?: string
1842
+
1843
+ /**
1844
+ * 迁移或同步的 schema
1845
+ 注意:此字段可能返回 null,表示取不到有效值。
1846
+ */
1847
+ SchemaName?: string
1848
+
1849
+ /**
1850
+ * 迁移或同步后的 schema name
1851
+ 注意:此字段可能返回 null,表示取不到有效值。
1852
+ */
1853
+ NewSchemaName?: string
1854
+
1855
+ /**
1856
+ * 表选择模式: All(为当前对象下的所有对象),Partial(部分对象),当DBMode为Partial时此项必填
1857
+ 注意:此字段可能返回 null,表示取不到有效值。
1858
+ */
1859
+ TableMode?: string
1860
+
1861
+ /**
1862
+ * 表图对象集合,当 TableMode 为 Partial 时,此项需要填写
1863
+ 注意:此字段可能返回 null,表示取不到有效值。
1864
+ */
1865
+ Tables?: Array<Table>
1866
+
1867
+ /**
1868
+ * 视图选择模式: All 为当前对象下的所有视图对象,Partial 为部分视图对象
1869
+ 注意:此字段可能返回 null,表示取不到有效值。
1870
+ */
1871
+ ViewMode?: string
1872
+
1873
+ /**
1874
+ * 视图对象集合,当 ViewMode 为 Partial 时, 此项需要填写
1875
+ 注意:此字段可能返回 null,表示取不到有效值。
1876
+ */
1877
+ Views?: Array<View>
1878
+
1879
+ /**
1880
+ * 选择要同步的模式,Partial为部分,all为整选
1881
+ 注意:此字段可能返回 null,表示取不到有效值。
1882
+ */
1883
+ FunctionMode?: string
1884
+
1885
+ /**
1886
+ * FunctionMode取值为Partial时需要填写
1887
+ 注意:此字段可能返回 null,表示取不到有效值。
1888
+ */
1889
+ Functions?: Array<string>
1890
+
1891
+ /**
1892
+ * 选择要同步的模式,Partial为部分,All为整选
1893
+ 注意:此字段可能返回 null,表示取不到有效值。
1894
+ */
1895
+ ProcedureMode?: string
1896
+
1897
+ /**
1898
+ * ProcedureMode取值为Partial时需要填写
1899
+ 注意:此字段可能返回 null,表示取不到有效值。
1900
+ */
1901
+ Procedures?: Array<string>
1902
+ }
1903
+
1904
+ /**
1905
+ * ModifyMigrationJob请求参数结构体
1906
+ */
1907
+ export interface ModifyMigrationJobRequest {
1908
+ /**
1909
+ * 任务id
1910
+ */
1911
+ JobId: string
1912
+
1913
+ /**
1914
+ * 运行模式,取值如:immediate(表示立即运行)、timed(表示定时运行)
1915
+ */
1916
+ RunMode: string
1917
+
1918
+ /**
1919
+ * 迁移任务配置选项,描述任务如何执行迁移等一系列配置信息
1920
+ */
1921
+ MigrateOption: MigrateOption
1922
+
1923
+ /**
1924
+ * 源实例信息
1925
+ */
1926
+ SrcInfo: DBEndpointInfo
1927
+
1928
+ /**
1929
+ * 目标实例信息
1930
+ */
1931
+ DstInfo: DBEndpointInfo
1932
+
1933
+ /**
1934
+ * 迁移任务名称,最大长度128
1935
+ */
1936
+ JobName?: string
1937
+
1938
+ /**
1939
+ * 期待启动时间,当RunMode取值为timed时,此值必填,形如:"2006-01-02 15:04:05"
1940
+ */
1941
+ ExpectRunTime?: string
1942
+
1943
+ /**
1944
+ * 标签信息
1945
+ */
1946
+ Tags?: Array<TagItem>
1947
+ }
1948
+
1949
+ /**
1950
+ * DescribeSyncJobs请求参数结构体
1951
+ */
1952
+ export interface DescribeSyncJobsRequest {
1953
+ /**
1954
+ * 同步任务id
1955
+ */
1956
+ JobId?: string
1957
+
1958
+ /**
1959
+ * 同步任务名
1960
+ */
1961
+ JobName?: string
1962
+
1963
+ /**
1964
+ * 排序字段,可以取值为CreateTime
1965
+ */
1966
+ Order?: string
1967
+
1968
+ /**
1969
+ * 排序方式,升序为ASC,降序为DESC,默认为CreateTime降序
1970
+ */
1971
+ OrderSeq?: string
1972
+
1973
+ /**
1974
+ * 偏移量,默认为0
1975
+ */
1976
+ Offset?: number
1977
+
1978
+ /**
1979
+ * 返回同步任务实例数量,默认20,有效区间[1,100]
1980
+ */
1981
+ Limit?: number
1982
+
1983
+ /**
1984
+ * 状态集合,如Initialized,CheckPass,Running,ResumableErr,Stopped
1985
+ */
1986
+ Status?: Array<string>
1987
+
1988
+ /**
1989
+ * 运行模式,如Immediate:立即运行,Timed:定时运行
1990
+ */
1991
+ RunMode?: string
1992
+
1993
+ /**
1994
+ * 任务类型,如mysql2mysql:msyql同步到mysql
1995
+ */
1996
+ JobType?: string
1997
+
1998
+ /**
1999
+ * 付费类型,PrePay:预付费,PostPay:后付费
2000
+ */
2001
+ PayMode?: string
2002
+
2003
+ /**
2004
+ * tag
2005
+ */
2006
+ TagFilters?: Array<TagFilter>
2007
+ }
2008
+
2009
+ /**
2010
+ * 同步任务的步骤信息
2011
+ */
2012
+ export interface SyncDetailInfo {
2013
+ /**
2014
+ * 总步骤数
2015
+ 注意:此字段可能返回 null,表示取不到有效值。
2016
+ */
2017
+ StepAll: number
2018
+
2019
+ /**
2020
+ * 当前步骤
2021
+ 注意:此字段可能返回 null,表示取不到有效值。
2022
+ */
2023
+ StepNow: number
2024
+
2025
+ /**
2026
+ * 总体进度
2027
+ 注意:此字段可能返回 null,表示取不到有效值。
2028
+ */
2029
+ Progress: number
2030
+
2031
+ /**
2032
+ * 当前步骤进度
2033
+ 注意:此字段可能返回 null,表示取不到有效值。
2034
+ */
2035
+ CurrentStepProgress: number
2036
+
2037
+ /**
2038
+ * 同步两端数据量差距
2039
+ 注意:此字段可能返回 null,表示取不到有效值。
2040
+ */
2041
+ MasterSlaveDistance: number
2042
+
2043
+ /**
2044
+ * 同步两端时间差距
2045
+ 注意:此字段可能返回 null,表示取不到有效值。
2046
+ */
2047
+ SecondsBehindMaster: number
2048
+
2049
+ /**
2050
+ * 总体描述信息
2051
+ 注意:此字段可能返回 null,表示取不到有效值。
2052
+ */
2053
+ Message: string
2054
+
2055
+ /**
2056
+ * 详细步骤信息
2057
+ 注意:此字段可能返回 null,表示取不到有效值。
2058
+ */
2059
+ StepInfos: Array<StepInfo>
2060
+ }
2061
+
2062
+ /**
2063
+ * ResumeSyncJob请求参数结构体
2064
+ */
2065
+ export interface ResumeSyncJobRequest {
2066
+ /**
2067
+ * 同步任务id
2068
+ */
2069
+ JobId: string
2070
+ }
2071
+
2072
+ /**
2073
+ * 用于一致性校验的表配置
2074
+ */
2075
+ export interface CompareTableItem {
2076
+ /**
2077
+ * 表名称
2078
+ 注意:此字段可能返回 null,表示取不到有效值。
2079
+ */
2080
+ TableName?: string
2081
+ }
2082
+
2083
+ /**
2084
+ * ConfigureSyncJob返回参数结构体
2085
+ */
2086
+ export interface ConfigureSyncJobResponse {
2087
+ /**
2088
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2089
+ */
2090
+ RequestId?: string
2091
+ }
2092
+
2093
+ /**
2094
+ * 用于一致性校验的视图配置
2095
+ */
2096
+ export interface CompareViewItem {
2097
+ /**
2098
+ * 视图名
2099
+ 注意:此字段可能返回 null,表示取不到有效值。
2100
+ */
2101
+ ViewName?: string
2102
+ }
2103
+
2104
+ /**
2105
+ * 单个步骤的详细信息
2106
+ */
2107
+ export interface StepInfo {
2108
+ /**
2109
+ * 步骤编号
2110
+ 注意:此字段可能返回 null,表示取不到有效值。
2111
+ */
2112
+ StepNo?: number
2113
+
2114
+ /**
2115
+ * 步骤名
2116
+ 注意:此字段可能返回 null,表示取不到有效值。
2117
+ */
2118
+ StepName?: string
2119
+
2120
+ /**
2121
+ * 步骤标号
2122
+ 注意:此字段可能返回 null,表示取不到有效值。
2123
+ */
2124
+ StepId?: string
2125
+
2126
+ /**
2127
+ * 当前状态,是否完成
2128
+ 注意:此字段可能返回 null,表示取不到有效值。
2129
+ */
2130
+ Status?: string
2131
+
2132
+ /**
2133
+ * 步骤开始时间
2134
+ 注意:此字段可能返回 null,表示取不到有效值。
2135
+ */
2136
+ StartTime?: string
2137
+
2138
+ /**
2139
+ * 错误信息
2140
+ 注意:此字段可能返回 null,表示取不到有效值。
2141
+ */
2142
+ Errors?: Array<StepTip>
2143
+
2144
+ /**
2145
+ * 警告信息
2146
+ 注意:此字段可能返回 null,表示取不到有效值。
2147
+ */
2148
+ Warnings?: Array<StepTip>
2149
+
2150
+ /**
2151
+ * 当前步骤进度
2152
+ 注意:此字段可能返回 null,表示取不到有效值。
2153
+ */
2154
+ Progress?: number
2155
+ }
2156
+
2157
+ /**
2158
+ * ResumeMigrateJob请求参数结构体
2159
+ */
2160
+ export interface ResumeMigrateJobRequest {
2161
+ /**
2162
+ * 数据迁移任务ID
2163
+ */
2164
+ JobId: string
2165
+
2166
+ /**
2167
+ * 恢复任务的模式,目前的取值有:clearData 清空目标实例数据,overwrite 以覆盖写的方式执行任务,normal 跟正常流程一样,不做额外动作
2168
+ */
2169
+ ResumeOption: string
2170
+ }
2171
+
2172
+ /**
2173
+ * 计费状态信息
2174
+ */
2175
+ export interface TradeInfo {
2176
+ /**
2177
+ * 交易订单号
2178
+ 注意:此字段可能返回 null,表示取不到有效值。
2179
+ */
2180
+ DealName: string
2181
+
2182
+ /**
2183
+ * 上一次交易订单号
2184
+ 注意:此字段可能返回 null,表示取不到有效值。
2185
+ */
2186
+ LastDealName: string
2187
+
2188
+ /**
2189
+ * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
2190
+ 注意:此字段可能返回 null,表示取不到有效值。
2191
+ */
2192
+ InstanceClass: string
2193
+
2194
+ /**
2195
+ * 计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
2196
+ 注意:此字段可能返回 null,表示取不到有效值。
2197
+ */
2198
+ TradeStatus: string
2199
+
2200
+ /**
2201
+ * 到期时间,格式为"yyyy-mm-dd hh:mm:ss"
2202
+ 注意:此字段可能返回 null,表示取不到有效值。
2203
+ */
2204
+ ExpireTime: string
2205
+
2206
+ /**
2207
+ * 下线时间,格式为"yyyy-mm-dd hh:mm:ss"
2208
+ 注意:此字段可能返回 null,表示取不到有效值。
2209
+ */
2210
+ OfflineTime: string
2211
+
2212
+ /**
2213
+ * 隔离时间,格式为"yyyy-mm-dd hh:mm:ss"
2214
+ 注意:此字段可能返回 null,表示取不到有效值。
2215
+ */
2216
+ IsolateTime: string
2217
+
2218
+ /**
2219
+ * 下线原因
2220
+ 注意:此字段可能返回 null,表示取不到有效值。
2221
+ */
2222
+ OfflineReason: string
2223
+
2224
+ /**
2225
+ * 隔离原因
2226
+ 注意:此字段可能返回 null,表示取不到有效值。
2227
+ */
2228
+ IsolateReason: string
2229
+
2230
+ /**
2231
+ * 付费类型,包括:postpay(后付费)、prepay(预付费)
2232
+ 注意:此字段可能返回 null,表示取不到有效值。
2233
+ */
2234
+ PayType: string
2235
+
2236
+ /**
2237
+ * 任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
2238
+ 注意:此字段可能返回 null,表示取不到有效值。
2239
+ */
2240
+ BillingType: string
2241
+ }
2242
+
2243
+ /**
2244
+ * StartCompare返回参数结构体
2245
+ */
2246
+ export interface StartCompareResponse {
2247
+ /**
2248
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2249
+ */
2250
+ RequestId?: string
2251
+ }
2252
+
2253
+ /**
2254
+ * CreateCompareTask返回参数结构体
2255
+ */
2256
+ export interface CreateCompareTaskResponse {
2257
+ /**
2258
+ * 数据对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
2259
+ 注意:此字段可能返回 null,表示取不到有效值。
2260
+ */
2261
+ CompareTaskId: string
2262
+
2263
+ /**
2264
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2265
+ */
2266
+ RequestId?: string
2267
+ }
2268
+
2269
+ /**
2270
+ * StopCompare返回参数结构体
2271
+ */
2272
+ export interface StopCompareResponse {
2273
+ /**
2274
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2275
+ */
2276
+ RequestId?: string
2277
+ }
2278
+
2279
+ /**
2280
+ * 一致性校验摘要信息
2281
+ */
2282
+ export interface CompareAbstractInfo {
2283
+ /**
2284
+ * 对比结论: same,different
2285
+ 注意:此字段可能返回 null,表示取不到有效值。
2286
+ */
2287
+ Conclusion: string
2288
+
2289
+ /**
2290
+ * 任务状态: success,failed
2291
+ 注意:此字段可能返回 null,表示取不到有效值。
2292
+ */
2293
+ Status: string
2294
+
2295
+ /**
2296
+ * 总的表数量
2297
+ 注意:此字段可能返回 null,表示取不到有效值。
2298
+ */
2299
+ TotalTables: number
2300
+
2301
+ /**
2302
+ * 已校验的表数量
2303
+ 注意:此字段可能返回 null,表示取不到有效值。
2304
+ */
2305
+ CheckedTables: number
2306
+
2307
+ /**
2308
+ * 不一致的表数量
2309
+ 注意:此字段可能返回 null,表示取不到有效值。
2310
+ */
2311
+ DifferentTables: number
2312
+
2313
+ /**
2314
+ * 跳过校验的表数量
2315
+ 注意:此字段可能返回 null,表示取不到有效值。
2316
+ */
2317
+ SkippedTables: number
2318
+
2319
+ /**
2320
+ * 不一致的数据行数量
2321
+ 注意:此字段可能返回 null,表示取不到有效值。
2322
+ */
2323
+ DifferentRows: number
2324
+ }
2325
+
2326
+ /**
2327
+ * 检查步骤
2328
+ */
2329
+ export interface CheckStep {
2330
+ /**
2331
+ * 步骤编号
2332
+ 注意:此字段可能返回 null,表示取不到有效值。
2333
+ */
2334
+ StepNo: number
2335
+
2336
+ /**
2337
+ * 步骤Id, 如:ConnectDBCheck、VersionCheck、SrcPrivilegeCheck等,具体校验项和源目标实例相关
2338
+ 注意:此字段可能返回 null,表示取不到有效值。
2339
+ */
2340
+ StepId: string
2341
+
2342
+ /**
2343
+ * 步骤名称
2344
+ 注意:此字段可能返回 null,表示取不到有效值。
2345
+ */
2346
+ StepName: string
2347
+
2348
+ /**
2349
+ * 此检查步骤的结果,pass(校验通过)、failed(校验失败)、notStarted(校验还未开始进行)、blocked(检验阻塞)、warning(校验有告警,但仍通过)
2350
+ 注意:此字段可能返回 null,表示取不到有效值。
2351
+ */
2352
+ StepStatus: string
2353
+
2354
+ /**
2355
+ * 此检查步骤的错误消息
2356
+ 注意:此字段可能返回 null,表示取不到有效值。
2357
+ */
2358
+ StepMessage: string
2359
+
2360
+ /**
2361
+ * 每个检查步骤里的具体检查项
2362
+ 注意:此字段可能返回 null,表示取不到有效值。
2363
+ */
2364
+ DetailCheckItems: Array<DetailCheckItem>
2365
+
2366
+ /**
2367
+ * 是否已跳过
2368
+ 注意:此字段可能返回 null,表示取不到有效值。
2369
+ */
2370
+ HasSkipped: boolean
2371
+ }
2372
+
2373
+ /**
2374
+ * 一致性校验对象信息
2375
+ */
2376
+ export interface CompareTaskItem {
2377
+ /**
2378
+ * 迁移任务id
2379
+ 注意:此字段可能返回 null,表示取不到有效值。
2380
+ */
2381
+ JobId: string
2382
+
2383
+ /**
2384
+ * 对比任务 Id
2385
+ 注意:此字段可能返回 null,表示取不到有效值。
2386
+ */
2387
+ CompareTaskId: string
2388
+
2389
+ /**
2390
+ * 对比任务名称
2391
+ 注意:此字段可能返回 null,表示取不到有效值。
2392
+ */
2393
+ TaskName: string
2394
+
2395
+ /**
2396
+ * 对比任务状态, 可能的值:created - 创建完成;readyRun - 等待运行;running - 运行中;success - 成功;stopping - 结束中;failed - 失败;canceled - 已终止
2397
+ 注意:此字段可能返回 null,表示取不到有效值。
2398
+ */
2399
+ Status: string
2400
+
2401
+ /**
2402
+ * 对比任务配置
2403
+ 注意:此字段可能返回 null,表示取不到有效值。
2404
+ */
2405
+ Config: CompareObject
2406
+
2407
+ /**
2408
+ * 对比任务校验详情
2409
+ 注意:此字段可能返回 null,表示取不到有效值。
2410
+ */
2411
+ CheckProcess: ProcessProgress
2412
+
2413
+ /**
2414
+ * 对比任务运行详情
2415
+ 注意:此字段可能返回 null,表示取不到有效值。
2416
+ */
2417
+ CompareProcess: ProcessProgress
2418
+
2419
+ /**
2420
+ * 对比结果, 可能的值:same - 一致;different - 不一致;skipAll - 跳过
2421
+ 注意:此字段可能返回 null,表示取不到有效值。
2422
+ */
2423
+ Conclusion: string
2424
+
2425
+ /**
2426
+ * 任务创建时间
2427
+ 注意:此字段可能返回 null,表示取不到有效值。
2428
+ */
2429
+ CreatedAt: string
2430
+
2431
+ /**
2432
+ * 任务启动时间
2433
+ 注意:此字段可能返回 null,表示取不到有效值。
2434
+ */
2435
+ StartedAt: string
2436
+
2437
+ /**
2438
+ * 对比结束时间
2439
+ 注意:此字段可能返回 null,表示取不到有效值。
2440
+ */
2441
+ FinishedAt: string
2442
+ }
2443
+
2444
+ /**
2445
+ * ModifyMigrateJobSpec返回参数结构体
2446
+ */
2447
+ export interface ModifyMigrateJobSpecResponse {
2448
+ /**
2449
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2450
+ */
2451
+ RequestId?: string
2452
+ }
2453
+
2454
+ /**
2455
+ * CreateSyncJob返回参数结构体
2456
+ */
2457
+ export interface CreateSyncJobResponse {
2458
+ /**
2459
+ * 同步任务ids
2460
+ */
2461
+ JobIds: Array<string>
2462
+
2463
+ /**
2464
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2465
+ */
2466
+ RequestId?: string
2467
+ }
2468
+
2469
+ /**
2470
+ * CreateCompareTask请求参数结构体
2471
+ */
2472
+ export interface CreateCompareTaskRequest {
2473
+ /**
2474
+ * 迁移任务 Id
2475
+ */
2476
+ JobId: string
2477
+
2478
+ /**
2479
+ * 数据对比任务名称,若为空则默认给CompareTaskId相同值
2480
+ */
2481
+ TaskName?: string
2482
+
2483
+ /**
2484
+ * 数据对比对象模式,sameAsMigrate(全部迁移对象, 默认为此项配置),custom(自定义模式)
2485
+ */
2486
+ ObjectMode?: string
2487
+
2488
+ /**
2489
+ * 一致性对比对象配置
2490
+ */
2491
+ Objects?: CompareObject
2492
+ }
2493
+
2494
+ /**
2495
+ * StartCompare请求参数结构体
2496
+ */
2497
+ export interface StartCompareRequest {
2498
+ /**
2499
+ * 迁移任务 Id
2500
+ */
2501
+ JobId: string
2502
+
2503
+ /**
2504
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
2505
+ */
2506
+ CompareTaskId: string
2507
+ }
2508
+
2509
+ /**
2510
+ * DescribeMigrationCheckJob请求参数结构体
2511
+ */
2512
+ export interface DescribeMigrationCheckJobRequest {
2513
+ /**
2514
+ * 任务id
2515
+ */
2516
+ JobId: string
2517
+ }
2518
+
2519
+ /**
2520
+ * DescribeMigrationDetail返回参数结构体
2521
+ */
2522
+ export interface DescribeMigrationDetailResponse {
2523
+ /**
2524
+ * 数据迁移任务ID
2525
+ 注意:此字段可能返回 null,表示取不到有效值。
2526
+ */
2527
+ JobId: string
2528
+
2529
+ /**
2530
+ * 数据迁移任务名称
2531
+ 注意:此字段可能返回 null,表示取不到有效值。
2532
+ */
2533
+ JobName: string
2534
+
2535
+ /**
2536
+ * 任务创建(提交)时间,格式为 yyyy-mm-dd hh:mm:ss
2537
+ 注意:此字段可能返回 null,表示取不到有效值。
2538
+ */
2539
+ CreateTime: string
2540
+
2541
+ /**
2542
+ * 任务更新时间,格式为 yyyy-mm-dd hh:mm:ss
2543
+ 注意:此字段可能返回 null,表示取不到有效值。
2544
+ */
2545
+ UpdateTime: string
2546
+
2547
+ /**
2548
+ * 任务开始执行时间,格式为 yyyy-mm-dd hh:mm:ss
2549
+ 注意:此字段可能返回 null,表示取不到有效值。
2550
+ */
2551
+ StartTime: string
2552
+
2553
+ /**
2554
+ * 任务执行结束时间,格式为 yyyy-mm-dd hh:mm:ss
2555
+ 注意:此字段可能返回 null,表示取不到有效值。
2556
+ */
2557
+ EndTime: string
2558
+
2559
+ /**
2560
+ * 迁移任务简要错误信息
2561
+ 注意:此字段可能返回 null,表示取不到有效值。
2562
+ */
2563
+ BriefMsg: string
2564
+
2565
+ /**
2566
+ * 任务状态,取值为:created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行中)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)
2567
+ 注意:此字段可能返回 null,表示取不到有效值。
2568
+ */
2569
+ Status: string
2570
+
2571
+ /**
2572
+ * 任务操作信息
2573
+ 注意:此字段可能返回 null,表示取不到有效值。
2574
+ */
2575
+ Action: MigrateAction
2576
+
2577
+ /**
2578
+ * 迁移执行过程信息,在校验阶段显示校验过程步骤信息,在迁移阶段会显示迁移步骤信息
2579
+ 注意:此字段可能返回 null,表示取不到有效值。
2580
+ */
2581
+ StepInfo: MigrateDetailInfo
2582
+
2583
+ /**
2584
+ * 源实例信息
2585
+ 注意:此字段可能返回 null,表示取不到有效值。
2586
+ */
2587
+ SrcInfo: DBEndpointInfo
2588
+
2589
+ /**
2590
+ * 目标端信息
2591
+ 注意:此字段可能返回 null,表示取不到有效值。
2592
+ */
2593
+ DstInfo: DBEndpointInfo
2594
+
2595
+ /**
2596
+ * 数据一致性校验结果
2597
+ 注意:此字段可能返回 null,表示取不到有效值。
2598
+ */
2599
+ CompareTask: CompareTaskInfo
2600
+
2601
+ /**
2602
+ * 标签信息
2603
+ 注意:此字段可能返回 null,表示取不到有效值。
2604
+ */
2605
+ Tags: Array<TagItem>
2606
+
2607
+ /**
2608
+ * 运行模式,取值如:immediate(表示立即运行)、timed(表示定时运行)
2609
+ 注意:此字段可能返回 null,表示取不到有效值。
2610
+ */
2611
+ RunMode: string
2612
+
2613
+ /**
2614
+ * 期待启动时间,当RunMode取值为timed时,此值必填,形如:"2006-01-02 15:04:05"
2615
+ 注意:此字段可能返回 null,表示取不到有效值。
2616
+ */
2617
+ ExpectRunTime: string
2618
+
2619
+ /**
2620
+ * 迁移选项,描述任务如何执行迁移等一系列配置信息
2621
+ 注意:此字段可能返回 null,表示取不到有效值。
2622
+ */
2623
+ MigrateOption: MigrateOption
2624
+
2625
+ /**
2626
+ * 校验任务运行详情
2627
+ 注意:此字段可能返回 null,表示取不到有效值。
2628
+ */
2629
+ CheckStepInfo: CheckStepInfo
2630
+
2631
+ /**
2632
+ * 描述计费相关的信息
2633
+ 注意:此字段可能返回 null,表示取不到有效值。
2634
+ */
2635
+ TradeInfo: TradeInfo
2636
+
2637
+ /**
2638
+ * 任务错误信息
2639
+ 注意:此字段可能返回 null,表示取不到有效值。
2640
+ */
2641
+ ErrorInfo: Array<ErrorInfoItem>
2642
+
2643
+ /**
2644
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2645
+ */
2646
+ RequestId?: string
2647
+ }
2648
+
2649
+ /**
2650
+ * ModifyMigrateName请求参数结构体
2651
+ */
2652
+ export interface ModifyMigrateNameRequest {
2653
+ /**
2654
+ * 迁移任务id
2655
+ */
2656
+ JobId: string
2657
+
2658
+ /**
2659
+ * 修改后的迁移任务名
2660
+ */
2661
+ JobName: string
2662
+ }
2663
+
2664
+ /**
2665
+ * 迁移任务列表
2666
+ */
2667
+ export interface JobItem {
2668
+ /**
2669
+ * 数据迁移任务ID
2670
+ 注意:此字段可能返回 null,表示取不到有效值。
2671
+ */
2672
+ JobId: string
2673
+
2674
+ /**
2675
+ * 数据迁移任务名称
2676
+ 注意:此字段可能返回 null,表示取不到有效值。
2677
+ */
2678
+ JobName: string
2679
+
2680
+ /**
2681
+ * 任务创建(提交)时间,格式为 yyyy-mm-dd hh:mm:ss
2682
+ 注意:此字段可能返回 null,表示取不到有效值。
2683
+ */
2684
+ CreateTime: string
2685
+
2686
+ /**
2687
+ * 任务更新时间,格式为 yyyy-mm-dd hh:mm:ss
2688
+ 注意:此字段可能返回 null,表示取不到有效值。
2689
+ */
2690
+ UpdateTime: string
2691
+
2692
+ /**
2693
+ * 任务开始执行时间,格式为 yyyy-mm-dd hh:mm:ss
2694
+ 注意:此字段可能返回 null,表示取不到有效值。
2695
+ */
2696
+ StartTime: string
2697
+
2698
+ /**
2699
+ * 任务执行结束时间,格式为 yyyy-mm-dd hh:mm:ss
2700
+ 注意:此字段可能返回 null,表示取不到有效值。
2701
+ */
2702
+ EndTime: string
2703
+
2704
+ /**
2705
+ * 迁移任务错误信息
2706
+ 注意:此字段可能返回 null,表示取不到有效值。
2707
+ */
2708
+ BriefMsg: string
2709
+
2710
+ /**
2711
+ * 任务状态,取值为:creating(创建中)、created(创建完成)、checking(校验中)、checkPass(校验通过)、checkNotPass(校验不通过)、readyRun(准备运行)、running(任务运行)、readyComplete(准备完成)、success(任务成功)、failed(任务失败)、stopping(中止中)、completing(完成中)
2712
+ 注意:此字段可能返回 null,表示取不到有效值。
2713
+ */
2714
+ Status: string
2715
+
2716
+ /**
2717
+ * 任务运行模式,值包括:immediate(立即运行),timed(定时运行)
2718
+ 注意:此字段可能返回 null,表示取不到有效值。
2719
+ */
2720
+ RunMode: string
2721
+
2722
+ /**
2723
+ * 期待启动时间,当RunMode取值为timed时,此值必填,形如:2022-07-11 16:20:49
2724
+ 注意:此字段可能返回 null,表示取不到有效值。
2725
+ */
2726
+ ExpectRunTime: string
2727
+
2728
+ /**
2729
+ * 任务操作信息
2730
+ 注意:此字段可能返回 null,表示取不到有效值。
2731
+ */
2732
+ Action: MigrateAction
2733
+
2734
+ /**
2735
+ * 迁移执行过程信息
2736
+ 注意:此字段可能返回 null,表示取不到有效值。
2737
+ */
2738
+ StepInfo: MigrateDetailInfo
2739
+
2740
+ /**
2741
+ * 源实例信息
2742
+ 注意:此字段可能返回 null,表示取不到有效值。
2743
+ */
2744
+ SrcInfo: DBEndpointInfo
2745
+
2746
+ /**
2747
+ * 目标端信息
2748
+ 注意:此字段可能返回 null,表示取不到有效值。
2749
+ */
2750
+ DstInfo: DBEndpointInfo
2751
+
2752
+ /**
2753
+ * 数据一致性校验结果
2754
+ 注意:此字段可能返回 null,表示取不到有效值。
2755
+ */
2756
+ CompareTask: CompareTaskInfo
2757
+
2758
+ /**
2759
+ * 计费状态信息
2760
+ 注意:此字段可能返回 null,表示取不到有效值。
2761
+ */
2762
+ TradeInfo: TradeInfo
2763
+
2764
+ /**
2765
+ * 标签信息
2766
+ 注意:此字段可能返回 null,表示取不到有效值。
2767
+ */
2768
+ Tags: Array<TagItem>
2769
+ }
2770
+
2771
+ /**
2772
+ * StartSyncJob返回参数结构体
2773
+ */
2774
+ export interface StartSyncJobResponse {
2775
+ /**
2776
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2777
+ */
2778
+ RequestId?: string
2779
+ }
2780
+
2781
+ /**
2782
+ * 同步的数据库对对象描述
2783
+ */
2784
+ export interface Objects {
2785
+ /**
2786
+ * 迁移对象类型 Partial(部分对象)
2787
+ 注意:此字段可能返回 null,表示取不到有效值。
2788
+ */
2789
+ Mode?: string
2790
+
2791
+ /**
2792
+ * 同步对象,当 Mode 为 Partial 时,不为空
2793
+ 注意:此字段可能返回 null,表示取不到有效值。
2794
+ */
2795
+ Databases?: Array<Database>
2796
+
2797
+ /**
2798
+ * 高级对象类型,如function、procedure,当需要同步高级对象时,初始化类型必须包含结构初始化类型,即Options.InitType字段值为Structure或Full
2799
+ 注意:此字段可能返回 null,表示取不到有效值。
2800
+ */
2801
+ AdvancedObjects?: Array<string>
2802
+ }
2803
+
2804
+ /**
2805
+ * RecoverMigrateJob返回参数结构体
2806
+ */
2807
+ export interface RecoverMigrateJobResponse {
2808
+ /**
2809
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2810
+ */
2811
+ RequestId?: string
2812
+ }
2813
+
2814
+ /**
2815
+ * 迁移对象信息
2816
+ */
2817
+ export interface DBItem {
2818
+ /**
2819
+ * 需要迁移或同步的库名,当ObjectMode为partial时,此项必填
2820
+ 注意:此字段可能返回 null,表示取不到有效值。
2821
+ */
2822
+ DbName?: string
2823
+
2824
+ /**
2825
+ * 迁移或同步后的库名,默认与源库相同
2826
+ 注意:此字段可能返回 null,表示取不到有效值。
2827
+ */
2828
+ NewDbName?: string
2829
+
2830
+ /**
2831
+ * 迁移或同步的 schema
2832
+ 注意:此字段可能返回 null,表示取不到有效值。
2833
+ */
2834
+ SchemaName?: string
2835
+
2836
+ /**
2837
+ * 迁移或同步后的 schema name
2838
+ 注意:此字段可能返回 null,表示取不到有效值。
2839
+ */
2840
+ NewSchemaName?: string
2841
+
2842
+ /**
2843
+ * DB选择模式: all(为当前对象下的所有对象),partial(部分对象),当ObjectMode为partial时,此项必填
2844
+ 注意:此字段可能返回 null,表示取不到有效值。
2845
+ */
2846
+ DBMode?: string
2847
+
2848
+ /**
2849
+ * schema选择模式: all(为当前对象下的所有对象),partial(部分对象)
2850
+ 注意:此字段可能返回 null,表示取不到有效值。
2851
+ */
2852
+ SchemaMode?: string
2853
+
2854
+ /**
2855
+ * 表选择模式: all(为当前对象下的所有对象),partial(部分对象),当DBMode为partial时此项必填
2856
+ 注意:此字段可能返回 null,表示取不到有效值。
2857
+ */
2858
+ TableMode?: string
2859
+
2860
+ /**
2861
+ * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
2862
+ 注意:此字段可能返回 null,表示取不到有效值。
2863
+ */
2864
+ Tables?: Array<TableItem>
2865
+
2866
+ /**
2867
+ * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
2868
+ 注意:此字段可能返回 null,表示取不到有效值。
2869
+ */
2870
+ ViewMode?: string
2871
+
2872
+ /**
2873
+ * 视图对象集合,当 ViewMode 为 partial 时, 此项需要填写
2874
+ 注意:此字段可能返回 null,表示取不到有效值。
2875
+ */
2876
+ Views?: Array<ViewItem>
2877
+
2878
+ /**
2879
+ * postgresql独有参数,角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象
2880
+ 注意:此字段可能返回 null,表示取不到有效值。
2881
+ */
2882
+ RoleMode?: string
2883
+
2884
+ /**
2885
+ * postgresql独有参数,当 RoleMode 为 partial 时, 此项需要填写
2886
+ 注意:此字段可能返回 null,表示取不到有效值。
2887
+ */
2888
+ Roles?: Array<RoleItem>
2889
+
2890
+ /**
2891
+ * 选择要同步的模式,partial为部分,all为整选
2892
+ 注意:此字段可能返回 null,表示取不到有效值。
2893
+ */
2894
+ FunctionMode?: string
2895
+
2896
+ /**
2897
+ * 选择要同步的模式,partial为部分,all为整选
2898
+ 注意:此字段可能返回 null,表示取不到有效值。
2899
+ */
2900
+ TriggerMode?: string
2901
+
2902
+ /**
2903
+ * 选择要同步的模式,partial为部分,all为整选
2904
+ 注意:此字段可能返回 null,表示取不到有效值。
2905
+ */
2906
+ EventMode?: string
2907
+
2908
+ /**
2909
+ * 选择要同步的模式,partial为部分,all为整选
2910
+ 注意:此字段可能返回 null,表示取不到有效值。
2911
+ */
2912
+ ProcedureMode?: string
2913
+
2914
+ /**
2915
+ * FunctionMode取值为partial时需要填写
2916
+ 注意:此字段可能返回 null,表示取不到有效值。
2917
+ */
2918
+ Functions?: Array<string>
2919
+
2920
+ /**
2921
+ * ProcedureMode取值为partial时需要填写
2922
+ 注意:此字段可能返回 null,表示取不到有效值。
2923
+ */
2924
+ Procedures?: Array<string>
2925
+
2926
+ /**
2927
+ * EventMode取值为partial时需要填写
2928
+ 注意:此字段可能返回 null,表示取不到有效值。
2929
+ */
2930
+ Events?: Array<string>
2931
+
2932
+ /**
2933
+ * TriggerMode取值为partial时需要填写
2934
+ 注意:此字段可能返回 null,表示取不到有效值。
2935
+ */
2936
+ Triggers?: Array<string>
2937
+ }
2938
+
2939
+ /**
2940
+ * DeleteCompareTask请求参数结构体
2941
+ */
2942
+ export interface DeleteCompareTaskRequest {
2943
+ /**
2944
+ * 迁移任务 Id
2945
+ */
2946
+ JobId: string
2947
+
2948
+ /**
2949
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
2950
+ */
2951
+ CompareTaskId: string
2952
+ }
2953
+
2954
+ /**
2955
+ * 迁移执行过程信息
2956
+ */
2957
+ export interface MigrateDetailInfo {
2958
+ /**
2959
+ * 总步骤数
2960
+ 注意:此字段可能返回 null,表示取不到有效值。
2961
+ */
2962
+ StepAll: number
2963
+
2964
+ /**
2965
+ * 当前步骤
2966
+ 注意:此字段可能返回 null,表示取不到有效值。
2967
+ */
2968
+ StepNow: number
2969
+
2970
+ /**
2971
+ * 主从差距,MB;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
2972
+ 注意:此字段可能返回 null,表示取不到有效值。
2973
+ */
2974
+ MasterSlaveDistance: number
2975
+
2976
+ /**
2977
+ * 主从差距,秒;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
2978
+ 注意:此字段可能返回 null,表示取不到有效值。
2979
+ */
2980
+ SecondsBehindMaster: number
2981
+
2982
+ /**
2983
+ * 步骤信息
2984
+ 注意:此字段可能返回 null,表示取不到有效值。
2985
+ */
2986
+ StepInfo: Array<StepDetailInfo>
2987
+ }
2988
+
2989
+ /**
2990
+ * StopMigrateJob请求参数结构体
2991
+ */
2992
+ export interface StopMigrateJobRequest {
2993
+ /**
2994
+ * 数据迁移任务ID
2995
+ */
2996
+ JobId: string
2997
+ }
2998
+
2999
+ /**
3000
+ * IsolateMigrateJob返回参数结构体
3001
+ */
3002
+ export interface IsolateMigrateJobResponse {
3003
+ /**
3004
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3005
+ */
3006
+ RequestId?: string
3007
+ }
3008
+
3009
+ /**
3010
+ * 同步任务信息
3011
+ */
3012
+ export interface SyncJobInfo {
3013
+ /**
3014
+ * 同步任务id
3015
+ 注意:此字段可能返回 null,表示取不到有效值。
3016
+ */
3017
+ JobId: string
3018
+
3019
+ /**
3020
+ * 同步任务名
3021
+ 注意:此字段可能返回 null,表示取不到有效值。
3022
+ */
3023
+ JobName: string
3024
+
3025
+ /**
3026
+ * 付款方式
3027
+ 注意:此字段可能返回 null,表示取不到有效值。
3028
+ */
3029
+ PayMode: string
3030
+
3031
+ /**
3032
+ * 运行模式
3033
+ 注意:此字段可能返回 null,表示取不到有效值。
3034
+ */
3035
+ RunMode: string
3036
+
3037
+ /**
3038
+ * 期待运行时间
3039
+ 注意:此字段可能返回 null,表示取不到有效值。
3040
+ */
3041
+ ExpectRunTime: string
3042
+
3043
+ /**
3044
+ * 支持的所有操作
3045
+ 注意:此字段可能返回 null,表示取不到有效值。
3046
+ */
3047
+ AllActions: Array<string>
3048
+
3049
+ /**
3050
+ * 当前状态能进行的操作
3051
+ 注意:此字段可能返回 null,表示取不到有效值。
3052
+ */
3053
+ Actions: Array<string>
3054
+
3055
+ /**
3056
+ * 同步选项
3057
+ 注意:此字段可能返回 null,表示取不到有效值。
3058
+ */
3059
+ Options: Options
3060
+
3061
+ /**
3062
+ * 同步库表对象
3063
+ 注意:此字段可能返回 null,表示取不到有效值。
3064
+ */
3065
+ Objects: Objects
3066
+
3067
+ /**
3068
+ * 任务规格
3069
+ 注意:此字段可能返回 null,表示取不到有效值。
3070
+ */
3071
+ Specification: string
3072
+
3073
+ /**
3074
+ * 过期时间
3075
+ 注意:此字段可能返回 null,表示取不到有效值。
3076
+ */
3077
+ ExpireTime: string
3078
+
3079
+ /**
3080
+ * 源端地域
3081
+ 注意:此字段可能返回 null,表示取不到有效值。
3082
+ */
3083
+ SrcRegion: string
3084
+
3085
+ /**
3086
+ * 源端数据库类型
3087
+ 注意:此字段可能返回 null,表示取不到有效值。
3088
+ */
3089
+ SrcDatabaseType: string
3090
+
3091
+ /**
3092
+ * 源端接入类型
3093
+ 注意:此字段可能返回 null,表示取不到有效值。
3094
+ */
3095
+ SrcAccessType: string
3096
+
3097
+ /**
3098
+ * 源端信息
3099
+ 注意:此字段可能返回 null,表示取不到有效值。
3100
+ */
3101
+ SrcInfo: Endpoint
3102
+
3103
+ /**
3104
+ * 目标端地域
3105
+ 注意:此字段可能返回 null,表示取不到有效值。
3106
+ */
3107
+ DstRegion: string
3108
+
3109
+ /**
3110
+ * 目标端数据库类型
3111
+ 注意:此字段可能返回 null,表示取不到有效值。
3112
+ */
3113
+ DstDatabaseType: string
3114
+
3115
+ /**
3116
+ * 目标端接入类型
3117
+ 注意:此字段可能返回 null,表示取不到有效值。
3118
+ */
3119
+ DstAccessType: string
3120
+
3121
+ /**
3122
+ * 目标端信息
3123
+ 注意:此字段可能返回 null,表示取不到有效值。
3124
+ */
3125
+ DstInfo: Endpoint
3126
+
3127
+ /**
3128
+ * 创建时间
3129
+ 注意:此字段可能返回 null,表示取不到有效值。
3130
+ */
3131
+ CreateTime: string
3132
+
3133
+ /**
3134
+ * 开始时间
3135
+ 注意:此字段可能返回 null,表示取不到有效值。
3136
+ */
3137
+ StartTime: string
3138
+
3139
+ /**
3140
+ * 结束时间
3141
+ 注意:此字段可能返回 null,表示取不到有效值。
3142
+ */
3143
+ EndTime: string
3144
+
3145
+ /**
3146
+ * 任务状态
3147
+ 注意:此字段可能返回 null,表示取不到有效值。
3148
+ */
3149
+ Status: string
3150
+
3151
+ /**
3152
+ * 标签相关
3153
+ 注意:此字段可能返回 null,表示取不到有效值。
3154
+ */
3155
+ Tags: Array<TagItem>
3156
+
3157
+ /**
3158
+ * 同步任务运行步骤信息
3159
+ 注意:此字段可能返回 null,表示取不到有效值。
3160
+ */
3161
+ Detail: SyncDetailInfo
3162
+ }
3163
+
3164
+ /**
3165
+ * 角色对象,postgresql独有参数
3166
+ */
3167
+ export interface RoleItem {
3168
+ /**
3169
+ * 角色名称
3170
+ 注意:此字段可能返回 null,表示取不到有效值。
3171
+ */
3172
+ RoleName?: string
3173
+
3174
+ /**
3175
+ * 迁移后的角色名称
3176
+ 注意:此字段可能返回 null,表示取不到有效值。
3177
+ */
3178
+ NewRoleName?: string
3179
+ }
3180
+
3181
+ /**
3182
+ * 标签过滤
3183
+ */
3184
+ export interface TagFilter {
3185
+ /**
3186
+ * 标签键值
3187
+ */
3188
+ TagKey: string
3189
+
3190
+ /**
3191
+ * 标签值
3192
+ */
3193
+ TagValue?: Array<string>
3194
+ }
3195
+
3196
+ /**
3197
+ * 步骤信息
3198
+ */
3199
+ export interface StepDetailInfo {
3200
+ /**
3201
+ * 步骤序列
3202
+ 注意:此字段可能返回 null,表示取不到有效值。
3203
+ */
3204
+ StepNo: number
3205
+
3206
+ /**
3207
+ * 步骤展现名称
3208
+ 注意:此字段可能返回 null,表示取不到有效值。
3209
+ */
3210
+ StepName: string
3211
+
3212
+ /**
3213
+ * 步骤英文标识
3214
+ 注意:此字段可能返回 null,表示取不到有效值。
3215
+ */
3216
+ StepId: string
3217
+
3218
+ /**
3219
+ * 步骤状态:success(成功)、failed(失败)、running(执行中)、notStarted(未执行)、默认为notStarted
3220
+ 注意:此字段可能返回 null,表示取不到有效值。
3221
+ */
3222
+ Status: string
3223
+
3224
+ /**
3225
+ * 当前步骤开始的时间,格式为"yyyy-mm-dd hh:mm:ss",该字段不存在或者为空是无意义 注意:此字段可能返回 null,表示取不到有效值。
3226
+ 注意:此字段可能返回 null,表示取不到有效值。
3227
+ */
3228
+ StartTime: string
3229
+
3230
+ /**
3231
+ * 步骤错误信息
3232
+ 注意:此字段可能返回 null,表示取不到有效值。
3233
+ */
3234
+ StepMessage: string
3235
+
3236
+ /**
3237
+ * 执行进度
3238
+ 注意:此字段可能返回 null,表示取不到有效值。
3239
+ */
3240
+ Percent: number
3241
+
3242
+ /**
3243
+ * 错误信息
3244
+ 注意:此字段可能返回 null,表示取不到有效值。
3245
+ */
3246
+ Errors: Array<ProcessStepTip>
3247
+
3248
+ /**
3249
+ * 告警提示
3250
+ 注意:此字段可能返回 null,表示取不到有效值。
3251
+ */
3252
+ Warnings: Array<ProcessStepTip>
3253
+ }
3254
+
3255
+ /**
3256
+ * CreateSyncJob请求参数结构体
3257
+ */
3258
+ export interface CreateSyncJobRequest {
3259
+ /**
3260
+ * 支付类型,PrePay:包年包月 PostPay:按时按量
3261
+ */
3262
+ PayMode: string
3263
+
3264
+ /**
3265
+ * 源端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等
3266
+ */
3267
+ SrcDatabaseType: string
3268
+
3269
+ /**
3270
+ * 源端数据库所在地域,如ap-guangzhou
3271
+ */
3272
+ SrcRegion: string
3273
+
3274
+ /**
3275
+ * 目标端数据库类型,如mysql,cynosdbmysql,tdapg,tdpg,tdsqlmysql等
3276
+ */
3277
+ DstDatabaseType: string
3278
+
3279
+ /**
3280
+ * 目标端数据库所在地域,如ap-guangzhou
3281
+ */
3282
+ DstRegion: string
3283
+
3284
+ /**
3285
+ * 同步任务规格,Standard:标准版
3286
+ */
3287
+ Specification?: string
3288
+
3289
+ /**
3290
+ * 无
3291
+ */
3292
+ Tags?: Array<TagItem>
3293
+
3294
+ /**
3295
+ * 同步任务数量
3296
+ */
3297
+ Count?: number
3298
+
3299
+ /**
3300
+ * 自动续费标识
3301
+ */
3302
+ AutoRenew?: number
3303
+
3304
+ /**
3305
+ * 同步链路规格
3306
+ */
3307
+ InstanceClass?: string
3308
+
3309
+ /**
3310
+ * 同步链路名称
3311
+ */
3312
+ JobName?: string
3313
+
3314
+ /**
3315
+ * 创建类似任务的现有任务Id
3316
+ */
3317
+ ExistedJobId?: string
3318
+ }
3319
+
3320
+ /**
3321
+ * 视图对象
3322
+ */
3323
+ export interface ViewItem {
3324
+ /**
3325
+ * 视图名称
3326
+ 注意:此字段可能返回 null,表示取不到有效值。
3327
+ */
3328
+ ViewName?: string
3329
+
3330
+ /**
3331
+ * 迁移后的视图名称
3332
+ 注意:此字段可能返回 null,表示取不到有效值。
3333
+ */
3334
+ NewViewName?: string
3335
+ }
3336
+
3337
+ /**
3338
+ * DescribeCompareReport请求参数结构体
3339
+ */
3340
+ export interface DescribeCompareReportRequest {
3341
+ /**
3342
+ * 迁移任务 Id
3343
+ */
3344
+ JobId: string
3345
+
3346
+ /**
3347
+ * 校验任务 Id
3348
+ */
3349
+ CompareTaskId: string
3350
+
3351
+ /**
3352
+ * 校验不一致结果的 limit
3353
+ */
3354
+ DifferenceLimit?: number
3355
+
3356
+ /**
3357
+ * 不一致的 Offset
3358
+ */
3359
+ DifferenceOffset?: number
3360
+
3361
+ /**
3362
+ * 搜索条件,不一致的库名
3363
+ */
3364
+ DifferenceDB?: string
3365
+
3366
+ /**
3367
+ * 搜索条件,不一致的表名
3368
+ */
3369
+ DifferenceTable?: string
3370
+
3371
+ /**
3372
+ * 未校验的 Limit
3373
+ */
3374
+ SkippedLimit?: number
3375
+
3376
+ /**
3377
+ * 未校验的 Offset
3378
+ */
3379
+ SkippedOffset?: number
3380
+
3381
+ /**
3382
+ * 搜索条件,未校验的库名
3383
+ */
3384
+ SkippedDB?: string
3385
+
3386
+ /**
3387
+ * 搜索条件,未校验的表名
3388
+ */
3389
+ SkippedTable?: string
3390
+ }
3391
+
3392
+ /**
3393
+ * 数据同步view的描述
3394
+ */
3395
+ export interface View {
3396
+ /**
3397
+ * view名
3398
+ 注意:此字段可能返回 null,表示取不到有效值。
3399
+ */
3400
+ ViewName?: string
3401
+
3402
+ /**
3403
+ * 新view名
3404
+ 注意:此字段可能返回 null,表示取不到有效值。
3405
+ */
3406
+ NewViewName?: string
3407
+ }
3408
+
3409
+ /**
3410
+ * 标签
3411
+ */
3412
+ export interface TagItem {
3413
+ /**
3414
+ * 标签键
3415
+ 注意:此字段可能返回 null,表示取不到有效值。
3416
+ */
3417
+ TagKey?: string
3418
+
3419
+ /**
3420
+ * 标签值
3421
+ 注意:此字段可能返回 null,表示取不到有效值。
3422
+ */
3423
+ TagValue?: string
3424
+ }
3425
+
3426
+ /**
3427
+ * RecoverMigrateJob请求参数结构体
3428
+ */
3429
+ export interface RecoverMigrateJobRequest {
3430
+ /**
3431
+ * 任务id
3432
+ */
3433
+ JobId: string
3434
+ }
3435
+
3436
+ /**
3437
+ * 迁移对象选项,需要告知迁移服务迁移哪些库表对象
3438
+ */
3439
+ export interface DatabaseTableObject {
3440
+ /**
3441
+ * 迁移对象类型 all(全实例),partial(部分对象)
3442
+ 注意:此字段可能返回 null,表示取不到有效值。
3443
+ */
3444
+ ObjectMode: string
3445
+
3446
+ /**
3447
+ * 迁移对象,当 ObjectMode 为 partial 时,不为空
3448
+ 注意:此字段可能返回 null,表示取不到有效值。
3449
+ */
3450
+ Databases?: Array<DBItem>
3451
+
3452
+ /**
3453
+ * 高级对象类型,如trigger、function、procedure、event
3454
+ 注意:此字段可能返回 null,表示取不到有效值。
3455
+ */
3456
+ AdvancedObjects?: Array<string>
3457
+ }
3458
+
3459
+ /**
3460
+ * 数据同步库表信息描述
3461
+ */
3462
+ export interface Table {
3463
+ /**
3464
+ * 表名
3465
+ 注意:此字段可能返回 null,表示取不到有效值。
3466
+ */
3467
+ TableName?: string
3468
+
3469
+ /**
3470
+ * 新表名
3471
+ 注意:此字段可能返回 null,表示取不到有效值。
3472
+ */
3473
+ NewTableName?: string
3474
+
3475
+ /**
3476
+ * 过滤条件
3477
+ 注意:此字段可能返回 null,表示取不到有效值。
3478
+ */
3479
+ FilterCondition?: string
3480
+ }
3481
+
3482
+ /**
3483
+ * 一致性校验详细信息
3484
+ */
3485
+ export interface CompareDetailInfo {
3486
+ /**
3487
+ * 数据不一致的表详情
3488
+ 注意:此字段可能返回 null,表示取不到有效值。
3489
+ */
3490
+ Difference: DifferenceDetail
3491
+
3492
+ /**
3493
+ * 跳过校验的表详情
3494
+ 注意:此字段可能返回 null,表示取不到有效值。
3495
+ */
3496
+ Skipped: SkippedDetail
3497
+ }
3498
+
3499
+ /**
3500
+ * StartMigrateJob返回参数结构体
3501
+ */
3502
+ export interface StartMigrateJobResponse {
3503
+ /**
3504
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3505
+ */
3506
+ RequestId?: string
3507
+ }
3508
+
3509
+ /**
3510
+ * 数据一致性校验选项, 默认为不开启一致性校验
3511
+ */
3512
+ export interface ConsistencyOption {
3513
+ /**
3514
+ * 一致性检测类型: full(全量检测迁移对象)、noCheck(不检测)、notConfigured(未配置)
3515
+ 注意:此字段可能返回 null,表示取不到有效值。
3516
+ */
3517
+ Mode?: string
3518
+ }