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