tencentcloud-sdk-nodejs 4.0.776 → 4.0.777

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 (38) hide show
  1. package/CHANGELOG.md +155 -0
  2. package/SERVICE_CHANGELOG.md +219 -131
  3. package/package.json +1 -1
  4. package/products.md +12 -12
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cvm/v20170312/cvm_models.ts +2 -2
  7. package/src/services/cynosdb/v20190107/cynosdb_client.ts +3 -1
  8. package/src/services/cynosdb/v20190107/cynosdb_models.ts +69 -6
  9. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  10. package/src/services/dts/v20211206/dts_client.ts +307 -24
  11. package/src/services/dts/v20211206/dts_models.ts +1721 -402
  12. package/src/services/ess/v20201111/ess_models.ts +10 -9
  13. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  14. package/src/services/essbasic/v20210526/essbasic_models.ts +3 -2
  15. package/src/services/monitor/v20180724/monitor_models.ts +4 -0
  16. package/src/services/ocr/v20181119/ocr_models.ts +2 -0
  17. package/src/services/rum/v20210622/rum_client.ts +28 -64
  18. package/src/services/rum/v20210622/rum_models.ts +46 -134
  19. package/tencentcloud/common/sdk_version.d.ts +1 -1
  20. package/tencentcloud/common/sdk_version.js +1 -1
  21. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +2 -2
  22. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +1 -1
  23. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +67 -6
  24. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  25. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +96 -3
  26. package/tencentcloud/services/dts/v20211206/dts_client.js +140 -3
  27. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1677 -416
  28. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +10 -9
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  30. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  31. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +3 -2
  32. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
  33. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -0
  34. package/tencentcloud/services/rum/v20210622/rum_client.d.ts +9 -21
  35. package/tencentcloud/services/rum/v20210622/rum_client.js +12 -30
  36. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +46 -128
  37. package/test/dts.v20211206.test.js +222 -2
  38. package/test/rum.v20210622.test.js +8 -38
@@ -55,6 +55,16 @@ export interface ModifyMigrationJobResponse {
55
55
  RequestId?: string
56
56
  }
57
57
 
58
+ /**
59
+ * ResetConsumerGroupOffset返回参数结构体
60
+ */
61
+ export interface ResetConsumerGroupOffsetResponse {
62
+ /**
63
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
64
+ */
65
+ RequestId?: string
66
+ }
67
+
58
68
  /**
59
69
  * ModifyMigrateRateLimit返回参数结构体
60
70
  */
@@ -65,6 +75,16 @@ export interface ModifyMigrateRateLimitResponse {
65
75
  RequestId?: string
66
76
  }
67
77
 
78
+ /**
79
+ * IsolateMigrateJob返回参数结构体
80
+ */
81
+ export interface IsolateMigrateJobResponse {
82
+ /**
83
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
84
+ */
85
+ RequestId?: string
86
+ }
87
+
68
88
  /**
69
89
  * ModifyMigrateJobSpec请求参数结构体
70
90
  */
@@ -80,13 +100,39 @@ export interface ModifyMigrateJobSpecRequest {
80
100
  }
81
101
 
82
102
  /**
83
- * StartMigrateJob请求参数结构体
103
+ * IsolateSubscribe返回参数结构体
84
104
  */
85
- export interface StartMigrateJobRequest {
105
+ export interface IsolateSubscribeResponse {
86
106
  /**
87
- * 数据迁移任务ID
107
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
88
108
  */
89
- JobId: string
109
+ RequestId?: string
110
+ }
111
+
112
+ /**
113
+ * ModifyConsumerGroupPassword请求参数结构体
114
+ */
115
+ export interface ModifyConsumerGroupPasswordRequest {
116
+ /**
117
+ * 数据订阅实例的 ID
118
+ */
119
+ SubscribeId: string
120
+ /**
121
+ * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}
122
+ */
123
+ AccountName: string
124
+ /**
125
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
126
+ */
127
+ ConsumerGroupName: string
128
+ /**
129
+ * 旧密码
130
+ */
131
+ OldPassword: string
132
+ /**
133
+ * 新密码。字符长度不小于3,不大于32
134
+ */
135
+ NewPassword: string
90
136
  }
91
137
 
92
138
  /**
@@ -140,6 +186,36 @@ export interface DestroyMigrateJobRequest {
140
186
  JobId?: string
141
187
  }
142
188
 
189
+ /**
190
+ * ModifySubscribeName请求参数结构体
191
+ */
192
+ export interface ModifySubscribeNameRequest {
193
+ /**
194
+ * 数据订阅实例的ID
195
+ */
196
+ SubscribeId: string
197
+ /**
198
+ * 修改后的数据订阅实例的名称,长度限制为[1,60]
199
+ */
200
+ SubscribeName: string
201
+ }
202
+
203
+ /**
204
+ * 数据订阅kafka分区中checkpoint信息
205
+ */
206
+ export interface OffsetTimeMap {
207
+ /**
208
+ * kafka分区编号
209
+ 注意:此字段可能返回 null,表示取不到有效值。
210
+ */
211
+ PartitionNo?: number
212
+ /**
213
+ * kafka offset
214
+ 注意:此字段可能返回 null,表示取不到有效值。
215
+ */
216
+ Offset?: number
217
+ }
218
+
143
219
  /**
144
220
  * SkipCheckItem返回参数结构体
145
221
  */
@@ -156,15 +232,30 @@ export interface SkipCheckItemResponse {
156
232
  }
157
233
 
158
234
  /**
159
- * IsolateMigrateJob请求参数结构体
235
+ * ResumeSyncJob请求参数结构体
160
236
  */
161
- export interface IsolateMigrateJobRequest {
237
+ export interface ResumeSyncJobRequest {
162
238
  /**
163
- * 任务id
239
+ * 同步任务id
164
240
  */
165
241
  JobId: string
166
242
  }
167
243
 
244
+ /**
245
+ * 数据订阅中kafka消费者组的分区分配情况。该数据是实时查询的,如果需要最新数据,需重新掉接口查询。
246
+ */
247
+ export interface PartitionAssignment {
248
+ /**
249
+ * 消费者的clientId
250
+ */
251
+ ClientId: string
252
+ /**
253
+ * 该消费者正在消费的分区
254
+ 注意:此字段可能返回 null,表示取不到有效值。
255
+ */
256
+ PartitionNo: Array<number | bigint>
257
+ }
258
+
168
259
  /**
169
260
  * ResizeSyncJob返回参数结构体
170
261
  */
@@ -175,6 +266,16 @@ export interface ResizeSyncJobResponse {
175
266
  RequestId?: string
176
267
  }
177
268
 
269
+ /**
270
+ * CreateSubscribeCheckJob请求参数结构体
271
+ */
272
+ export interface CreateSubscribeCheckJobRequest {
273
+ /**
274
+ * 数据订阅实例的 ID
275
+ */
276
+ SubscribeId: string
277
+ }
278
+
178
279
  /**
179
280
  * ResumeMigrateJob返回参数结构体
180
281
  */
@@ -281,6 +382,36 @@ export interface ContinueMigrateJobRequest {
281
382
  JobId: string
282
383
  }
283
384
 
385
+ /**
386
+ * ResetConsumerGroupOffset请求参数结构体
387
+ */
388
+ export interface ResetConsumerGroupOffsetRequest {
389
+ /**
390
+ * 订阅实例id
391
+ */
392
+ SubscribeId: string
393
+ /**
394
+ * 订阅的kafka topic
395
+ */
396
+ TopicName: string
397
+ /**
398
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
399
+ */
400
+ ConsumerGroupName: string
401
+ /**
402
+ * 需要修改offset的分区编号
403
+ */
404
+ PartitionNos: Array<number | bigint>
405
+ /**
406
+ * 重置方式。枚举值为 earliest-从最开始位置开始消费;latest-从最新位置开始消费;datetime-从指定时间前最近的checkpoint开始消费
407
+ */
408
+ ResetMode: string
409
+ /**
410
+ * 当 ResetMode 为 datetime 时,该项需要填,格式为:Y-m-d h:m:s。如果不填,默认用0时间,效果与earliest相同。
411
+ */
412
+ ResetDatetime?: string
413
+ }
414
+
284
415
  /**
285
416
  * ModifySyncRateLimit请求参数结构体
286
417
  */
@@ -322,9 +453,9 @@ export interface DescribeCheckSyncJobResultRequest {
322
453
  }
323
454
 
324
455
  /**
325
- * DestroySyncJob返回参数结构体
456
+ * ModifySubscribeAutoRenewFlag返回参数结构体
326
457
  */
327
- export interface DestroySyncJobResponse {
458
+ export interface ModifySubscribeAutoRenewFlagResponse {
328
459
  /**
329
460
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
330
461
  */
@@ -332,19 +463,9 @@ export interface DestroySyncJobResponse {
332
463
  }
333
464
 
334
465
  /**
335
- * DescribeCompareReport返回参数结构体
466
+ * DestroySyncJob返回参数结构体
336
467
  */
337
- export interface DescribeCompareReportResponse {
338
- /**
339
- * 一致性校验摘要信息
340
- 注意:此字段可能返回 null,表示取不到有效值。
341
- */
342
- Abstract: CompareAbstractInfo
343
- /**
344
- * 一致性校验详细信息
345
- 注意:此字段可能返回 null,表示取不到有效值。
346
- */
347
- Detail: CompareDetailInfo
468
+ export interface DestroySyncJobResponse {
348
469
  /**
349
470
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
350
471
  */
@@ -352,180 +473,178 @@ export interface DescribeCompareReportResponse {
352
473
  }
353
474
 
354
475
  /**
355
- * 数据同步中的描述源端和目的端的信息
476
+ * 任务错误信息
356
477
  */
357
- export interface Endpoint {
478
+ export interface ErrorInfoItem {
358
479
  /**
359
- * 地域英文名,如:ap-guangzhou
480
+ * 错误码
360
481
  注意:此字段可能返回 null,表示取不到有效值。
361
482
  */
362
- Region?: string
483
+ Code?: string
363
484
  /**
364
- * tdsql mysql版的节点类型,枚举值为proxy、set
485
+ * 解决方案
365
486
  注意:此字段可能返回 null,表示取不到有效值。
366
487
  */
367
- Role?: string
488
+ Solution?: string
368
489
  /**
369
- * 数据库内核类型,tdsql中用于区分不同内核:percona,mariadb,mysql
490
+ * 错误日志信息
370
491
  注意:此字段可能返回 null,表示取不到有效值。
371
492
  */
372
- DbKernel?: string
493
+ ErrorLog?: string
373
494
  /**
374
- * 数据库实例ID,格式如:cdb-powiqx8q
495
+ * 文档提示
375
496
  注意:此字段可能返回 null,表示取不到有效值。
376
497
  */
377
- InstanceId?: string
498
+ HelpDoc?: string
499
+ }
500
+
501
+ /**
502
+ * IsolateMigrateJob请求参数结构体
503
+ */
504
+ export interface IsolateMigrateJobRequest {
378
505
  /**
379
- * 实例的IP地址,接入类型为非cdb时此项必填
380
- 注意:此字段可能返回 null,表示取不到有效值。
506
+ * 任务id
381
507
  */
382
- Ip?: string
508
+ JobId: string
509
+ }
510
+
511
+ /**
512
+ * StopMigrateJob返回参数结构体
513
+ */
514
+ export interface StopMigrateJobResponse {
383
515
  /**
384
- * 实例端口,接入类型为非cdb时此项必填
385
- 注意:此字段可能返回 null,表示取不到有效值。
516
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
386
517
  */
387
- Port?: number
518
+ RequestId?: string
519
+ }
520
+
521
+ /**
522
+ * 表对象集合,当 TableMode 为 partial 时,此项需要填写
523
+ */
524
+ export interface TableItem {
388
525
  /**
389
- * 用户名,对于访问需要用户名密码认证的实例必填
526
+ * 迁移的表名,大小写敏感
390
527
  注意:此字段可能返回 null,表示取不到有效值。
391
528
  */
392
- User?: string
529
+ TableName?: string
393
530
  /**
394
- * 密码,对于访问需要用户名密码认证的实例必填
531
+ * 迁移后的表名,当TableEditMode为rename时此项必填,注意此配置与TmpTables互斥,只能使用其中一种
395
532
  注意:此字段可能返回 null,表示取不到有效值。
396
533
  */
397
- Password?: string
534
+ NewTableName?: string
398
535
  /**
399
- * 数据库名,数据库为cdwpg时,需要提供
536
+ * 迁移临时表,注意此配置与NewTableName互斥,只能使用其中一种。当配置的同步对象为表级别且TableEditMode为pt时此项有意义,针对pt-osc等工具在迁移过程中产生的临时表进行同步,需要提前将可能的临时表配置在这里,否则不会同步任何临时表。示例,如要对t1进行pt-osc操作,此项配置应该为["\_t1\_new","\_t1\_old"];如要对t1进行gh-ost操作,此项配置应该为["\_t1\_ghc","\_t1\_gho","\_t1\_del"],pt-osc与gh-ost产生的临时表可同时配置。
400
537
  注意:此字段可能返回 null,表示取不到有效值。
401
538
  */
402
- DbName?: string
539
+ TmpTables?: Array<string>
403
540
  /**
404
- * 私有网络ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:vpc-92jblxto
541
+ * 编辑表类型,rename(表映射),pt(同步附加表)
405
542
  注意:此字段可能返回 null,表示取不到有效值。
406
543
  */
407
- VpcId?: string
544
+ TableEditMode?: string
545
+ }
546
+
547
+ /**
548
+ * 订阅实例信息
549
+ */
550
+ export interface SubscribeInfo {
408
551
  /**
409
- * 私有网络下的子网ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:subnet-3paxmkdz
410
- 注意:此字段可能返回 null,表示取不到有效值。
552
+ * 数据订阅的实例ID
411
553
  */
412
- SubnetId?: string
554
+ SubscribeId?: string
413
555
  /**
414
- * CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
415
- 注意:此字段可能返回 null,表示取不到有效值。
556
+ * 数据订阅实例的名称
416
557
  */
417
- CvmInstanceId?: string
558
+ SubscribeName?: string
418
559
  /**
419
- * 专线网关ID,对于专线接入类型此项必填,格式如:dcg-0rxtqqxb
560
+ * 订阅实例发送数据的kafka topic
420
561
  注意:此字段可能返回 null,表示取不到有效值。
421
562
  */
422
- UniqDcgId?: string
563
+ Topic?: string
423
564
  /**
424
- * VPN网关ID,对于vpn接入类型此项必填,格式如:vpngw-9ghexg7q
425
- 注意:此字段可能返回 null,表示取不到有效值。
565
+ * 订阅实例的类型,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
426
566
  */
427
- UniqVpnGwId?: string
567
+ Product?: string
428
568
  /**
429
- * 云联网ID,对于云联网接入类型此项必填,如:ccn-afp6kltc
569
+ * 订阅的数据库实例ID(如果订阅的是云数据库)如果实例不是腾讯云上的,此值为空。
430
570
  注意:此字段可能返回 null,表示取不到有效值。
431
571
  */
432
- CcnId?: string
572
+ InstanceId?: string
433
573
  /**
434
- * 云厂商类型,当实例为RDS实例时,填写为aliyun, 其他情况均填写others,默认为others
574
+ * 云数据库状态:running 运行中,isolated 已隔离,offline 已下线。如果不是云上,此值为空
435
575
  注意:此字段可能返回 null,表示取不到有效值。
436
576
  */
437
- Supplier?: string
577
+ InstanceStatus?: string
438
578
  /**
439
- * 数据库版本,当实例为RDS实例时才有效,其他实例忽略,格式如:5.6或者5.7,默认为5.6
440
- 注意:此字段可能返回 null,表示取不到有效值。
579
+ * 数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
441
580
  */
442
- EngineVersion?: string
581
+ Status?: string
443
582
  /**
444
- * 实例所属账号,如果为跨账号实例此项必填
445
- 注意:此字段可能返回 null,表示取不到有效值。
583
+ * 数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
446
584
  */
447
- Account?: string
585
+ SubsStatus?: string
448
586
  /**
449
- * 资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)
587
+ * 上次修改时间,时间格式如:Y-m-d h:m:s
450
588
  注意:此字段可能返回 null,表示取不到有效值。
451
589
  */
452
- AccountMode?: string
590
+ ModifyTime?: string
453
591
  /**
454
- * 跨账号同步时的角色,只允许[a-zA-Z0-9\-\_]+,如果为跨账号实例此项必填
592
+ * 创建时间,时间格式如:Y-m-d h:m:s
455
593
  注意:此字段可能返回 null,表示取不到有效值。
456
594
  */
457
- AccountRole?: string
595
+ CreateTime?: string
458
596
  /**
459
- * 外部角色id
597
+ * 隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
460
598
  注意:此字段可能返回 null,表示取不到有效值。
461
599
  */
462
- RoleExternalId?: string
600
+ IsolateTime?: string
463
601
  /**
464
- * 临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填
602
+ * 包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
465
603
  注意:此字段可能返回 null,表示取不到有效值。
466
604
  */
467
- TmpSecretId?: string
605
+ ExpireTime?: string
468
606
  /**
469
- * 临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
607
+ * 下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
470
608
  注意:此字段可能返回 null,表示取不到有效值。
471
609
  */
472
- TmpSecretKey?: string
610
+ OfflineTime?: string
473
611
  /**
474
- * 临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
475
- 注意:此字段可能返回 null,表示取不到有效值。
612
+ * 计费方式,0 - 包年包月,1 - 按量计费
476
613
  */
477
- TmpToken?: string
614
+ PayType?: number
478
615
  /**
479
- * 是否走加密传输、UnEncrypted表示不走加密传输,Encrypted表示走加密传输,默认UnEncrypted
480
- 注意:此字段可能返回 null,表示取不到有效值。
616
+ * 自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
481
617
  */
482
- EncryptConn?: string
618
+ AutoRenewFlag?: number
483
619
  /**
484
- * 数据库所属网络环境,AccessType为云联网(ccn)时必填, UserIDC表示用户IDC、TencentVPC表示腾讯云VPC;
485
- 注意:此字段可能返回 null,表示取不到有效值。
620
+ * 数据订阅实例所属地域
486
621
  */
487
- DatabaseNetEnv?: string
622
+ Region?: string
488
623
  /**
489
- * 数据库为跨账号云联网下的实例时、表示云联网所属主账号
624
+ * 接入方式。枚举值:extranet(公网) vpncloud(vpn接入) dcg(专线接入) ccn(云联网) cdb(云数据库) cvm(云主机自建) intranet(自研上云) vpc(私有网络vpc)
490
625
  注意:此字段可能返回 null,表示取不到有效值。
491
626
  */
492
- CcnOwnerUin?: string
493
- }
494
-
495
- /**
496
- * StopMigrateJob返回参数结构体
497
- */
498
- export interface StopMigrateJobResponse {
499
- /**
500
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
501
- */
502
- RequestId?: string
503
- }
504
-
505
- /**
506
- * 表对象集合,当 TableMode 为 partial 时,此项需要填写
507
- */
508
- export interface TableItem {
627
+ AccessType?: string
509
628
  /**
510
- * 迁移的表名,大小写敏感
629
+ * 数据库节点信息
511
630
  注意:此字段可能返回 null,表示取不到有效值。
512
631
  */
513
- TableName?: string
632
+ Endpoints?: Array<EndpointItem>
514
633
  /**
515
- * 迁移后的表名,当TableEditMode为rename时此项必填,注意此配置与TmpTables互斥,只能使用其中一种
634
+ * 数据订阅版本, 当前只支持 kafka 版本。
516
635
  注意:此字段可能返回 null,表示取不到有效值。
517
636
  */
518
- NewTableName?: string
637
+ SubscribeVersion?: string
519
638
  /**
520
- * 迁移临时表,注意此配置与NewTableName互斥,只能使用其中一种。当配置的同步对象为表级别且TableEditMode为pt时此项有意义,针对pt-osc等工具在迁移过程中产生的临时表进行同步,需要提前将可能的临时表配置在这里,否则不会同步任何临时表。示例,如要对t1进行pt-osc操作,此项配置应该为["\_t1\_new","\_t1\_old"];如要对t1进行gh-ost操作,此项配置应该为["\_t1\_ghc","\_t1\_gho","\_t1\_del"],pt-osc与gh-ost产生的临时表可同时配置。
639
+ * 标签
521
640
  注意:此字段可能返回 null,表示取不到有效值。
522
641
  */
523
- TmpTables?: Array<string>
642
+ Tags?: Array<TagItem>
524
643
  /**
525
- * 编辑表类型,rename(表映射),pt(同步附加表)
644
+ * 任务报错信息,如果有的话。
526
645
  注意:此字段可能返回 null,表示取不到有效值。
527
646
  */
528
- TableEditMode?: string
647
+ Errors?: Array<SubsErr>
529
648
  }
530
649
 
531
650
  /**
@@ -637,13 +756,23 @@ export interface DescribeModifyCheckSyncJobResultResponse {
637
756
  }
638
757
 
639
758
  /**
640
- * StopSyncJob请求参数结构体
759
+ * StartSubscribe返回参数结构体
641
760
  */
642
- export interface StopSyncJobRequest {
761
+ export interface StartSubscribeResponse {
643
762
  /**
644
- * 同步任务id
763
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
645
764
  */
646
- JobId: string
765
+ RequestId?: string
766
+ }
767
+
768
+ /**
769
+ * DescribeSubscribeReturnable请求参数结构体
770
+ */
771
+ export interface DescribeSubscribeReturnableRequest {
772
+ /**
773
+ * 数据订阅实例的ID
774
+ */
775
+ SubscribeId: string
647
776
  }
648
777
 
649
778
  /**
@@ -657,13 +786,29 @@ export interface DescribeMigrationDetailRequest {
657
786
  }
658
787
 
659
788
  /**
660
- * DestroySyncJob请求参数结构体
789
+ * CreateConsumerGroup请求参数结构体
661
790
  */
662
- export interface DestroySyncJobRequest {
791
+ export interface CreateConsumerGroupRequest {
663
792
  /**
664
- * 同步任务id
793
+ * 订阅实例id
665
794
  */
666
- JobId: string
795
+ SubscribeId: string
796
+ /**
797
+ * 消费组名称,以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
798
+ */
799
+ ConsumerGroupName: string
800
+ /**
801
+ * 账号名称。以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的账户全称形如:account-#{SubscribeId}-#{AccountName}
802
+ */
803
+ AccountName: string
804
+ /**
805
+ * 消费组密码,长度必须大于3
806
+ */
807
+ Password: string
808
+ /**
809
+ * 消费组备注
810
+ */
811
+ Description?: string
667
812
  }
668
813
 
669
814
  /**
@@ -680,6 +825,16 @@ export interface ResizeSyncJobRequest {
680
825
  NewInstanceClass: string
681
826
  }
682
827
 
828
+ /**
829
+ * ModifySubscribeName返回参数结构体
830
+ */
831
+ export interface ModifySubscribeNameResponse {
832
+ /**
833
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
834
+ */
835
+ RequestId?: string
836
+ }
837
+
683
838
  /**
684
839
  * 数据同步中的ddl同步处理
685
840
  */
@@ -717,6 +872,22 @@ export interface ConflictHandleOption {
717
872
  ConditionOrderInSrcAndDst?: string
718
873
  }
719
874
 
875
+ /**
876
+ * mongo输出聚合设置。输出默认 Change Event
877
+ */
878
+ export interface PipelineInfo {
879
+ /**
880
+ * 聚合运算符:$addFields、$match、$project、$replaceRoot、$redact、$replaceWith、$set、$unset。其中 $replaceWith、$set、$unset 只有当订阅实例是4.2及以上版本可选。
881
+ 注意:此字段可能返回 null,表示取不到有效值。
882
+ */
883
+ AggOp?: string
884
+ /**
885
+ * 聚合表达式。必须是json格式
886
+ 注意:此字段可能返回 null,表示取不到有效值。
887
+ */
888
+ AggCmd?: string
889
+ }
890
+
720
891
  /**
721
892
  * ResumeSyncJob返回参数结构体
722
893
  */
@@ -727,6 +898,16 @@ export interface ResumeSyncJobResponse {
727
898
  RequestId?: string
728
899
  }
729
900
 
901
+ /**
902
+ * RecoverMigrateJob返回参数结构体
903
+ */
904
+ export interface RecoverMigrateJobResponse {
905
+ /**
906
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
907
+ */
908
+ RequestId?: string
909
+ }
910
+
730
911
  /**
731
912
  * ModifyCompareTaskName返回参数结构体
732
913
  */
@@ -747,6 +928,16 @@ export interface StartSyncJobRequest {
747
928
  JobId?: string
748
929
  }
749
930
 
931
+ /**
932
+ * StartSubscribe请求参数结构体
933
+ */
934
+ export interface StartSubscribeRequest {
935
+ /**
936
+ * 数据订阅实例的 ID
937
+ */
938
+ SubscribeId: string
939
+ }
940
+
750
941
  /**
751
942
  * ModifyMigrateRuntimeAttribute返回参数结构体
752
943
  */
@@ -757,6 +948,20 @@ export interface ModifyMigrateRuntimeAttributeResponse {
757
948
  RequestId?: string
758
949
  }
759
950
 
951
+ /**
952
+ * DescribeOffsetByTime返回参数结构体
953
+ */
954
+ export interface DescribeOffsetByTimeResponse {
955
+ /**
956
+ * 时间与Offset的对应
957
+ */
958
+ Items?: Array<OffsetTimeMap>
959
+ /**
960
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
961
+ */
962
+ RequestId?: string
963
+ }
964
+
760
965
  /**
761
966
  * PauseSyncJob请求参数结构体
762
967
  */
@@ -915,6 +1120,26 @@ export interface DescribeCompareTasksRequest {
915
1120
  Status?: Array<string>
916
1121
  }
917
1122
 
1123
+ /**
1124
+ * DestroyIsolatedSubscribe请求参数结构体
1125
+ */
1126
+ export interface DestroyIsolatedSubscribeRequest {
1127
+ /**
1128
+ * 数据订阅实例的ID
1129
+ */
1130
+ SubscribeId: string
1131
+ }
1132
+
1133
+ /**
1134
+ * ResetSubscribe返回参数结构体
1135
+ */
1136
+ export interface ResetSubscribeResponse {
1137
+ /**
1138
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1139
+ */
1140
+ RequestId?: string
1141
+ }
1142
+
918
1143
  /**
919
1144
  * 一致性对比对象配置
920
1145
  */
@@ -937,29 +1162,23 @@ export interface CompareObject {
937
1162
  }
938
1163
 
939
1164
  /**
940
- * 任务错误信息
1165
+ * DescribeCompareReport返回参数结构体
941
1166
  */
942
- export interface ErrorInfoItem {
943
- /**
944
- * 错误码
945
- 注意:此字段可能返回 null,表示取不到有效值。
946
- */
947
- Code?: string
1167
+ export interface DescribeCompareReportResponse {
948
1168
  /**
949
- * 解决方案
1169
+ * 一致性校验摘要信息
950
1170
  注意:此字段可能返回 null,表示取不到有效值。
951
1171
  */
952
- Solution?: string
1172
+ Abstract: CompareAbstractInfo
953
1173
  /**
954
- * 错误日志信息
1174
+ * 一致性校验详细信息
955
1175
  注意:此字段可能返回 null,表示取不到有效值。
956
1176
  */
957
- ErrorLog?: string
1177
+ Detail: CompareDetailInfo
958
1178
  /**
959
- * 文档提示
960
- 注意:此字段可能返回 null,表示取不到有效值。
1179
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
961
1180
  */
962
- HelpDoc?: string
1181
+ RequestId?: string
963
1182
  }
964
1183
 
965
1184
  /**
@@ -988,6 +1207,86 @@ export interface MigrateAction {
988
1207
  AllowedAction: Array<string>
989
1208
  }
990
1209
 
1210
+ /**
1211
+ * ConfigureSubscribeJob返回参数结构体
1212
+ */
1213
+ export interface ConfigureSubscribeJobResponse {
1214
+ /**
1215
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1216
+ */
1217
+ RequestId?: string
1218
+ }
1219
+
1220
+ /**
1221
+ * DescribeConsumerGroups请求参数结构体
1222
+ */
1223
+ export interface DescribeConsumerGroupsRequest {
1224
+ /**
1225
+ * 订阅实例id
1226
+ */
1227
+ SubscribeId: string
1228
+ /**
1229
+ * 返回记录的起始偏移量。默认0
1230
+ */
1231
+ Offset?: number
1232
+ /**
1233
+ * 单次返回的记录数量。默认10
1234
+ */
1235
+ Limit?: number
1236
+ }
1237
+
1238
+ /**
1239
+ * kafka消费者组详情
1240
+ */
1241
+ export interface GroupInfo {
1242
+ /**
1243
+ * 消费者组账号
1244
+ */
1245
+ Account: string
1246
+ /**
1247
+ * 消费者组名称
1248
+ */
1249
+ ConsumerGroupName: string
1250
+ /**
1251
+ * 消费者组备注
1252
+ 注意:此字段可能返回 null,表示取不到有效值。
1253
+ */
1254
+ Description: string
1255
+ /**
1256
+ * 消费组偏移量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区的偏移量。各分区的偏移量详见StateOfPartition字段
1257
+ */
1258
+ ConsumerGroupOffset: number
1259
+ /**
1260
+ * 消费组未消费的数据量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区未消费的数据量。各分区未消费数据量详见StateOfPartition字段
1261
+ */
1262
+ ConsumerGroupLag: number
1263
+ /**
1264
+ * 消费延迟(单位为秒)
1265
+ */
1266
+ Latency: number
1267
+ /**
1268
+ * 各分区的消费状态
1269
+ */
1270
+ StateOfPartition: Array<MonitorInfo>
1271
+ /**
1272
+ * 消费者组创建时间,格式为YYYY-MM-DD hh:mm:ss
1273
+ */
1274
+ CreatedAt: string
1275
+ /**
1276
+ * 消费者组修改时间,格式为YYYY-MM-DD hh:mm:ss
1277
+ */
1278
+ UpdatedAt: string
1279
+ /**
1280
+ * 消费者组状态,包括Dead、Empty、Stable等,只有Dead和Empty两种状态可以执行reset操作
1281
+ */
1282
+ ConsumerGroupState: string
1283
+ /**
1284
+ * 每个消费者正在消费的分区
1285
+ 注意:此字段可能返回 null,表示取不到有效值。
1286
+ */
1287
+ PartitionAssignment: Array<PartitionAssignment>
1288
+ }
1289
+
991
1290
  /**
992
1291
  * DeleteCompareTask返回参数结构体
993
1292
  */
@@ -1046,20 +1345,19 @@ export interface DBEndpointInfo {
1046
1345
  }
1047
1346
 
1048
1347
  /**
1049
- * 列选项
1348
+ * ResumeSubscribe请求参数结构体
1050
1349
  */
1051
- export interface CompareColumnItem {
1350
+ export interface ResumeSubscribeRequest {
1052
1351
  /**
1053
- * 列名
1054
- 注意:此字段可能返回 null,表示取不到有效值。
1352
+ * 数据订阅实例的 ID
1055
1353
  */
1056
- ColumnName?: string
1354
+ SubscribeId: string
1057
1355
  }
1058
1356
 
1059
1357
  /**
1060
- * ContinueSyncJob返回参数结构体
1358
+ * ModifySyncJobConfig返回参数结构体
1061
1359
  */
1062
- export interface ContinueSyncJobResponse {
1360
+ export interface ModifySyncJobConfigResponse {
1063
1361
  /**
1064
1362
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1065
1363
  */
@@ -1067,135 +1365,380 @@ export interface ContinueSyncJobResponse {
1067
1365
  }
1068
1366
 
1069
1367
  /**
1070
- * 数据同步中的选项
1368
+ * 列选项
1071
1369
  */
1072
- export interface Options {
1370
+ export interface CompareColumnItem {
1073
1371
  /**
1074
- * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
1372
+ * 列名
1075
1373
  注意:此字段可能返回 null,表示取不到有效值。
1076
1374
  */
1077
- InitType?: string
1375
+ ColumnName?: string
1376
+ }
1377
+
1378
+ /**
1379
+ * DescribeSubscribeDetail返回参数结构体
1380
+ */
1381
+ export interface DescribeSubscribeDetailResponse {
1078
1382
  /**
1079
- * 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、InitializeAfterDelete(删除并重新初始化)、ExecuteAfterIgnore(忽略并继续执行)
1080
- 注意:此字段可能返回 null,表示取不到有效值。
1383
+ * 数据订阅的ID,形如subs-b6x64o31tm
1081
1384
  */
1082
- DealOfExistSameTable?: string
1385
+ SubscribeId?: string
1083
1386
  /**
1084
- * 冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
1085
- 注意:此字段可能返回 null,表示取不到有效值。
1387
+ * 数据订阅实例的名称
1086
1388
  */
1087
- ConflictHandleType?: string
1389
+ SubscribeName?: string
1088
1390
  /**
1089
- * 是否添加附加列
1391
+ * 订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)
1392
+ */
1393
+ Product?: string
1394
+ /**
1395
+ * 订阅的云数据库实例ID,只有订阅云数据库该值才有意义
1090
1396
  注意:此字段可能返回 null,表示取不到有效值。
1091
1397
  */
1092
- AddAdditionalColumn?: boolean
1398
+ InstanceId?: string
1093
1399
  /**
1094
- * 所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), 不填(不选),PartialDDL(自定义,和DdlOptions一起起作用 )
1400
+ * 订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline
1095
1401
  注意:此字段可能返回 null,表示取不到有效值。
1096
1402
  */
1097
- OpTypes?: Array<string>
1403
+ InstanceStatus?: string
1098
1404
  /**
1099
- * 冲突处理的详细选项,如条件覆盖中的条件行和条件操作
1405
+ * 订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng
1406
+ */
1407
+ Status?: string
1408
+ /**
1409
+ * 订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error
1410
+ */
1411
+ SubsStatus?: string
1412
+ /**
1413
+ * 修改时间,时间格式如:Y-m-d h:m:s
1100
1414
  注意:此字段可能返回 null,表示取不到有效值。
1101
1415
  */
1102
- ConflictHandleOption?: ConflictHandleOption
1416
+ ModifyTime?: string
1103
1417
  /**
1104
- * DDL同步选项,具体描述要同步那些DDL
1418
+ * 创建时间,时间格式如:Y-m-d h:m:s
1105
1419
  注意:此字段可能返回 null,表示取不到有效值。
1106
1420
  */
1107
- DdlOptions?: Array<DdlOption>
1421
+ CreateTime?: string
1108
1422
  /**
1109
- * kafka同步选项
1423
+ * 隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1110
1424
  注意:此字段可能返回 null,表示取不到有效值。
1111
1425
  */
1112
- KafkaOption?: KafkaOption
1426
+ IsolateTime?: string
1113
1427
  /**
1114
- * 任务限速信息
1428
+ * 包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1115
1429
  注意:此字段可能返回 null,表示取不到有效值。
1116
1430
  */
1117
- RateLimitOption?: RateLimitOption
1431
+ ExpireTime?: string
1118
1432
  /**
1119
- * 自动重试的时间窗口设置
1433
+ * 下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1120
1434
  注意:此字段可能返回 null,表示取不到有效值。
1121
1435
  */
1122
- AutoRetryTimeRangeMinutes?: number
1123
- }
1124
-
1125
- /**
1126
- * CompleteMigrateJob请求参数结构体
1127
- */
1128
- export interface CompleteMigrateJobRequest {
1436
+ OfflineTime?: string
1129
1437
  /**
1130
- * 数据迁移任务ID
1438
+ * 付费方式,可能值为:0-包年包月,1-按量计费
1131
1439
  */
1132
- JobId: string
1440
+ PayType?: number
1133
1441
  /**
1134
- * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
1442
+ * 自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
1135
1443
  */
1136
- CompleteMode?: string
1137
- }
1138
-
1139
- /**
1140
- * DescribeCompareTasks返回参数结构体
1141
- */
1142
- export interface DescribeCompareTasksResponse {
1444
+ AutoRenewFlag?: number
1143
1445
  /**
1144
- * 数量
1446
+ * 任务所在地域
1447
+ */
1448
+ Region?: string
1449
+ /**
1450
+ * Kafka topic
1145
1451
  注意:此字段可能返回 null,表示取不到有效值。
1146
1452
  */
1147
- TotalCount?: number
1453
+ Topic?: string
1148
1454
  /**
1149
- * 一致性校验列表
1455
+ * Kafka服务Broker地址
1150
1456
  注意:此字段可能返回 null,表示取不到有效值。
1151
1457
  */
1152
- Items?: Array<CompareTaskItem>
1458
+ Broker?: string
1153
1459
  /**
1154
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1460
+ * 数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合
1461
+ 注意:此字段可能返回 null,表示取不到有效值。
1155
1462
  */
1156
- RequestId?: string
1157
- }
1158
-
1159
- /**
1160
- * StopCompare请求参数结构体
1161
- */
1162
- export interface StopCompareRequest {
1463
+ SubscribeMode?: string
1163
1464
  /**
1164
- * 迁移任务 Id
1465
+ * 订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档
1466
+ 注意:此字段可能返回 null,表示取不到有效值。
1165
1467
  */
1166
- JobId: string
1468
+ Protocol?: string
1167
1469
  /**
1168
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1470
+ * 订阅的数据库表信息
1471
+ 注意:此字段可能返回 null,表示取不到有效值。
1169
1472
  */
1170
- CompareTaskId: string
1171
- }
1172
-
1173
- /**
1174
- * 数据同步配置多节点数据库的节点信息。多节点数据库,如tdsqlmysql使用该结构;单节点数据库,如mysql使用Endpoint。
1175
- */
1176
- export interface SyncDBEndpointInfos {
1473
+ SubscribeObjects?: Array<SubscribeObject>
1177
1474
  /**
1178
- * 数据库所在地域
1475
+ * kafka配置信息
1179
1476
  注意:此字段可能返回 null,表示取不到有效值。
1180
1477
  */
1181
- Region: string
1478
+ KafkaConfig?: SubscribeKafkaConfig
1182
1479
  /**
1183
- * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1480
+ * 源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云主机自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
1184
1481
  注意:此字段可能返回 null,表示取不到有效值。
1185
1482
  */
1186
- AccessType: string
1483
+ AccessType?: string
1187
1484
  /**
1188
- * 实例数据库类型,如:mysql,redis,mongodb,postgresql,mariadb,percona 等
1485
+ * 接入类型信息
1189
1486
  注意:此字段可能返回 null,表示取不到有效值。
1190
1487
  */
1191
- DatabaseType: string
1488
+ Endpoints?: Array<EndpointItem>
1192
1489
  /**
1193
- * 数据库信息。注意:如果数据类型为tdsqlmysql,此处Endpoint数组的顺序应该与set顺序对应,第一个分片(shardkey范围起始为0的分片)必须要输入在第一个位置
1490
+ * mongo输出聚合设置
1194
1491
  注意:此字段可能返回 null,表示取不到有效值。
1195
1492
  */
1196
- Info: Array<Endpoint>
1197
- }
1198
-
1493
+ PipelineInfo?: Array<PipelineInfo>
1494
+ /**
1495
+ * 标签
1496
+ 注意:此字段可能返回 null,表示取不到有效值。
1497
+ */
1498
+ Tags?: Array<TagItem>
1499
+ /**
1500
+ * 订阅任务报错信息
1501
+ 注意:此字段可能返回 null,表示取不到有效值。
1502
+ */
1503
+ Errors?: Array<SubsErr>
1504
+ /**
1505
+ * 为业务添加的额外信息。参数名作key,参数值作value。
1506
+ mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。
1507
+ mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。
1508
+ 注意:此字段可能返回 null,表示取不到有效值。
1509
+ */
1510
+ ExtraAttr?: Array<KeyValuePairOption>
1511
+ /**
1512
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1513
+ */
1514
+ RequestId?: string
1515
+ }
1516
+
1517
+ /**
1518
+ * ContinueSyncJob返回参数结构体
1519
+ */
1520
+ export interface ContinueSyncJobResponse {
1521
+ /**
1522
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1523
+ */
1524
+ RequestId?: string
1525
+ }
1526
+
1527
+ /**
1528
+ * 计费状态信息
1529
+ */
1530
+ export interface TradeInfo {
1531
+ /**
1532
+ * 交易订单号
1533
+ 注意:此字段可能返回 null,表示取不到有效值。
1534
+ */
1535
+ DealName?: string
1536
+ /**
1537
+ * 上一次交易订单号
1538
+ 注意:此字段可能返回 null,表示取不到有效值。
1539
+ */
1540
+ LastDealName?: string
1541
+ /**
1542
+ * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
1543
+ 注意:此字段可能返回 null,表示取不到有效值。
1544
+ */
1545
+ InstanceClass?: string
1546
+ /**
1547
+ * 计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
1548
+ 注意:此字段可能返回 null,表示取不到有效值。
1549
+ */
1550
+ TradeStatus?: string
1551
+ /**
1552
+ * 到期时间,格式为"yyyy-mm-dd hh:mm:ss"
1553
+ 注意:此字段可能返回 null,表示取不到有效值。
1554
+ */
1555
+ ExpireTime?: string
1556
+ /**
1557
+ * 下线时间,格式为"yyyy-mm-dd hh:mm:ss"
1558
+ 注意:此字段可能返回 null,表示取不到有效值。
1559
+ */
1560
+ OfflineTime?: string
1561
+ /**
1562
+ * 隔离时间,格式为"yyyy-mm-dd hh:mm:ss"
1563
+ 注意:此字段可能返回 null,表示取不到有效值。
1564
+ */
1565
+ IsolateTime?: string
1566
+ /**
1567
+ * 下线原因
1568
+ 注意:此字段可能返回 null,表示取不到有效值。
1569
+ */
1570
+ OfflineReason?: string
1571
+ /**
1572
+ * 隔离原因
1573
+ 注意:此字段可能返回 null,表示取不到有效值。
1574
+ */
1575
+ IsolateReason?: string
1576
+ /**
1577
+ * 付费类型,包括:postpay(后付费)、prepay(预付费)
1578
+ 注意:此字段可能返回 null,表示取不到有效值。
1579
+ */
1580
+ PayType?: string
1581
+ /**
1582
+ * 任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
1583
+ 注意:此字段可能返回 null,表示取不到有效值。
1584
+ */
1585
+ BillingType?: string
1586
+ }
1587
+
1588
+ /**
1589
+ * 数据同步中的选项
1590
+ */
1591
+ export interface Options {
1592
+ /**
1593
+ * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
1594
+ 注意:此字段可能返回 null,表示取不到有效值。
1595
+ */
1596
+ InitType?: string
1597
+ /**
1598
+ * 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、InitializeAfterDelete(删除并重新初始化)、ExecuteAfterIgnore(忽略并继续执行)
1599
+ 注意:此字段可能返回 null,表示取不到有效值。
1600
+ */
1601
+ DealOfExistSameTable?: string
1602
+ /**
1603
+ * 冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
1604
+ 注意:此字段可能返回 null,表示取不到有效值。
1605
+ */
1606
+ ConflictHandleType?: string
1607
+ /**
1608
+ * 是否添加附加列
1609
+ 注意:此字段可能返回 null,表示取不到有效值。
1610
+ */
1611
+ AddAdditionalColumn?: boolean
1612
+ /**
1613
+ * 所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), 不填(不选),PartialDDL(自定义,和DdlOptions一起起作用 )
1614
+ 注意:此字段可能返回 null,表示取不到有效值。
1615
+ */
1616
+ OpTypes?: Array<string>
1617
+ /**
1618
+ * 冲突处理的详细选项,如条件覆盖中的条件行和条件操作
1619
+ 注意:此字段可能返回 null,表示取不到有效值。
1620
+ */
1621
+ ConflictHandleOption?: ConflictHandleOption
1622
+ /**
1623
+ * DDL同步选项,具体描述要同步那些DDL
1624
+ 注意:此字段可能返回 null,表示取不到有效值。
1625
+ */
1626
+ DdlOptions?: Array<DdlOption>
1627
+ /**
1628
+ * kafka同步选项
1629
+ 注意:此字段可能返回 null,表示取不到有效值。
1630
+ */
1631
+ KafkaOption?: KafkaOption
1632
+ /**
1633
+ * 任务限速信息
1634
+ 注意:此字段可能返回 null,表示取不到有效值。
1635
+ */
1636
+ RateLimitOption?: RateLimitOption
1637
+ /**
1638
+ * 自动重试的时间窗口设置
1639
+ 注意:此字段可能返回 null,表示取不到有效值。
1640
+ */
1641
+ AutoRetryTimeRangeMinutes?: number
1642
+ }
1643
+
1644
+ /**
1645
+ * DeleteConsumerGroup请求参数结构体
1646
+ */
1647
+ export interface DeleteConsumerGroupRequest {
1648
+ /**
1649
+ * 数据订阅实例的 ID
1650
+ */
1651
+ SubscribeId: string
1652
+ /**
1653
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
1654
+ 请务必保证消费组名称正确。
1655
+ */
1656
+ ConsumerGroupName: string
1657
+ /**
1658
+ * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
1659
+ 请务必保证账户名称正确。
1660
+ */
1661
+ AccountName: string
1662
+ }
1663
+
1664
+ /**
1665
+ * ModifySubscribeAutoRenewFlag请求参数结构体
1666
+ */
1667
+ export interface ModifySubscribeAutoRenewFlagRequest {
1668
+ /**
1669
+ * 订阅实例ID
1670
+ */
1671
+ SubscribeId: string
1672
+ /**
1673
+ * 自动续费标识。1-自动续费,0-不自动续费
1674
+ */
1675
+ AutoRenewFlag: number
1676
+ }
1677
+
1678
+ /**
1679
+ * CompleteMigrateJob请求参数结构体
1680
+ */
1681
+ export interface CompleteMigrateJobRequest {
1682
+ /**
1683
+ * 数据迁移任务ID
1684
+ */
1685
+ JobId: string
1686
+ /**
1687
+ * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
1688
+ */
1689
+ CompleteMode?: string
1690
+ }
1691
+
1692
+ /**
1693
+ * CreateConsumerGroup返回参数结构体
1694
+ */
1695
+ export interface CreateConsumerGroupResponse {
1696
+ /**
1697
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1698
+ */
1699
+ RequestId?: string
1700
+ }
1701
+
1702
+ /**
1703
+ * StopCompare请求参数结构体
1704
+ */
1705
+ export interface StopCompareRequest {
1706
+ /**
1707
+ * 迁移任务 Id
1708
+ */
1709
+ JobId: string
1710
+ /**
1711
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1712
+ */
1713
+ CompareTaskId: string
1714
+ }
1715
+
1716
+ /**
1717
+ * 数据同步配置多节点数据库的节点信息。多节点数据库,如tdsqlmysql使用该结构;单节点数据库,如mysql使用Endpoint。
1718
+ */
1719
+ export interface SyncDBEndpointInfos {
1720
+ /**
1721
+ * 数据库所在地域
1722
+ 注意:此字段可能返回 null,表示取不到有效值。
1723
+ */
1724
+ Region: string
1725
+ /**
1726
+ * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1727
+ 注意:此字段可能返回 null,表示取不到有效值。
1728
+ */
1729
+ AccessType: string
1730
+ /**
1731
+ * 实例数据库类型,如:mysql,redis,mongodb,postgresql,mariadb,percona 等
1732
+ 注意:此字段可能返回 null,表示取不到有效值。
1733
+ */
1734
+ DatabaseType: string
1735
+ /**
1736
+ * 数据库信息。注意:如果数据类型为tdsqlmysql,此处Endpoint数组的顺序应该与set顺序对应,第一个分片(shardkey范围起始为0的分片)必须要输入在第一个位置
1737
+ 注意:此字段可能返回 null,表示取不到有效值。
1738
+ */
1739
+ Info: Array<Endpoint>
1740
+ }
1741
+
1199
1742
  /**
1200
1743
  * StartModifySyncJob请求参数结构体
1201
1744
  */
@@ -1251,22 +1794,6 @@ export interface StopSyncJobResponse {
1251
1794
  RequestId?: string
1252
1795
  }
1253
1796
 
1254
- /**
1255
- * 跳过校验的表详情
1256
- */
1257
- export interface SkippedDetail {
1258
- /**
1259
- * 跳过的表数量
1260
- 注意:此字段可能返回 null,表示取不到有效值。
1261
- */
1262
- TotalCount: number
1263
- /**
1264
- * 跳过校验的表详情
1265
- 注意:此字段可能返回 null,表示取不到有效值。
1266
- */
1267
- Items: Array<SkippedItem>
1268
- }
1269
-
1270
1797
  /**
1271
1798
  * 迁移选项,描述任务如何执行迁移等一系列配置信息
1272
1799
  */
@@ -1309,6 +1836,78 @@ export interface MigrateOption {
1309
1836
  ExtraAttr?: Array<KeyValuePairOption>
1310
1837
  }
1311
1838
 
1839
+ /**
1840
+ * DescribeSubscribeDetail请求参数结构体
1841
+ */
1842
+ export interface DescribeSubscribeDetailRequest {
1843
+ /**
1844
+ * 订阅实例ID
1845
+ */
1846
+ SubscribeId: string
1847
+ }
1848
+
1849
+ /**
1850
+ * 跳过校验的表详情
1851
+ */
1852
+ export interface SkippedDetail {
1853
+ /**
1854
+ * 跳过的表数量
1855
+ 注意:此字段可能返回 null,表示取不到有效值。
1856
+ */
1857
+ TotalCount: number
1858
+ /**
1859
+ * 跳过校验的表详情
1860
+ 注意:此字段可能返回 null,表示取不到有效值。
1861
+ */
1862
+ Items: Array<SkippedItem>
1863
+ }
1864
+
1865
+ /**
1866
+ * 订阅报错信息
1867
+ */
1868
+ export interface SubsErr {
1869
+ /**
1870
+ * 报错信息
1871
+ */
1872
+ Message?: string
1873
+ }
1874
+
1875
+ /**
1876
+ * CreateSubscribe返回参数结构体
1877
+ */
1878
+ export interface CreateSubscribeResponse {
1879
+ /**
1880
+ * 数据订阅实例的ID数组
1881
+ 注意:此字段可能返回 null,表示取不到有效值。
1882
+ */
1883
+ SubscribeIds?: Array<string>
1884
+ /**
1885
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1886
+ */
1887
+ RequestId?: string
1888
+ }
1889
+
1890
+ /**
1891
+ * 一致性校验选项
1892
+ */
1893
+ export interface CompareOptions {
1894
+ /**
1895
+ * 对比方式:dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比)
1896
+ 注意:此字段可能返回 null,表示取不到有效值。
1897
+ */
1898
+ Method?: string
1899
+ /**
1900
+ * 抽样比例;范围0,100
1901
+ 注意:此字段可能返回 null,表示取不到有效值。
1902
+ */
1903
+ SampleRate?: number
1904
+ /**
1905
+ * 线程数,取值1-5,默认为1
1906
+ 注意:此字段可能返回 null,表示取不到有效值。
1907
+ */
1908
+ ThreadCount?: number
1909
+ }
1910
+
1312
1911
  /**
1313
1912
  * ModifyMigrateName返回参数结构体
1314
1913
  */
@@ -1491,6 +2090,16 @@ export interface CreateMigrateCheckJobRequest {
1491
2090
  JobId: string
1492
2091
  }
1493
2092
 
2093
+ /**
2094
+ * ModifyConsumerGroupPassword返回参数结构体
2095
+ */
2096
+ export interface ModifyConsumerGroupPasswordResponse {
2097
+ /**
2098
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2099
+ */
2100
+ RequestId?: string
2101
+ }
2102
+
1494
2103
  /**
1495
2104
  * DescribeMigrationJobs请求参数结构体
1496
2105
  */
@@ -1577,6 +2186,30 @@ export interface CompareTaskInfo {
1577
2186
  Status: string
1578
2187
  }
1579
2188
 
2189
+ /**
2190
+ * ModifyConsumerGroupDescription请求参数结构体
2191
+ */
2192
+ export interface ModifyConsumerGroupDescriptionRequest {
2193
+ /**
2194
+ * 数据订阅实例的 ID
2195
+ */
2196
+ SubscribeId: string
2197
+ /**
2198
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
2199
+ 请务必保证消费组名称正确。
2200
+ */
2201
+ ConsumerGroupName: string
2202
+ /**
2203
+ * 账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
2204
+ 请务必保证账户名称正确。
2205
+ */
2206
+ AccountName: string
2207
+ /**
2208
+ * 修改之后的消费组描述
2209
+ */
2210
+ Description: string
2211
+ }
2212
+
1580
2213
  /**
1581
2214
  * ContinueSyncJob请求参数结构体
1582
2215
  */
@@ -1587,6 +2220,16 @@ export interface ContinueSyncJobRequest {
1587
2220
  JobId: string
1588
2221
  }
1589
2222
 
2223
+ /**
2224
+ * ModifySubscribeObjects返回参数结构体
2225
+ */
2226
+ export interface ModifySubscribeObjectsResponse {
2227
+ /**
2228
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2229
+ */
2230
+ RequestId?: string
2231
+ }
2232
+
1590
2233
  /**
1591
2234
  * CreateMigrationService返回参数结构体
1592
2235
  */
@@ -1653,6 +2296,32 @@ export interface DescribeMigrationCheckJobResponse {
1653
2296
  RequestId?: string
1654
2297
  }
1655
2298
 
2299
+ /**
2300
+ * StopSyncJob请求参数结构体
2301
+ */
2302
+ export interface StopSyncJobRequest {
2303
+ /**
2304
+ * 同步任务id
2305
+ */
2306
+ JobId: string
2307
+ }
2308
+
2309
+ /**
2310
+ * 数据不一致的表详情
2311
+ */
2312
+ export interface DifferenceDetail {
2313
+ /**
2314
+ * 数据不一致的表数量
2315
+ 注意:此字段可能返回 null,表示取不到有效值。
2316
+ */
2317
+ TotalCount: number
2318
+ /**
2319
+ * 校验不一致的表详情
2320
+ 注意:此字段可能返回 null,表示取不到有效值。
2321
+ */
2322
+ Items: Array<DifferenceItem>
2323
+ }
2324
+
1656
2325
  /**
1657
2326
  * 数据库信息
1658
2327
  */
@@ -1784,31 +2453,61 @@ export interface TopicRule {
1784
2453
  */
1785
2454
  TableMatchMode?: string
1786
2455
  /**
1787
- * 表名,仅“自定义topic”时,TableMatchMode=Regular生效
2456
+ * 表名,仅“自定义topic”时,TableMatchMode=Regular生效
2457
+ */
2458
+ TableName?: string
2459
+ }
2460
+
2461
+ /**
2462
+ * DestroySyncJob请求参数结构体
2463
+ */
2464
+ export interface DestroySyncJobRequest {
2465
+ /**
2466
+ * 同步任务id
2467
+ */
2468
+ JobId: string
2469
+ }
2470
+
2471
+ /**
2472
+ * 视图对象
2473
+ */
2474
+ export interface ViewItem {
2475
+ /**
2476
+ * 视图名称
2477
+ 注意:此字段可能返回 null,表示取不到有效值。
2478
+ */
2479
+ ViewName?: string
2480
+ /**
2481
+ * 迁移后的视图名称
2482
+ 注意:此字段可能返回 null,表示取不到有效值。
1788
2483
  */
1789
- TableName?: string
2484
+ NewViewName?: string
1790
2485
  }
1791
2486
 
1792
2487
  /**
1793
- * 数据不一致的表详情
2488
+ * CreateCheckSyncJob返回参数结构体
1794
2489
  */
1795
- export interface DifferenceDetail {
2490
+ export interface CreateCheckSyncJobResponse {
1796
2491
  /**
1797
- * 数据不一致的表数量
1798
- 注意:此字段可能返回 null,表示取不到有效值。
2492
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1799
2493
  */
1800
- TotalCount: number
2494
+ RequestId?: string
2495
+ }
2496
+
2497
+ /**
2498
+ * CreateSubscribeCheckJob返回参数结构体
2499
+ */
2500
+ export interface CreateSubscribeCheckJobResponse {
1801
2501
  /**
1802
- * 校验不一致的表详情
1803
- 注意:此字段可能返回 null,表示取不到有效值。
2502
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1804
2503
  */
1805
- Items: Array<DifferenceItem>
2504
+ RequestId?: string
1806
2505
  }
1807
2506
 
1808
2507
  /**
1809
- * CreateCheckSyncJob返回参数结构体
2508
+ * ModifyConsumerGroupDescription返回参数结构体
1810
2509
  */
1811
- export interface CreateCheckSyncJobResponse {
2510
+ export interface ModifyConsumerGroupDescriptionResponse {
1812
2511
  /**
1813
2512
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1814
2513
  */
@@ -1936,6 +2635,47 @@ export interface StartModifySyncJobResponse {
1936
2635
  RequestId?: string
1937
2636
  }
1938
2637
 
2638
+ /**
2639
+ * 订阅校验任务的各步骤信息。
2640
+ */
2641
+ export interface SubscribeCheckStepInfo {
2642
+ /**
2643
+ * 步骤名称
2644
+ 注意:此字段可能返回 null,表示取不到有效值。
2645
+ */
2646
+ StepName?: string
2647
+ /**
2648
+ * 步骤Id
2649
+ 注意:此字段可能返回 null,表示取不到有效值。
2650
+ */
2651
+ StepId?: string
2652
+ /**
2653
+ * 步骤编号,从 1 开始
2654
+ 注意:此字段可能返回 null,表示取不到有效值。
2655
+ */
2656
+ StepNo?: number
2657
+ /**
2658
+ * 当前步骤状态,可能值为 notStarted,running,finished,failed
2659
+ 注意:此字段可能返回 null,表示取不到有效值。
2660
+ */
2661
+ Status?: string
2662
+ /**
2663
+ * 当前步骤进度
2664
+ 注意:此字段可能返回 null,表示取不到有效值。
2665
+ */
2666
+ Percent?: number
2667
+ /**
2668
+ * 错误提示
2669
+ 注意:此字段可能返回 null,表示取不到有效值。
2670
+ */
2671
+ Errors?: Array<SubscribeCheckStepTip>
2672
+ /**
2673
+ * 告警提示
2674
+ 注意:此字段可能返回 null,表示取不到有效值。
2675
+ */
2676
+ Warnings?: Array<SubscribeCheckStepTip>
2677
+ }
2678
+
1939
2679
  /**
1940
2680
  * 查询迁移实例列表的实例对象
1941
2681
  */
@@ -2304,6 +3044,68 @@ manualPaused(已暂停)
2304
3044
  DumperResumeCtrl?: string
2305
3045
  }
2306
3046
 
3047
+ /**
3048
+ * DestroyIsolatedSubscribe返回参数结构体
3049
+ */
3050
+ export interface DestroyIsolatedSubscribeResponse {
3051
+ /**
3052
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3053
+ */
3054
+ RequestId?: string
3055
+ }
3056
+
3057
+ /**
3058
+ * 数据数据订阅的对象,用于修改订阅对象接口。与SubscribeObject结构类似,只是类型和参数名不同。
3059
+ */
3060
+ export interface ModifiedSubscribeObject {
3061
+ /**
3062
+ * 订阅对象的类型,枚举值为:0-库,1-表(该值对于mongo任务来说,是集合) 。
3063
+ 注意:mongo只支持全实例、单库或者单集合订阅,因此该字段不要与SubscribeObjectType冲突。如:SubscribeObjectType=4,表示mongo单库订阅,那么该字段应该传0。
3064
+ 注意:此字段可能返回 null,表示取不到有效值。
3065
+ */
3066
+ ObjectsType: number
3067
+ /**
3068
+ * 订阅数据库的名称
3069
+ 注意:此字段可能返回 null,表示取不到有效值。
3070
+ */
3071
+ DatabaseName: string
3072
+ /**
3073
+ * 订阅数据库中表(或集合)的名称。如果 ObjectsType 为 1,那么此字段为必填,且不为空;
3074
+ 注意:此字段可能返回 null,表示取不到有效值。
3075
+ */
3076
+ TableNames?: Array<string>
3077
+ }
3078
+
3079
+ /**
3080
+ * DescribeCompareTasks返回参数结构体
3081
+ */
3082
+ export interface DescribeCompareTasksResponse {
3083
+ /**
3084
+ * 数量
3085
+ 注意:此字段可能返回 null,表示取不到有效值。
3086
+ */
3087
+ TotalCount?: number
3088
+ /**
3089
+ * 一致性校验列表
3090
+ 注意:此字段可能返回 null,表示取不到有效值。
3091
+ */
3092
+ Items?: Array<CompareTaskItem>
3093
+ /**
3094
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3095
+ */
3096
+ RequestId?: string
3097
+ }
3098
+
3099
+ /**
3100
+ * ResumeSubscribe返回参数结构体
3101
+ */
3102
+ export interface ResumeSubscribeResponse {
3103
+ /**
3104
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3105
+ */
3106
+ RequestId?: string
3107
+ }
3108
+
2307
3109
  /**
2308
3110
  * DescribeSyncJobs请求参数结构体
2309
3111
  */
@@ -2411,13 +3213,21 @@ export interface SyncDetailInfo {
2411
3213
  }
2412
3214
 
2413
3215
  /**
2414
- * ResumeSyncJob请求参数结构体
3216
+ * DescribeConsumerGroups返回参数结构体
2415
3217
  */
2416
- export interface ResumeSyncJobRequest {
3218
+ export interface DescribeConsumerGroupsResponse {
2417
3219
  /**
2418
- * 同步任务id
3220
+ * 指定实例下的消费者组总数
2419
3221
  */
2420
- JobId: string
3222
+ TotalCount?: number
3223
+ /**
3224
+ * 消费者组列表
3225
+ */
3226
+ Items?: Array<GroupInfo>
3227
+ /**
3228
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3229
+ */
3230
+ RequestId?: string
2421
3231
  }
2422
3232
 
2423
3233
  /**
@@ -2538,6 +3348,27 @@ export interface StepInfo {
2538
3348
  Progress?: number
2539
3349
  }
2540
3350
 
3351
+ /**
3352
+ * 订阅的的数据库表信息,用于配置和查询订阅任务接口。
3353
+ */
3354
+ export interface SubscribeObject {
3355
+ /**
3356
+ * 订阅数据的类型,枚举值:database-数据库,table-数据库的表(如果 DatabaseType 为 mongodb,则表示集合)
3357
+ 注意:此字段可能返回 null,表示取不到有效值。
3358
+ */
3359
+ ObjectType: string
3360
+ /**
3361
+ * 订阅的数据库名称
3362
+ 注意:此字段可能返回 null,表示取不到有效值。
3363
+ */
3364
+ Database: string
3365
+ /**
3366
+ * 订阅数据库中表的名称。如果 DatabaseType 为 mongodb,填集合名。mongodb只支持订阅单库或者单集合。
3367
+ 注意:此字段可能返回 null,表示取不到有效值。
3368
+ */
3369
+ Tables?: Array<string>
3370
+ }
3371
+
2541
3372
  /**
2542
3373
  * ResumeMigrateJob请求参数结构体
2543
3374
  */
@@ -2563,64 +3394,97 @@ export interface PauseSyncJobResponse {
2563
3394
  }
2564
3395
 
2565
3396
  /**
2566
- * 计费状态信息
3397
+ * DescribeSubscribeCheckJob请求参数结构体
2567
3398
  */
2568
- export interface TradeInfo {
3399
+ export interface DescribeSubscribeCheckJobRequest {
2569
3400
  /**
2570
- * 交易订单号
2571
- 注意:此字段可能返回 null,表示取不到有效值。
3401
+ * 数据订阅实例的 ID
2572
3402
  */
2573
- DealName?: string
3403
+ SubscribeId: string
3404
+ }
3405
+
3406
+ /**
3407
+ * ModifySubscribeObjects请求参数结构体
3408
+ */
3409
+ export interface ModifySubscribeObjectsRequest {
2574
3410
  /**
2575
- * 上一次交易订单号
2576
- 注意:此字段可能返回 null,表示取不到有效值。
3411
+ * 数据订阅实例的ID
2577
3412
  */
2578
- LastDealName?: string
3413
+ SubscribeId: string
2579
3414
  /**
2580
- * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
2581
- 注意:此字段可能返回 null,表示取不到有效值。
3415
+ * 数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合
2582
3416
  */
2583
- InstanceClass?: string
3417
+ SubscribeObjectType: number
2584
3418
  /**
2585
- * 计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
2586
- 注意:此字段可能返回 null,表示取不到有效值。
3419
+ * 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
2587
3420
  */
2588
- TradeStatus?: string
3421
+ Objects?: Array<ModifiedSubscribeObject>
2589
3422
  /**
2590
- * 到期时间,格式为"yyyy-mm-dd hh:mm:ss"
2591
- 注意:此字段可能返回 null,表示取不到有效值。
3423
+ * kafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。
2592
3424
  */
2593
- ExpireTime?: string
3425
+ DistributeRules?: Array<DistributeRule>
2594
3426
  /**
2595
- * 下线时间,格式为"yyyy-mm-dd hh:mm:ss"
2596
- 注意:此字段可能返回 null,表示取不到有效值。
3427
+ * 默认分区策略。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
3428
+ 非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。
3429
+ 该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。
2597
3430
  */
2598
- OfflineTime?: string
3431
+ DefaultRuleType?: string
2599
3432
  /**
2600
- * 隔离时间,格式为"yyyy-mm-dd hh:mm:ss"
2601
- 注意:此字段可能返回 null,表示取不到有效值。
3433
+ * mongo输出聚合设置,mongo任务可选。如果不填,默认不修改。
2602
3434
  */
2603
- IsolateTime?: string
3435
+ PipelineInfo?: Array<PipelineInfo>
3436
+ }
3437
+
3438
+ /**
3439
+ * 数据同步view的描述
3440
+ */
3441
+ export interface View {
2604
3442
  /**
2605
- * 下线原因
3443
+ * view名
2606
3444
  注意:此字段可能返回 null,表示取不到有效值。
2607
3445
  */
2608
- OfflineReason?: string
3446
+ ViewName?: string
2609
3447
  /**
2610
- * 隔离原因
3448
+ * 预留字段、目前暂时不支持view的重命名
2611
3449
  注意:此字段可能返回 null,表示取不到有效值。
2612
3450
  */
2613
- IsolateReason?: string
3451
+ NewViewName?: string
3452
+ }
3453
+
3454
+ /**
3455
+ * kafka消费者组的分区详情
3456
+ */
3457
+ export interface MonitorInfo {
2614
3458
  /**
2615
- * 付费类型,包括:postpay(后付费)、prepay(预付费)
2616
- 注意:此字段可能返回 null,表示取不到有效值。
3459
+ * 当前分区的编号,从0开始
2617
3460
  */
2618
- PayType?: string
3461
+ PartitionNo: number
2619
3462
  /**
2620
- * 任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
2621
- 注意:此字段可能返回 null,表示取不到有效值。
3463
+ * 当前分区的偏移量
2622
3464
  */
2623
- BillingType?: string
3465
+ ConsumerGroupOffset: number
3466
+ /**
3467
+ * 当前分区未消费的数据量
3468
+ */
3469
+ ConsumerGroupLag: number
3470
+ /**
3471
+ * 当前分区的消费延迟(单位为秒)
3472
+ */
3473
+ Latency: number
3474
+ }
3475
+
3476
+ /**
3477
+ * DescribeOffsetByTime请求参数结构体
3478
+ */
3479
+ export interface DescribeOffsetByTimeRequest {
3480
+ /**
3481
+ * 数据订阅实例的 ID
3482
+ */
3483
+ SubscribeId: string
3484
+ /**
3485
+ * 时间点,格式为:Y-m-d h:m:s。如果输入时间比当前时间晚的多,相当于查询最新offset;如果输入时间比当前时间早的多,相当于查询最老offset;如果输入空,默认0时间,等价于查询最老offset。
3486
+ */
3487
+ Time: string
2624
3488
  }
2625
3489
 
2626
3490
  /**
@@ -3021,13 +3885,99 @@ export interface ErrInfo {
3021
3885
  */
3022
3886
  export interface StartCompareRequest {
3023
3887
  /**
3024
- * 迁移任务 Id
3888
+ * 迁移任务 Id
3889
+ */
3890
+ JobId: string
3891
+ /**
3892
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
3893
+ */
3894
+ CompareTaskId: string
3895
+ }
3896
+
3897
+ /**
3898
+ * 数据订阅的实例节点信息
3899
+ */
3900
+ export interface EndpointItem {
3901
+ /**
3902
+ * 源库所在地域。如果 AccessType 为 ccn,请填vpc所在地域,因为此时不知道源库在哪个地域。其他接入方式,请填订阅任务所在地域,因为确保订阅任务与源库在同一地域是最优的网络方案。
3903
+ 注意:此字段可能返回 null,表示取不到有效值。
3904
+ */
3905
+ DatabaseRegion: string
3906
+ /**
3907
+ * 用户名
3908
+ 注意:此字段可能返回 null,表示取不到有效值。
3909
+ */
3910
+ User: string
3911
+ /**
3912
+ * 密码。作为入参时必填,作为出参时为空。
3913
+ 注意:此字段可能返回 null,表示取不到有效值。
3914
+ */
3915
+ Password: string
3916
+ /**
3917
+ * 目标实例ID。如果 AccessType 为 cdb,此项必填。配置InstanceId时会查询并校验实例信息。mysql的查询接口经过了鉴权,请确保子用户有 cdb:DescribeDBInstances 的接口权限。
3918
+ 注意:此字段可能返回 null,表示取不到有效值。
3919
+ */
3920
+ InstanceId?: string
3921
+ /**
3922
+ * 云主机ID。如果 AccessType 为 cvm,此项必填。
3923
+ 注意:此字段可能返回 null,表示取不到有效值。
3924
+ */
3925
+ CvmInstanceId?: string
3926
+ /**
3927
+ * 专线网关ID。如果 AccessType 为 dcg,此项必填。
3928
+ 注意:此字段可能返回 null,表示取不到有效值。
3929
+ */
3930
+ UniqDcgId?: string
3931
+ /**
3932
+ * 云联网ID。如果 AccessType 为 ccn,此项必填。
3933
+ 注意:此字段可能返回 null,表示取不到有效值。
3934
+ */
3935
+ CcnId?: string
3936
+ /**
3937
+ * vpn网关ID。如果 AccessType 为 vpncloud,此项必填。
3938
+ 注意:此字段可能返回 null,表示取不到有效值。
3939
+ */
3940
+ UniqVpnGwId?: string
3941
+ /**
3942
+ * VpcID。如果 AccessType 为 dcg\ccn\vpncloud\vpc,此项必填。
3943
+ 注意:此字段可能返回 null,表示取不到有效值。
3944
+ */
3945
+ VpcId?: string
3946
+ /**
3947
+ * 子网ID。如果 AccessType 为 dcg\ccn\vpncloud\vpc,此项必填。
3948
+ 注意:此字段可能返回 null,表示取不到有效值。
3949
+ */
3950
+ SubnetId?: string
3951
+ /**
3952
+ * 数据库地址,支持域名与IP。如果 AccessType 为 dcg\ccn\vpncloud\vpc\extranet\intranet,此项必填。
3953
+ 注意:此字段可能返回 null,表示取不到有效值。
3954
+ */
3955
+ HostName?: string
3956
+ /**
3957
+ * 数据库端口。如果 AccessType 为 dcg\ccn\vpncloud\vpc\extranet\intranet\cvm,此项必填。
3958
+ 注意:此字段可能返回 null,表示取不到有效值。
3959
+ */
3960
+ Port?: number
3961
+ /**
3962
+ * 是否走加密传输,枚举值:UnEncrypted-不加密,Encrypted-加密。只有mysql支持,不填默认不加密,其他产品不填。
3963
+ 注意:此字段可能返回 null,表示取不到有效值。
3964
+ */
3965
+ EncryptConn?: string
3966
+ /**
3967
+ * 数据库网络环境。如果 AccessType 为 ccn 此项必填。枚举值:UserIDC-自建idc,TencentVPC-腾讯云,Aws-aws,AliYun-阿里云,Others-其他。
3968
+ 注意:此字段可能返回 null,表示取不到有效值。
3969
+ */
3970
+ DatabaseNetEnv?: string
3971
+ /**
3972
+ * 云联网网关所属的主账号uin、跨账号云联网需要。
3973
+ 注意:此字段可能返回 null,表示取不到有效值。
3025
3974
  */
3026
- JobId: string
3975
+ CcnOwnerUin?: string
3027
3976
  /**
3028
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
3977
+ * 为业务添加的额外信息。参数名作key,参数值作value。 tdpg必填参数:PgDatabase-订阅的库名。
3978
+ 注意:此字段可能返回 null,表示取不到有效值。
3029
3979
  */
3030
- CompareTaskId: string
3980
+ ExtraAttr?: Array<KeyValuePairOption>
3031
3981
  }
3032
3982
 
3033
3983
  /**
@@ -3185,6 +4135,40 @@ export interface ModifyMigrateNameRequest {
3185
4135
  JobName: string
3186
4136
  }
3187
4137
 
4138
+ /**
4139
+ * CreateSubscribe请求参数结构体
4140
+ */
4141
+ export interface CreateSubscribeRequest {
4142
+ /**
4143
+ * 订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)
4144
+ */
4145
+ Product: string
4146
+ /**
4147
+ * 付费方式,枚举值:0-包年包月,1-按量计费
4148
+ */
4149
+ PayType: number
4150
+ /**
4151
+ * 购买时长。当 payType 为包年包月时,该项需要填,单位为月,最小值为 1,最大值为 120。不填默认1
4152
+ */
4153
+ Duration?: number
4154
+ /**
4155
+ * 是否自动续费。当 payType 为包年包月时,该项需要填。枚举值:0-不自动续费,1-自动续费。默认不自动续费。按量计费设置该标识无效。
4156
+ */
4157
+ AutoRenew?: number
4158
+ /**
4159
+ * 购买数量,默认为1,最大为10
4160
+ */
4161
+ Count?: number
4162
+ /**
4163
+ * 实例资源标签
4164
+ */
4165
+ Tags?: Array<TagItem>
4166
+ /**
4167
+ * 任务名,自定义
4168
+ */
4169
+ Name?: string
4170
+ }
4171
+
3188
4172
  /**
3189
4173
  * StartSyncJob返回参数结构体
3190
4174
  */
@@ -3195,6 +4179,42 @@ export interface StartSyncJobResponse {
3195
4179
  RequestId?: string
3196
4180
  }
3197
4181
 
4182
+ /**
4183
+ * StartMigrateJob请求参数结构体
4184
+ */
4185
+ export interface StartMigrateJobRequest {
4186
+ /**
4187
+ * 数据迁移任务ID
4188
+ */
4189
+ JobId: string
4190
+ }
4191
+
4192
+ /**
4193
+ * 订阅任务的kafka分区规则。符合库名和表名正则表达式的数据将按照RuleType计算该条数据将被投递的kafka分区。如果配置了多个规则,将按照配置的顺序,第一条命中的规则生效。
4194
+ */
4195
+ export interface DistributeRule {
4196
+ /**
4197
+ * 规则类型。非mongo产品的枚举值为: table-按表名分区,pk-按表名+主键分区,cols-按列名分区。mongo的枚举值为:collection-按集合名分区、collectionAndObjectId-按集合+主键分区。
4198
+ 注意:此字段可能返回 null,表示取不到有效值。
4199
+ */
4200
+ RuleType: string
4201
+ /**
4202
+ * 库名匹配规则,请填写正则表达式
4203
+ 注意:此字段可能返回 null,表示取不到有效值。
4204
+ */
4205
+ DbPattern: string
4206
+ /**
4207
+ * 表名匹配规则,如果 DatabaseType 为 mongodb,则匹配集合名
4208
+ 注意:此字段可能返回 null,表示取不到有效值。
4209
+ */
4210
+ TablePattern: string
4211
+ /**
4212
+ * 列名。如果 RuleType 为 cols,此项必填。订阅任务会用该列的值计算分区。mongo没有按列分区,因此也不用传这个字段。
4213
+ 注意:此字段可能返回 null,表示取不到有效值。
4214
+ */
4215
+ Columns?: Array<string>
4216
+ }
4217
+
3198
4218
  /**
3199
4219
  * 同步的数据库对对象描述
3200
4220
  */
@@ -3222,184 +4242,360 @@ export interface Objects {
3222
4242
  }
3223
4243
 
3224
4244
  /**
3225
- * RecoverMigrateJob返回参数结构体
4245
+ * DeleteConsumerGroup返回参数结构体
3226
4246
  */
3227
- export interface RecoverMigrateJobResponse {
4247
+ export interface DeleteConsumerGroupResponse {
4248
+ /**
4249
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4250
+ */
4251
+ RequestId?: string
4252
+ }
4253
+
4254
+ /**
4255
+ * 迁移对象信息,在配置库表视图等对象信息时大小写敏感
4256
+ */
4257
+ export interface DBItem {
4258
+ /**
4259
+ * 需要迁移或同步的库名,当ObjectMode为partial时,此项必填
4260
+ 注意:此字段可能返回 null,表示取不到有效值。
4261
+ */
4262
+ DbName?: string
4263
+ /**
4264
+ * 迁移或同步后的库名,默认与源库相同
4265
+ 注意:此字段可能返回 null,表示取不到有效值。
4266
+ */
4267
+ NewDbName?: string
4268
+ /**
4269
+ * 迁移或同步的 schema
4270
+ 注意:此字段可能返回 null,表示取不到有效值。
4271
+ */
4272
+ SchemaName?: string
4273
+ /**
4274
+ * 迁移或同步后的 schema name
4275
+ 注意:此字段可能返回 null,表示取不到有效值。
4276
+ */
4277
+ NewSchemaName?: string
4278
+ /**
4279
+ * DB选择模式: all(为当前对象下的所有对象),partial(部分对象),当ObjectMode为partial时,此项必填
4280
+ 注意:此字段可能返回 null,表示取不到有效值。
4281
+ */
4282
+ DBMode?: string
4283
+ /**
4284
+ * schema选择模式: all(为当前对象下的所有对象),partial(部分对象)
4285
+ 注意:此字段可能返回 null,表示取不到有效值。
4286
+ */
4287
+ SchemaMode?: string
4288
+ /**
4289
+ * 表选择模式: all(为当前对象下的所有对象),partial(部分对象),当DBMode为partial时此项必填
4290
+ 注意:此字段可能返回 null,表示取不到有效值。
4291
+ */
4292
+ TableMode?: string
4293
+ /**
4294
+ * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
4295
+ 注意:此字段可能返回 null,表示取不到有效值。
4296
+ */
4297
+ Tables?: Array<TableItem>
4298
+ /**
4299
+ * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
4300
+ 注意:此字段可能返回 null,表示取不到有效值。
4301
+ */
4302
+ ViewMode?: string
4303
+ /**
4304
+ * 视图对象集合,当 ViewMode 为 partial 时, 此项需要填写
4305
+ 注意:此字段可能返回 null,表示取不到有效值。
4306
+ */
4307
+ Views?: Array<ViewItem>
4308
+ /**
4309
+ * postgresql独有参数,角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象
4310
+ 注意:此字段可能返回 null,表示取不到有效值。
4311
+ */
4312
+ RoleMode?: string
4313
+ /**
4314
+ * postgresql独有参数,当 RoleMode 为 partial 时, 此项需要填写
4315
+ 注意:此字段可能返回 null,表示取不到有效值。
4316
+ */
4317
+ Roles?: Array<RoleItem>
4318
+ /**
4319
+ * 选择要同步的模式,partial为部分,all为整选
4320
+ 注意:此字段可能返回 null,表示取不到有效值。
4321
+ */
4322
+ FunctionMode?: string
4323
+ /**
4324
+ * 选择要同步的模式,partial为部分,all为整选
4325
+ 注意:此字段可能返回 null,表示取不到有效值。
4326
+ */
4327
+ TriggerMode?: string
4328
+ /**
4329
+ * 选择要同步的模式,partial为部分,all为整选
4330
+ 注意:此字段可能返回 null,表示取不到有效值。
4331
+ */
4332
+ EventMode?: string
4333
+ /**
4334
+ * 选择要同步的模式,partial为部分,all为整选
4335
+ 注意:此字段可能返回 null,表示取不到有效值。
4336
+ */
4337
+ ProcedureMode?: string
4338
+ /**
4339
+ * FunctionMode取值为partial时需要填写
4340
+ 注意:此字段可能返回 null,表示取不到有效值。
4341
+ */
4342
+ Functions?: Array<string>
4343
+ /**
4344
+ * ProcedureMode取值为partial时需要填写
4345
+ 注意:此字段可能返回 null,表示取不到有效值。
4346
+ */
4347
+ Procedures?: Array<string>
4348
+ /**
4349
+ * EventMode取值为partial时需要填写
4350
+ 注意:此字段可能返回 null,表示取不到有效值。
4351
+ */
4352
+ Events?: Array<string>
4353
+ /**
4354
+ * TriggerMode取值为partial时需要填写
4355
+ 注意:此字段可能返回 null,表示取不到有效值。
4356
+ */
4357
+ Triggers?: Array<string>
4358
+ }
4359
+
4360
+ /**
4361
+ * DeleteCompareTask请求参数结构体
4362
+ */
4363
+ export interface DeleteCompareTaskRequest {
4364
+ /**
4365
+ * 迁移任务 Id
4366
+ */
4367
+ JobId: string
4368
+ /**
4369
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4370
+ */
4371
+ CompareTaskId: string
4372
+ }
4373
+
4374
+ /**
4375
+ * 迁移执行过程信息
4376
+ */
4377
+ export interface MigrateDetailInfo {
4378
+ /**
4379
+ * 总步骤数
4380
+ 注意:此字段可能返回 null,表示取不到有效值。
4381
+ */
4382
+ StepAll: number
4383
+ /**
4384
+ * 当前步骤
4385
+ 注意:此字段可能返回 null,表示取不到有效值。
4386
+ */
4387
+ StepNow: number
4388
+ /**
4389
+ * 主从差距,MB;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
4390
+ 注意:此字段可能返回 null,表示取不到有效值。
4391
+ */
4392
+ MasterSlaveDistance: number
4393
+ /**
4394
+ * 主从差距,秒;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
4395
+ 注意:此字段可能返回 null,表示取不到有效值。
4396
+ */
4397
+ SecondsBehindMaster: number
4398
+ /**
4399
+ * 步骤信息
4400
+ 注意:此字段可能返回 null,表示取不到有效值。
4401
+ */
4402
+ StepInfo: Array<StepDetailInfo>
4403
+ }
4404
+
4405
+ /**
4406
+ * StopMigrateJob请求参数结构体
4407
+ */
4408
+ export interface StopMigrateJobRequest {
4409
+ /**
4410
+ * 数据迁移任务ID
4411
+ */
4412
+ JobId: string
4413
+ }
4414
+
4415
+ /**
4416
+ * 数据同步中的描述源端和目的端的信息
4417
+ */
4418
+ export interface Endpoint {
4419
+ /**
4420
+ * 地域英文名,如:ap-guangzhou
4421
+ 注意:此字段可能返回 null,表示取不到有效值。
4422
+ */
4423
+ Region?: string
4424
+ /**
4425
+ * tdsql mysql版的节点类型,枚举值为proxy、set
4426
+ 注意:此字段可能返回 null,表示取不到有效值。
4427
+ */
4428
+ Role?: string
4429
+ /**
4430
+ * 数据库内核类型,tdsql中用于区分不同内核:percona,mariadb,mysql
4431
+ 注意:此字段可能返回 null,表示取不到有效值。
4432
+ */
4433
+ DbKernel?: string
4434
+ /**
4435
+ * 数据库实例ID,格式如:cdb-powiqx8q
4436
+ 注意:此字段可能返回 null,表示取不到有效值。
4437
+ */
4438
+ InstanceId?: string
4439
+ /**
4440
+ * 实例的IP地址,接入类型为非cdb时此项必填
4441
+ 注意:此字段可能返回 null,表示取不到有效值。
4442
+ */
4443
+ Ip?: string
4444
+ /**
4445
+ * 实例端口,接入类型为非cdb时此项必填
4446
+ 注意:此字段可能返回 null,表示取不到有效值。
4447
+ */
4448
+ Port?: number
3228
4449
  /**
3229
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4450
+ * 用户名,对于访问需要用户名密码认证的实例必填
4451
+ 注意:此字段可能返回 null,表示取不到有效值。
3230
4452
  */
3231
- RequestId?: string
3232
- }
3233
-
3234
- /**
3235
- * 迁移对象信息,在配置库表视图等对象信息时大小写敏感
3236
- */
3237
- export interface DBItem {
4453
+ User?: string
3238
4454
  /**
3239
- * 需要迁移或同步的库名,当ObjectMode为partial时,此项必填
4455
+ * 密码,对于访问需要用户名密码认证的实例必填
3240
4456
  注意:此字段可能返回 null,表示取不到有效值。
3241
4457
  */
3242
- DbName?: string
4458
+ Password?: string
3243
4459
  /**
3244
- * 迁移或同步后的库名,默认与源库相同
4460
+ * 数据库名,数据库为cdwpg时,需要提供
3245
4461
  注意:此字段可能返回 null,表示取不到有效值。
3246
4462
  */
3247
- NewDbName?: string
4463
+ DbName?: string
3248
4464
  /**
3249
- * 迁移或同步的 schema
4465
+ * 私有网络ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:vpc-92jblxto
3250
4466
  注意:此字段可能返回 null,表示取不到有效值。
3251
4467
  */
3252
- SchemaName?: string
4468
+ VpcId?: string
3253
4469
  /**
3254
- * 迁移或同步后的 schema name
4470
+ * 私有网络下的子网ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:subnet-3paxmkdz
3255
4471
  注意:此字段可能返回 null,表示取不到有效值。
3256
4472
  */
3257
- NewSchemaName?: string
4473
+ SubnetId?: string
3258
4474
  /**
3259
- * DB选择模式: all(为当前对象下的所有对象),partial(部分对象),当ObjectMode为partial时,此项必填
4475
+ * CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
3260
4476
  注意:此字段可能返回 null,表示取不到有效值。
3261
4477
  */
3262
- DBMode?: string
4478
+ CvmInstanceId?: string
3263
4479
  /**
3264
- * schema选择模式: all(为当前对象下的所有对象),partial(部分对象)
4480
+ * 专线网关ID,对于专线接入类型此项必填,格式如:dcg-0rxtqqxb
3265
4481
  注意:此字段可能返回 null,表示取不到有效值。
3266
4482
  */
3267
- SchemaMode?: string
4483
+ UniqDcgId?: string
3268
4484
  /**
3269
- * 表选择模式: all(为当前对象下的所有对象),partial(部分对象),当DBMode为partial时此项必填
4485
+ * VPN网关ID,对于vpn接入类型此项必填,格式如:vpngw-9ghexg7q
3270
4486
  注意:此字段可能返回 null,表示取不到有效值。
3271
4487
  */
3272
- TableMode?: string
4488
+ UniqVpnGwId?: string
3273
4489
  /**
3274
- * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
4490
+ * 云联网ID,对于云联网接入类型此项必填,如:ccn-afp6kltc
3275
4491
  注意:此字段可能返回 null,表示取不到有效值。
3276
4492
  */
3277
- Tables?: Array<TableItem>
4493
+ CcnId?: string
3278
4494
  /**
3279
- * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
4495
+ * 云厂商类型,当实例为RDS实例时,填写为aliyun, 其他情况均填写others,默认为others
3280
4496
  注意:此字段可能返回 null,表示取不到有效值。
3281
4497
  */
3282
- ViewMode?: string
4498
+ Supplier?: string
3283
4499
  /**
3284
- * 视图对象集合,当 ViewMode 为 partial 时, 此项需要填写
4500
+ * 数据库版本,当实例为RDS实例时才有效,其他实例忽略,格式如:5.6或者5.7,默认为5.6
3285
4501
  注意:此字段可能返回 null,表示取不到有效值。
3286
4502
  */
3287
- Views?: Array<ViewItem>
4503
+ EngineVersion?: string
3288
4504
  /**
3289
- * postgresql独有参数,角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象
4505
+ * 实例所属账号,如果为跨账号实例此项必填
3290
4506
  注意:此字段可能返回 null,表示取不到有效值。
3291
4507
  */
3292
- RoleMode?: string
4508
+ Account?: string
3293
4509
  /**
3294
- * postgresql独有参数,当 RoleMode 为 partial 时, 此项需要填写
4510
+ * 资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)
3295
4511
  注意:此字段可能返回 null,表示取不到有效值。
3296
4512
  */
3297
- Roles?: Array<RoleItem>
4513
+ AccountMode?: string
3298
4514
  /**
3299
- * 选择要同步的模式,partial为部分,all为整选
4515
+ * 跨账号同步时的角色,只允许[a-zA-Z0-9\-\_]+,如果为跨账号实例此项必填
3300
4516
  注意:此字段可能返回 null,表示取不到有效值。
3301
4517
  */
3302
- FunctionMode?: string
4518
+ AccountRole?: string
3303
4519
  /**
3304
- * 选择要同步的模式,partial为部分,all为整选
4520
+ * 外部角色id
3305
4521
  注意:此字段可能返回 null,表示取不到有效值。
3306
4522
  */
3307
- TriggerMode?: string
4523
+ RoleExternalId?: string
3308
4524
  /**
3309
- * 选择要同步的模式,partial为部分,all为整选
4525
+ * 临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填
3310
4526
  注意:此字段可能返回 null,表示取不到有效值。
3311
4527
  */
3312
- EventMode?: string
4528
+ TmpSecretId?: string
3313
4529
  /**
3314
- * 选择要同步的模式,partial为部分,all为整选
4530
+ * 临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
3315
4531
  注意:此字段可能返回 null,表示取不到有效值。
3316
4532
  */
3317
- ProcedureMode?: string
4533
+ TmpSecretKey?: string
3318
4534
  /**
3319
- * FunctionMode取值为partial时需要填写
4535
+ * 临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
3320
4536
  注意:此字段可能返回 null,表示取不到有效值。
3321
4537
  */
3322
- Functions?: Array<string>
4538
+ TmpToken?: string
3323
4539
  /**
3324
- * ProcedureMode取值为partial时需要填写
4540
+ * 是否走加密传输、UnEncrypted表示不走加密传输,Encrypted表示走加密传输,默认UnEncrypted
3325
4541
  注意:此字段可能返回 null,表示取不到有效值。
3326
4542
  */
3327
- Procedures?: Array<string>
4543
+ EncryptConn?: string
3328
4544
  /**
3329
- * EventMode取值为partial时需要填写
4545
+ * 数据库所属网络环境,AccessType为云联网(ccn)时必填, UserIDC表示用户IDC、TencentVPC表示腾讯云VPC;
3330
4546
  注意:此字段可能返回 null,表示取不到有效值。
3331
4547
  */
3332
- Events?: Array<string>
4548
+ DatabaseNetEnv?: string
3333
4549
  /**
3334
- * TriggerMode取值为partial时需要填写
4550
+ * 数据库为跨账号云联网下的实例时、表示云联网所属主账号
3335
4551
  注意:此字段可能返回 null,表示取不到有效值。
3336
4552
  */
3337
- Triggers?: Array<string>
4553
+ CcnOwnerUin?: string
3338
4554
  }
3339
4555
 
3340
4556
  /**
3341
- * DeleteCompareTask请求参数结构体
4557
+ * ConfigureSubscribeJob请求参数结构体
3342
4558
  */
3343
- export interface DeleteCompareTaskRequest {
4559
+ export interface ConfigureSubscribeJobRequest {
3344
4560
  /**
3345
- * 迁移任务 Id
4561
+ * 数据订阅实例的 ID
3346
4562
  */
3347
- JobId: string
4563
+ SubscribeId: string
3348
4564
  /**
3349
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4565
+ * 数据订阅的类型,当 DatabaseType 不为 mongodb 时,枚举值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时,枚举值为 all-全实例更新;database-订阅单库;collection-订阅单集合
3350
4566
  */
3351
- CompareTaskId: string
3352
- }
3353
-
3354
- /**
3355
- * 迁移执行过程信息
3356
- */
3357
- export interface MigrateDetailInfo {
4567
+ SubscribeMode: string
3358
4568
  /**
3359
- * 总步骤数
3360
- 注意:此字段可能返回 null,表示取不到有效值。
4569
+ * 源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云主机自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
3361
4570
  */
3362
- StepAll: number
4571
+ AccessType: string
3363
4572
  /**
3364
- * 当前步骤
3365
- 注意:此字段可能返回 null,表示取不到有效值。
4573
+ * 数据库节点信息
3366
4574
  */
3367
- StepNow: number
4575
+ Endpoints: Array<EndpointItem>
3368
4576
  /**
3369
- * 主从差距,MB;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
3370
- 注意:此字段可能返回 null,表示取不到有效值。
4577
+ * Kafka配置
3371
4578
  */
3372
- MasterSlaveDistance: number
4579
+ KafkaConfig: SubscribeKafkaConfig
3373
4580
  /**
3374
- * 主从差距,秒;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
3375
- 注意:此字段可能返回 null,表示取不到有效值。
4581
+ * 订阅的数据库表信息,当 SubscribeMode 不为 all和ddl 时,SubscribeObjects 为必选参数
3376
4582
  */
3377
- SecondsBehindMaster: number
4583
+ SubscribeObjects?: Array<SubscribeObject>
3378
4584
  /**
3379
- * 步骤信息
3380
- 注意:此字段可能返回 null,表示取不到有效值。
4585
+ * 订阅数据格式,如:protobuf、json、avro。注意具体可选值依赖当前链路支持能力,数据格式详情参考官网的消费demo文档
3381
4586
  */
3382
- StepInfo: Array<StepDetailInfo>
3383
- }
3384
-
3385
- /**
3386
- * StopMigrateJob请求参数结构体
3387
- */
3388
- export interface StopMigrateJobRequest {
4587
+ Protocol?: string
3389
4588
  /**
3390
- * 数据迁移任务ID
4589
+ * mongo选填参数:输出聚合设置。
3391
4590
  */
3392
- JobId: string
3393
- }
3394
-
3395
- /**
3396
- * IsolateMigrateJob返回参数结构体
3397
- */
3398
- export interface IsolateMigrateJobResponse {
4591
+ PipelineInfo?: Array<PipelineInfo>
3399
4592
  /**
3400
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
4593
+ * 为业务添加的额外信息。参数名作key,参数值作value
4594
+ mysql选填参数:ProcessXA-是否处理XA事务,填true处理,不填或填其他值不处理。
4595
+ mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream,不填也是默认changeStream。
4596
+ 其他业务暂没有可选参数。
3401
4597
  */
3402
- RequestId?: string
4598
+ ExtraAttr?: Array<KeyValuePairOption>
3403
4599
  }
3404
4600
 
3405
4601
  /**
@@ -3584,30 +4780,39 @@ export interface SyncJobInfo {
3584
4780
  }
3585
4781
 
3586
4782
  /**
3587
- * 一致性校验选项
4783
+ * DescribeSubscribeCheckJob返回参数结构体
3588
4784
  */
3589
- export interface CompareOptions {
4785
+ export interface DescribeSubscribeCheckJobResponse {
3590
4786
  /**
3591
- * 对比方式:dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比)
3592
- 注意:此字段可能返回 null,表示取不到有效值。
4787
+ * 订阅实例ID
3593
4788
  */
3594
- Method?: string
4789
+ SubscribeId?: string
3595
4790
  /**
3596
- * 抽样比例;范围0,100
4791
+ * 失败或者报错提示,成功则提示success。
3597
4792
  注意:此字段可能返回 null,表示取不到有效值。
3598
4793
  */
3599
- SampleRate?: number
4794
+ Message?: string
3600
4795
  /**
3601
- * 线程数,取值1-5,默认为1
4796
+ * 任务运行状态,可能值为 running,failed,success
4797
+ */
4798
+ Status?: string
4799
+ /**
4800
+ * 当前总体进度,范围 0~100
4801
+ */
4802
+ Progress?: number
4803
+ /**
4804
+ * 校验总步骤数
4805
+ */
4806
+ StepAll?: number
4807
+ /**
4808
+ * 当前执行步骤
4809
+ */
4810
+ StepNow?: number
4811
+ /**
4812
+ * 各个步骤运行状态
3602
4813
  注意:此字段可能返回 null,表示取不到有效值。
3603
4814
  */
3604
- ThreadCount?: number
3605
- }
3606
-
3607
- /**
3608
- * ModifySyncJobConfig返回参数结构体
3609
- */
3610
- export interface ModifySyncJobConfigResponse {
4815
+ Steps?: Array<SubscribeCheckStepInfo>
3611
4816
  /**
3612
4817
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3613
4818
  */
@@ -3750,19 +4955,26 @@ export interface CreateSyncJobRequest {
3750
4955
  }
3751
4956
 
3752
4957
  /**
3753
- * 视图对象
4958
+ * 订阅的kafka分区数和分区规则。mariadb,percona,tdsqlmysql,tdpg不支持自定义分区,所以DistributeRules和DefaultRuleType可以不填,但是NumberOfPartitions是必填。
3754
4959
  */
3755
- export interface ViewItem {
4960
+ export interface SubscribeKafkaConfig {
3756
4961
  /**
3757
- * 视图名称
4962
+ * kafka分区数量,枚举值为1,4,8
3758
4963
  注意:此字段可能返回 null,表示取不到有效值。
3759
4964
  */
3760
- ViewName?: string
4965
+ NumberOfPartitions: number
3761
4966
  /**
3762
- * 迁移后的视图名称
4967
+ * 分区规则。当NumberOfPartitions > 1时,该项必填。
3763
4968
  注意:此字段可能返回 null,表示取不到有效值。
3764
4969
  */
3765
- NewViewName?: string
4970
+ DistributeRules?: Array<DistributeRule>
4971
+ /**
4972
+ * 默认分区策略。当NumberOfPartitions > 1时,该项必填。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
4973
+ 非mongo产品的枚举值为: table-按表名分区,pk-按表名+主键分区。mongo的枚举值为:collection-按集合名分区。
4974
+ 该字段与DistributeRules搭配使用,如果配置了该字段,视为配置了一条DistributeRules。
4975
+ 注意:此字段可能返回 null,表示取不到有效值。
4976
+ */
4977
+ DefaultRuleType?: string
3766
4978
  }
3767
4979
 
3768
4980
  /**
@@ -3833,19 +5045,32 @@ export interface SkippedItem {
3833
5045
  }
3834
5046
 
3835
5047
  /**
3836
- * 数据同步view的描述
5048
+ * IsolateSubscribe请求参数结构体
3837
5049
  */
3838
- export interface View {
5050
+ export interface IsolateSubscribeRequest {
3839
5051
  /**
3840
- * view名
3841
- 注意:此字段可能返回 null,表示取不到有效值。
5052
+ * 订阅实例ID
3842
5053
  */
3843
- ViewName?: string
5054
+ SubscribeId: string
5055
+ }
5056
+
5057
+ /**
5058
+ * DescribeSubscribeReturnable返回参数结构体
5059
+ */
5060
+ export interface DescribeSubscribeReturnableResponse {
3844
5061
  /**
3845
- * 预留字段、目前暂时不支持view的重命名
5062
+ * 实例是否支持退还/退货
5063
+ */
5064
+ IsReturnable?: boolean
5065
+ /**
5066
+ * 不支持退还的原因
3846
5067
  注意:此字段可能返回 null,表示取不到有效值。
3847
5068
  */
3848
- NewViewName?: string
5069
+ ReturnFailMessage?: string
5070
+ /**
5071
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5072
+ */
5073
+ RequestId?: string
3849
5074
  }
3850
5075
 
3851
5076
  /**
@@ -3885,6 +5110,34 @@ export interface OnlineDDL {
3885
5110
  Status: string
3886
5111
  }
3887
5112
 
5113
+ /**
5114
+ * DescribeSubscribeJobs返回参数结构体
5115
+ */
5116
+ export interface DescribeSubscribeJobsResponse {
5117
+ /**
5118
+ * 符合查询条件的实例总数
5119
+ */
5120
+ TotalCount?: number
5121
+ /**
5122
+ * 数据订阅实例的信息列表
5123
+ */
5124
+ Items?: Array<SubscribeInfo>
5125
+ /**
5126
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5127
+ */
5128
+ RequestId?: string
5129
+ }
5130
+
5131
+ /**
5132
+ * ResetSubscribe请求参数结构体
5133
+ */
5134
+ export interface ResetSubscribeRequest {
5135
+ /**
5136
+ * 数据订阅实例的ID
5137
+ */
5138
+ SubscribeId: string
5139
+ }
5140
+
3888
5141
  /**
3889
5142
  * 迁移对象选项,需要告知迁移服务迁移哪些库表对象
3890
5143
  */
@@ -3971,6 +5224,22 @@ export interface Table {
3971
5224
  TableEditMode?: string
3972
5225
  }
3973
5226
 
5227
+ /**
5228
+ * 订阅校验任务的提示信息
5229
+ */
5230
+ export interface SubscribeCheckStepTip {
5231
+ /**
5232
+ * 错误或告警的详细信息
5233
+ 注意:此字段可能返回 null,表示取不到有效值。
5234
+ */
5235
+ Message?: string
5236
+ /**
5237
+ * 帮助文档
5238
+ 注意:此字段可能返回 null,表示取不到有效值。
5239
+ */
5240
+ HelpDoc?: string
5241
+ }
5242
+
3974
5243
  /**
3975
5244
  * 一致性校验详细信息
3976
5245
  */
@@ -3987,6 +5256,56 @@ export interface CompareDetailInfo {
3987
5256
  Skipped: SkippedDetail
3988
5257
  }
3989
5258
 
5259
+ /**
5260
+ * DescribeSubscribeJobs请求参数结构体
5261
+ */
5262
+ export interface DescribeSubscribeJobsRequest {
5263
+ /**
5264
+ * 订阅 ID 筛选,精确匹配
5265
+ */
5266
+ SubscribeId?: string
5267
+ /**
5268
+ * 订阅名称,前缀模糊匹配
5269
+ */
5270
+ SubscribeName?: string
5271
+ /**
5272
+ * 订阅的云上数据库实例的 ID,精确匹配
5273
+ */
5274
+ InstanceId?: string
5275
+ /**
5276
+ * 计费模式筛选,可能的值:0-包年包月,1-按量计费
5277
+ */
5278
+ PayType?: number
5279
+ /**
5280
+ * 订阅的数据库产品,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
5281
+ */
5282
+ Product?: string
5283
+ /**
5284
+ * 数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining,按量转包年包月中 post2PrePayIng
5285
+ */
5286
+ Status?: Array<string>
5287
+ /**
5288
+ * 数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
5289
+ */
5290
+ SubsStatus?: Array<string>
5291
+ /**
5292
+ * 返回记录的起始偏移量。默认0
5293
+ */
5294
+ Offset?: number
5295
+ /**
5296
+ * 单次返回的记录数量。默认20,最大100
5297
+ */
5298
+ Limit?: number
5299
+ /**
5300
+ * 排序方向,可选的值为"DESC"和"ASC",默认为"DESC",按创建时间逆序排序
5301
+ */
5302
+ OrderDirection?: string
5303
+ /**
5304
+ * tag 过滤条件,多个 TagFilter 之间关系为且
5305
+ */
5306
+ TagFilters?: Array<TagFilter>
5307
+ }
5308
+
3990
5309
  /**
3991
5310
  * StartMigrateJob返回参数结构体
3992
5311
  */