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
@@ -35,6 +35,15 @@ export interface ModifyMigrationJobResponse {
35
35
  */
36
36
  RequestId?: string;
37
37
  }
38
+ /**
39
+ * ResetConsumerGroupOffset返回参数结构体
40
+ */
41
+ export interface ResetConsumerGroupOffsetResponse {
42
+ /**
43
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
44
+ */
45
+ RequestId?: string;
46
+ }
38
47
  /**
39
48
  * ModifyMigrateRateLimit返回参数结构体
40
49
  */
@@ -44,6 +53,15 @@ export interface ModifyMigrateRateLimitResponse {
44
53
  */
45
54
  RequestId?: string;
46
55
  }
56
+ /**
57
+ * IsolateMigrateJob返回参数结构体
58
+ */
59
+ export interface IsolateMigrateJobResponse {
60
+ /**
61
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
62
+ */
63
+ RequestId?: string;
64
+ }
47
65
  /**
48
66
  * ModifyMigrateJobSpec请求参数结构体
49
67
  */
@@ -58,13 +76,38 @@ export interface ModifyMigrateJobSpecRequest {
58
76
  NewInstanceClass: string;
59
77
  }
60
78
  /**
61
- * StartMigrateJob请求参数结构体
79
+ * IsolateSubscribe返回参数结构体
62
80
  */
63
- export interface StartMigrateJobRequest {
81
+ export interface IsolateSubscribeResponse {
64
82
  /**
65
- * 数据迁移任务ID
83
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
66
84
  */
67
- JobId: string;
85
+ RequestId?: string;
86
+ }
87
+ /**
88
+ * ModifyConsumerGroupPassword请求参数结构体
89
+ */
90
+ export interface ModifyConsumerGroupPasswordRequest {
91
+ /**
92
+ * 数据订阅实例的 ID
93
+ */
94
+ SubscribeId: string;
95
+ /**
96
+ * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}
97
+ */
98
+ AccountName: string;
99
+ /**
100
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
101
+ */
102
+ ConsumerGroupName: string;
103
+ /**
104
+ * 旧密码
105
+ */
106
+ OldPassword: string;
107
+ /**
108
+ * 新密码。字符长度不小于3,不大于32
109
+ */
110
+ NewPassword: string;
68
111
  }
69
112
  /**
70
113
  * 当前步骤错误信息或者警告信息
@@ -114,6 +157,34 @@ export interface DestroyMigrateJobRequest {
114
157
  */
115
158
  JobId?: string;
116
159
  }
160
+ /**
161
+ * ModifySubscribeName请求参数结构体
162
+ */
163
+ export interface ModifySubscribeNameRequest {
164
+ /**
165
+ * 数据订阅实例的ID
166
+ */
167
+ SubscribeId: string;
168
+ /**
169
+ * 修改后的数据订阅实例的名称,长度限制为[1,60]
170
+ */
171
+ SubscribeName: string;
172
+ }
173
+ /**
174
+ * 数据订阅kafka分区中checkpoint信息
175
+ */
176
+ export interface OffsetTimeMap {
177
+ /**
178
+ * kafka分区编号
179
+ 注意:此字段可能返回 null,表示取不到有效值。
180
+ */
181
+ PartitionNo?: number;
182
+ /**
183
+ * kafka offset
184
+ 注意:此字段可能返回 null,表示取不到有效值。
185
+ */
186
+ Offset?: number;
187
+ }
117
188
  /**
118
189
  * SkipCheckItem返回参数结构体
119
190
  */
@@ -129,14 +200,28 @@ export interface SkipCheckItemResponse {
129
200
  RequestId?: string;
130
201
  }
131
202
  /**
132
- * IsolateMigrateJob请求参数结构体
203
+ * ResumeSyncJob请求参数结构体
133
204
  */
134
- export interface IsolateMigrateJobRequest {
205
+ export interface ResumeSyncJobRequest {
135
206
  /**
136
- * 任务id
207
+ * 同步任务id
137
208
  */
138
209
  JobId: string;
139
210
  }
211
+ /**
212
+ * 数据订阅中kafka消费者组的分区分配情况。该数据是实时查询的,如果需要最新数据,需重新掉接口查询。
213
+ */
214
+ export interface PartitionAssignment {
215
+ /**
216
+ * 消费者的clientId
217
+ */
218
+ ClientId: string;
219
+ /**
220
+ * 该消费者正在消费的分区
221
+ 注意:此字段可能返回 null,表示取不到有效值。
222
+ */
223
+ PartitionNo: Array<number | bigint>;
224
+ }
140
225
  /**
141
226
  * ResizeSyncJob返回参数结构体
142
227
  */
@@ -146,6 +231,15 @@ export interface ResizeSyncJobResponse {
146
231
  */
147
232
  RequestId?: string;
148
233
  }
234
+ /**
235
+ * CreateSubscribeCheckJob请求参数结构体
236
+ */
237
+ export interface CreateSubscribeCheckJobRequest {
238
+ /**
239
+ * 数据订阅实例的 ID
240
+ */
241
+ SubscribeId: string;
242
+ }
149
243
  /**
150
244
  * ResumeMigrateJob返回参数结构体
151
245
  */
@@ -246,6 +340,35 @@ export interface ContinueMigrateJobRequest {
246
340
  */
247
341
  JobId: string;
248
342
  }
343
+ /**
344
+ * ResetConsumerGroupOffset请求参数结构体
345
+ */
346
+ export interface ResetConsumerGroupOffsetRequest {
347
+ /**
348
+ * 订阅实例id
349
+ */
350
+ SubscribeId: string;
351
+ /**
352
+ * 订阅的kafka topic
353
+ */
354
+ TopicName: string;
355
+ /**
356
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
357
+ */
358
+ ConsumerGroupName: string;
359
+ /**
360
+ * 需要修改offset的分区编号
361
+ */
362
+ PartitionNos: Array<number | bigint>;
363
+ /**
364
+ * 重置方式。枚举值为 earliest-从最开始位置开始消费;latest-从最新位置开始消费;datetime-从指定时间前最近的checkpoint开始消费
365
+ */
366
+ ResetMode: string;
367
+ /**
368
+ * 当 ResetMode 为 datetime 时,该项需要填,格式为:Y-m-d h:m:s。如果不填,默认用0时间,效果与earliest相同。
369
+ */
370
+ ResetDatetime?: string;
371
+ }
249
372
  /**
250
373
  * ModifySyncRateLimit请求参数结构体
251
374
  */
@@ -285,206 +408,192 @@ export interface DescribeCheckSyncJobResultRequest {
285
408
  JobId?: string;
286
409
  }
287
410
  /**
288
- * DestroySyncJob返回参数结构体
411
+ * ModifySubscribeAutoRenewFlag返回参数结构体
289
412
  */
290
- export interface DestroySyncJobResponse {
413
+ export interface ModifySubscribeAutoRenewFlagResponse {
291
414
  /**
292
415
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
293
416
  */
294
417
  RequestId?: string;
295
418
  }
296
419
  /**
297
- * DescribeCompareReport返回参数结构体
420
+ * DestroySyncJob返回参数结构体
298
421
  */
299
- export interface DescribeCompareReportResponse {
300
- /**
301
- * 一致性校验摘要信息
302
- 注意:此字段可能返回 null,表示取不到有效值。
303
- */
304
- Abstract: CompareAbstractInfo;
305
- /**
306
- * 一致性校验详细信息
307
- 注意:此字段可能返回 null,表示取不到有效值。
308
- */
309
- Detail: CompareDetailInfo;
422
+ export interface DestroySyncJobResponse {
310
423
  /**
311
424
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
312
425
  */
313
426
  RequestId?: string;
314
427
  }
315
428
  /**
316
- * 数据同步中的描述源端和目的端的信息
429
+ * 任务错误信息
317
430
  */
318
- export interface Endpoint {
431
+ export interface ErrorInfoItem {
319
432
  /**
320
- * 地域英文名,如:ap-guangzhou
433
+ * 错误码
321
434
  注意:此字段可能返回 null,表示取不到有效值。
322
435
  */
323
- Region?: string;
436
+ Code?: string;
324
437
  /**
325
- * tdsql mysql版的节点类型,枚举值为proxy、set
438
+ * 解决方案
326
439
  注意:此字段可能返回 null,表示取不到有效值。
327
440
  */
328
- Role?: string;
441
+ Solution?: string;
329
442
  /**
330
- * 数据库内核类型,tdsql中用于区分不同内核:percona,mariadb,mysql
443
+ * 错误日志信息
331
444
  注意:此字段可能返回 null,表示取不到有效值。
332
445
  */
333
- DbKernel?: string;
446
+ ErrorLog?: string;
334
447
  /**
335
- * 数据库实例ID,格式如:cdb-powiqx8q
448
+ * 文档提示
336
449
  注意:此字段可能返回 null,表示取不到有效值。
337
450
  */
338
- InstanceId?: string;
451
+ HelpDoc?: string;
452
+ }
453
+ /**
454
+ * IsolateMigrateJob请求参数结构体
455
+ */
456
+ export interface IsolateMigrateJobRequest {
339
457
  /**
340
- * 实例的IP地址,接入类型为非cdb时此项必填
341
- 注意:此字段可能返回 null,表示取不到有效值。
458
+ * 任务id
342
459
  */
343
- Ip?: string;
460
+ JobId: string;
461
+ }
462
+ /**
463
+ * StopMigrateJob返回参数结构体
464
+ */
465
+ export interface StopMigrateJobResponse {
344
466
  /**
345
- * 实例端口,接入类型为非cdb时此项必填
346
- 注意:此字段可能返回 null,表示取不到有效值。
467
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
347
468
  */
348
- Port?: number;
469
+ RequestId?: string;
470
+ }
471
+ /**
472
+ * 表对象集合,当 TableMode 为 partial 时,此项需要填写
473
+ */
474
+ export interface TableItem {
349
475
  /**
350
- * 用户名,对于访问需要用户名密码认证的实例必填
476
+ * 迁移的表名,大小写敏感
351
477
  注意:此字段可能返回 null,表示取不到有效值。
352
478
  */
353
- User?: string;
479
+ TableName?: string;
354
480
  /**
355
- * 密码,对于访问需要用户名密码认证的实例必填
481
+ * 迁移后的表名,当TableEditMode为rename时此项必填,注意此配置与TmpTables互斥,只能使用其中一种
356
482
  注意:此字段可能返回 null,表示取不到有效值。
357
483
  */
358
- Password?: string;
484
+ NewTableName?: string;
359
485
  /**
360
- * 数据库名,数据库为cdwpg时,需要提供
486
+ * 迁移临时表,注意此配置与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产生的临时表可同时配置。
361
487
  注意:此字段可能返回 null,表示取不到有效值。
362
488
  */
363
- DbName?: string;
489
+ TmpTables?: Array<string>;
364
490
  /**
365
- * 私有网络ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:vpc-92jblxto
491
+ * 编辑表类型,rename(表映射),pt(同步附加表)
366
492
  注意:此字段可能返回 null,表示取不到有效值。
367
493
  */
368
- VpcId?: string;
494
+ TableEditMode?: string;
495
+ }
496
+ /**
497
+ * 订阅实例信息
498
+ */
499
+ export interface SubscribeInfo {
369
500
  /**
370
- * 私有网络下的子网ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:subnet-3paxmkdz
371
- 注意:此字段可能返回 null,表示取不到有效值。
501
+ * 数据订阅的实例ID
372
502
  */
373
- SubnetId?: string;
503
+ SubscribeId?: string;
374
504
  /**
375
- * CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
376
- 注意:此字段可能返回 null,表示取不到有效值。
505
+ * 数据订阅实例的名称
377
506
  */
378
- CvmInstanceId?: string;
507
+ SubscribeName?: string;
379
508
  /**
380
- * 专线网关ID,对于专线接入类型此项必填,格式如:dcg-0rxtqqxb
509
+ * 订阅实例发送数据的kafka topic
381
510
  注意:此字段可能返回 null,表示取不到有效值。
382
511
  */
383
- UniqDcgId?: string;
512
+ Topic?: string;
384
513
  /**
385
- * VPN网关ID,对于vpn接入类型此项必填,格式如:vpngw-9ghexg7q
386
- 注意:此字段可能返回 null,表示取不到有效值。
514
+ * 订阅实例的类型,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
387
515
  */
388
- UniqVpnGwId?: string;
516
+ Product?: string;
389
517
  /**
390
- * 云联网ID,对于云联网接入类型此项必填,如:ccn-afp6kltc
518
+ * 订阅的数据库实例ID(如果订阅的是云数据库)如果实例不是腾讯云上的,此值为空。
391
519
  注意:此字段可能返回 null,表示取不到有效值。
392
520
  */
393
- CcnId?: string;
521
+ InstanceId?: string;
394
522
  /**
395
- * 云厂商类型,当实例为RDS实例时,填写为aliyun, 其他情况均填写others,默认为others
523
+ * 云数据库状态:running 运行中,isolated 已隔离,offline 已下线。如果不是云上,此值为空
396
524
  注意:此字段可能返回 null,表示取不到有效值。
397
525
  */
398
- Supplier?: string;
526
+ InstanceStatus?: string;
399
527
  /**
400
- * 数据库版本,当实例为RDS实例时才有效,其他实例忽略,格式如:5.6或者5.7,默认为5.6
401
- 注意:此字段可能返回 null,表示取不到有效值。
528
+ * 数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
402
529
  */
403
- EngineVersion?: string;
530
+ Status?: string;
404
531
  /**
405
- * 实例所属账号,如果为跨账号实例此项必填
406
- 注意:此字段可能返回 null,表示取不到有效值。
532
+ * 数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
407
533
  */
408
- Account?: string;
534
+ SubsStatus?: string;
409
535
  /**
410
- * 资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)
536
+ * 上次修改时间,时间格式如:Y-m-d h:m:s
411
537
  注意:此字段可能返回 null,表示取不到有效值。
412
538
  */
413
- AccountMode?: string;
539
+ ModifyTime?: string;
414
540
  /**
415
- * 跨账号同步时的角色,只允许[a-zA-Z0-9\-\_]+,如果为跨账号实例此项必填
541
+ * 创建时间,时间格式如:Y-m-d h:m:s
416
542
  注意:此字段可能返回 null,表示取不到有效值。
417
543
  */
418
- AccountRole?: string;
544
+ CreateTime?: string;
419
545
  /**
420
- * 外部角色id
546
+ * 隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
421
547
  注意:此字段可能返回 null,表示取不到有效值。
422
548
  */
423
- RoleExternalId?: string;
549
+ IsolateTime?: string;
424
550
  /**
425
- * 临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填
551
+ * 包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
426
552
  注意:此字段可能返回 null,表示取不到有效值。
427
553
  */
428
- TmpSecretId?: string;
554
+ ExpireTime?: string;
429
555
  /**
430
- * 临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
556
+ * 下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
431
557
  注意:此字段可能返回 null,表示取不到有效值。
432
558
  */
433
- TmpSecretKey?: string;
559
+ OfflineTime?: string;
434
560
  /**
435
- * 临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
436
- 注意:此字段可能返回 null,表示取不到有效值。
561
+ * 计费方式,0 - 包年包月,1 - 按量计费
437
562
  */
438
- TmpToken?: string;
563
+ PayType?: number;
439
564
  /**
440
- * 是否走加密传输、UnEncrypted表示不走加密传输,Encrypted表示走加密传输,默认UnEncrypted
441
- 注意:此字段可能返回 null,表示取不到有效值。
565
+ * 自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
442
566
  */
443
- EncryptConn?: string;
567
+ AutoRenewFlag?: number;
444
568
  /**
445
- * 数据库所属网络环境,AccessType为云联网(ccn)时必填, UserIDC表示用户IDC、TencentVPC表示腾讯云VPC;
446
- 注意:此字段可能返回 null,表示取不到有效值。
569
+ * 数据订阅实例所属地域
447
570
  */
448
- DatabaseNetEnv?: string;
571
+ Region?: string;
449
572
  /**
450
- * 数据库为跨账号云联网下的实例时、表示云联网所属主账号
573
+ * 接入方式。枚举值:extranet(公网) vpncloud(vpn接入) dcg(专线接入) ccn(云联网) cdb(云数据库) cvm(云主机自建) intranet(自研上云) vpc(私有网络vpc)
451
574
  注意:此字段可能返回 null,表示取不到有效值。
452
575
  */
453
- CcnOwnerUin?: string;
454
- }
455
- /**
456
- * StopMigrateJob返回参数结构体
457
- */
458
- export interface StopMigrateJobResponse {
459
- /**
460
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
461
- */
462
- RequestId?: string;
463
- }
464
- /**
465
- * 表对象集合,当 TableMode 为 partial 时,此项需要填写
466
- */
467
- export interface TableItem {
576
+ AccessType?: string;
468
577
  /**
469
- * 迁移的表名,大小写敏感
578
+ * 数据库节点信息
470
579
  注意:此字段可能返回 null,表示取不到有效值。
471
580
  */
472
- TableName?: string;
581
+ Endpoints?: Array<EndpointItem>;
473
582
  /**
474
- * 迁移后的表名,当TableEditMode为rename时此项必填,注意此配置与TmpTables互斥,只能使用其中一种
583
+ * 数据订阅版本, 当前只支持 kafka 版本。
475
584
  注意:此字段可能返回 null,表示取不到有效值。
476
585
  */
477
- NewTableName?: string;
586
+ SubscribeVersion?: string;
478
587
  /**
479
- * 迁移临时表,注意此配置与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产生的临时表可同时配置。
588
+ * 标签
480
589
  注意:此字段可能返回 null,表示取不到有效值。
481
590
  */
482
- TmpTables?: Array<string>;
591
+ Tags?: Array<TagItem>;
483
592
  /**
484
- * 编辑表类型,rename(表映射),pt(同步附加表)
593
+ * 任务报错信息,如果有的话。
485
594
  注意:此字段可能返回 null,表示取不到有效值。
486
595
  */
487
- TableEditMode?: string;
596
+ Errors?: Array<SubsErr>;
488
597
  }
489
598
  /**
490
599
  * ModifyCompareTaskName请求参数结构体
@@ -589,36 +698,61 @@ export interface DescribeModifyCheckSyncJobResultResponse {
589
698
  RequestId?: string;
590
699
  }
591
700
  /**
592
- * StopSyncJob请求参数结构体
701
+ * StartSubscribe返回参数结构体
593
702
  */
594
- export interface StopSyncJobRequest {
703
+ export interface StartSubscribeResponse {
595
704
  /**
596
- * 同步任务id
705
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
597
706
  */
598
- JobId: string;
707
+ RequestId?: string;
599
708
  }
600
709
  /**
601
- * DescribeMigrationDetail请求参数结构体
710
+ * DescribeSubscribeReturnable请求参数结构体
602
711
  */
603
- export interface DescribeMigrationDetailRequest {
712
+ export interface DescribeSubscribeReturnableRequest {
604
713
  /**
605
- * 数据迁移任务ID
714
+ * 数据订阅实例的ID
606
715
  */
607
- JobId: string;
716
+ SubscribeId: string;
608
717
  }
609
718
  /**
610
- * DestroySyncJob请求参数结构体
719
+ * DescribeMigrationDetail请求参数结构体
611
720
  */
612
- export interface DestroySyncJobRequest {
721
+ export interface DescribeMigrationDetailRequest {
613
722
  /**
614
- * 同步任务id
723
+ * 数据迁移任务ID
615
724
  */
616
725
  JobId: string;
617
726
  }
618
727
  /**
619
- * ResizeSyncJob请求参数结构体
728
+ * CreateConsumerGroup请求参数结构体
620
729
  */
621
- export interface ResizeSyncJobRequest {
730
+ export interface CreateConsumerGroupRequest {
731
+ /**
732
+ * 订阅实例id
733
+ */
734
+ SubscribeId: string;
735
+ /**
736
+ * 消费组名称,以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
737
+ */
738
+ ConsumerGroupName: string;
739
+ /**
740
+ * 账号名称。以数字、字母(大小写)或者_ - .开头,以数字、字母(大小写)结尾。实际生成的账户全称形如:account-#{SubscribeId}-#{AccountName}
741
+ */
742
+ AccountName: string;
743
+ /**
744
+ * 消费组密码,长度必须大于3
745
+ */
746
+ Password: string;
747
+ /**
748
+ * 消费组备注
749
+ */
750
+ Description?: string;
751
+ }
752
+ /**
753
+ * ResizeSyncJob请求参数结构体
754
+ */
755
+ export interface ResizeSyncJobRequest {
622
756
  /**
623
757
  * 同步任务id
624
758
  */
@@ -628,6 +762,15 @@ export interface ResizeSyncJobRequest {
628
762
  */
629
763
  NewInstanceClass: string;
630
764
  }
765
+ /**
766
+ * ModifySubscribeName返回参数结构体
767
+ */
768
+ export interface ModifySubscribeNameResponse {
769
+ /**
770
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
771
+ */
772
+ RequestId?: string;
773
+ }
631
774
  /**
632
775
  * 数据同步中的ddl同步处理
633
776
  */
@@ -663,6 +806,21 @@ export interface ConflictHandleOption {
663
806
  */
664
807
  ConditionOrderInSrcAndDst?: string;
665
808
  }
809
+ /**
810
+ * mongo输出聚合设置。输出默认 Change Event
811
+ */
812
+ export interface PipelineInfo {
813
+ /**
814
+ * 聚合运算符:$addFields、$match、$project、$replaceRoot、$redact、$replaceWith、$set、$unset。其中 $replaceWith、$set、$unset 只有当订阅实例是4.2及以上版本可选。
815
+ 注意:此字段可能返回 null,表示取不到有效值。
816
+ */
817
+ AggOp?: string;
818
+ /**
819
+ * 聚合表达式。必须是json格式
820
+ 注意:此字段可能返回 null,表示取不到有效值。
821
+ */
822
+ AggCmd?: string;
823
+ }
666
824
  /**
667
825
  * ResumeSyncJob返回参数结构体
668
826
  */
@@ -672,6 +830,15 @@ export interface ResumeSyncJobResponse {
672
830
  */
673
831
  RequestId?: string;
674
832
  }
833
+ /**
834
+ * RecoverMigrateJob返回参数结构体
835
+ */
836
+ export interface RecoverMigrateJobResponse {
837
+ /**
838
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
839
+ */
840
+ RequestId?: string;
841
+ }
675
842
  /**
676
843
  * ModifyCompareTaskName返回参数结构体
677
844
  */
@@ -690,6 +857,15 @@ export interface StartSyncJobRequest {
690
857
  */
691
858
  JobId?: string;
692
859
  }
860
+ /**
861
+ * StartSubscribe请求参数结构体
862
+ */
863
+ export interface StartSubscribeRequest {
864
+ /**
865
+ * 数据订阅实例的 ID
866
+ */
867
+ SubscribeId: string;
868
+ }
693
869
  /**
694
870
  * ModifyMigrateRuntimeAttribute返回参数结构体
695
871
  */
@@ -699,6 +875,19 @@ export interface ModifyMigrateRuntimeAttributeResponse {
699
875
  */
700
876
  RequestId?: string;
701
877
  }
878
+ /**
879
+ * DescribeOffsetByTime返回参数结构体
880
+ */
881
+ export interface DescribeOffsetByTimeResponse {
882
+ /**
883
+ * 时间与Offset的对应
884
+ */
885
+ Items?: Array<OffsetTimeMap>;
886
+ /**
887
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
888
+ */
889
+ RequestId?: string;
890
+ }
702
891
  /**
703
892
  * PauseSyncJob请求参数结构体
704
893
  */
@@ -850,6 +1039,24 @@ export interface DescribeCompareTasksRequest {
850
1039
  */
851
1040
  Status?: Array<string>;
852
1041
  }
1042
+ /**
1043
+ * DestroyIsolatedSubscribe请求参数结构体
1044
+ */
1045
+ export interface DestroyIsolatedSubscribeRequest {
1046
+ /**
1047
+ * 数据订阅实例的ID
1048
+ */
1049
+ SubscribeId: string;
1050
+ }
1051
+ /**
1052
+ * ResetSubscribe返回参数结构体
1053
+ */
1054
+ export interface ResetSubscribeResponse {
1055
+ /**
1056
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1057
+ */
1058
+ RequestId?: string;
1059
+ }
853
1060
  /**
854
1061
  * 一致性对比对象配置
855
1062
  */
@@ -871,29 +1078,23 @@ export interface CompareObject {
871
1078
  AdvancedObjects?: Array<string>;
872
1079
  }
873
1080
  /**
874
- * 任务错误信息
1081
+ * DescribeCompareReport返回参数结构体
875
1082
  */
876
- export interface ErrorInfoItem {
877
- /**
878
- * 错误码
879
- 注意:此字段可能返回 null,表示取不到有效值。
880
- */
881
- Code?: string;
1083
+ export interface DescribeCompareReportResponse {
882
1084
  /**
883
- * 解决方案
1085
+ * 一致性校验摘要信息
884
1086
  注意:此字段可能返回 null,表示取不到有效值。
885
1087
  */
886
- Solution?: string;
1088
+ Abstract: CompareAbstractInfo;
887
1089
  /**
888
- * 错误日志信息
1090
+ * 一致性校验详细信息
889
1091
  注意:此字段可能返回 null,表示取不到有效值。
890
1092
  */
891
- ErrorLog?: string;
1093
+ Detail: CompareDetailInfo;
892
1094
  /**
893
- * 文档提示
894
- 注意:此字段可能返回 null,表示取不到有效值。
1095
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
895
1096
  */
896
- HelpDoc?: string;
1097
+ RequestId?: string;
897
1098
  }
898
1099
  /**
899
1100
  * RecoverSyncJob返回参数结构体
@@ -919,6 +1120,83 @@ export interface MigrateAction {
919
1120
  */
920
1121
  AllowedAction: Array<string>;
921
1122
  }
1123
+ /**
1124
+ * ConfigureSubscribeJob返回参数结构体
1125
+ */
1126
+ export interface ConfigureSubscribeJobResponse {
1127
+ /**
1128
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1129
+ */
1130
+ RequestId?: string;
1131
+ }
1132
+ /**
1133
+ * DescribeConsumerGroups请求参数结构体
1134
+ */
1135
+ export interface DescribeConsumerGroupsRequest {
1136
+ /**
1137
+ * 订阅实例id
1138
+ */
1139
+ SubscribeId: string;
1140
+ /**
1141
+ * 返回记录的起始偏移量。默认0
1142
+ */
1143
+ Offset?: number;
1144
+ /**
1145
+ * 单次返回的记录数量。默认10
1146
+ */
1147
+ Limit?: number;
1148
+ }
1149
+ /**
1150
+ * kafka消费者组详情
1151
+ */
1152
+ export interface GroupInfo {
1153
+ /**
1154
+ * 消费者组账号
1155
+ */
1156
+ Account: string;
1157
+ /**
1158
+ * 消费者组名称
1159
+ */
1160
+ ConsumerGroupName: string;
1161
+ /**
1162
+ * 消费者组备注
1163
+ 注意:此字段可能返回 null,表示取不到有效值。
1164
+ */
1165
+ Description: string;
1166
+ /**
1167
+ * 消费组偏移量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区的偏移量。各分区的偏移量详见StateOfPartition字段
1168
+ */
1169
+ ConsumerGroupOffset: number;
1170
+ /**
1171
+ * 消费组未消费的数据量。该字段是为了兼容以前单Partition的情况,取值为最后一个分区未消费的数据量。各分区未消费数据量详见StateOfPartition字段
1172
+ */
1173
+ ConsumerGroupLag: number;
1174
+ /**
1175
+ * 消费延迟(单位为秒)
1176
+ */
1177
+ Latency: number;
1178
+ /**
1179
+ * 各分区的消费状态
1180
+ */
1181
+ StateOfPartition: Array<MonitorInfo>;
1182
+ /**
1183
+ * 消费者组创建时间,格式为YYYY-MM-DD hh:mm:ss
1184
+ */
1185
+ CreatedAt: string;
1186
+ /**
1187
+ * 消费者组修改时间,格式为YYYY-MM-DD hh:mm:ss
1188
+ */
1189
+ UpdatedAt: string;
1190
+ /**
1191
+ * 消费者组状态,包括Dead、Empty、Stable等,只有Dead和Empty两种状态可以执行reset操作
1192
+ */
1193
+ ConsumerGroupState: string;
1194
+ /**
1195
+ * 每个消费者正在消费的分区
1196
+ 注意:此字段可能返回 null,表示取不到有效值。
1197
+ */
1198
+ PartitionAssignment: Array<PartitionAssignment>;
1199
+ }
922
1200
  /**
923
1201
  * DeleteCompareTask返回参数结构体
924
1202
  */
@@ -975,215 +1253,438 @@ export interface DBEndpointInfo {
975
1253
  DatabaseNetEnv?: string;
976
1254
  }
977
1255
  /**
978
- * 列选项
1256
+ * ResumeSubscribe请求参数结构体
979
1257
  */
980
- export interface CompareColumnItem {
1258
+ export interface ResumeSubscribeRequest {
981
1259
  /**
982
- * 列名
983
- 注意:此字段可能返回 null,表示取不到有效值。
1260
+ * 数据订阅实例的 ID
984
1261
  */
985
- ColumnName?: string;
1262
+ SubscribeId: string;
986
1263
  }
987
1264
  /**
988
- * ContinueSyncJob返回参数结构体
1265
+ * ModifySyncJobConfig返回参数结构体
989
1266
  */
990
- export interface ContinueSyncJobResponse {
1267
+ export interface ModifySyncJobConfigResponse {
991
1268
  /**
992
1269
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
993
1270
  */
994
1271
  RequestId?: string;
995
1272
  }
996
1273
  /**
997
- * 数据同步中的选项
1274
+ * 列选项
998
1275
  */
999
- export interface Options {
1276
+ export interface CompareColumnItem {
1000
1277
  /**
1001
- * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
1278
+ * 列名
1002
1279
  注意:此字段可能返回 null,表示取不到有效值。
1003
1280
  */
1004
- InitType?: string;
1281
+ ColumnName?: string;
1282
+ }
1283
+ /**
1284
+ * DescribeSubscribeDetail返回参数结构体
1285
+ */
1286
+ export interface DescribeSubscribeDetailResponse {
1005
1287
  /**
1006
- * 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、InitializeAfterDelete(删除并重新初始化)、ExecuteAfterIgnore(忽略并继续执行)
1007
- 注意:此字段可能返回 null,表示取不到有效值。
1288
+ * 数据订阅的ID,形如subs-b6x64o31tm
1008
1289
  */
1009
- DealOfExistSameTable?: string;
1290
+ SubscribeId?: string;
1010
1291
  /**
1011
- * 冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
1012
- 注意:此字段可能返回 null,表示取不到有效值。
1292
+ * 数据订阅实例的名称
1013
1293
  */
1014
- ConflictHandleType?: string;
1294
+ SubscribeName?: string;
1015
1295
  /**
1016
- * 是否添加附加列
1017
- 注意:此字段可能返回 null,表示取不到有效值。
1296
+ * 订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)
1018
1297
  */
1019
- AddAdditionalColumn?: boolean;
1298
+ Product?: string;
1020
1299
  /**
1021
- * 所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), 不填(不选),PartialDDL(自定义,和DdlOptions一起起作用 )
1300
+ * 订阅的云数据库实例ID,只有订阅云数据库该值才有意义
1022
1301
  注意:此字段可能返回 null,表示取不到有效值。
1023
1302
  */
1024
- OpTypes?: Array<string>;
1303
+ InstanceId?: string;
1025
1304
  /**
1026
- * 冲突处理的详细选项,如条件覆盖中的条件行和条件操作
1305
+ * 订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline
1027
1306
  注意:此字段可能返回 null,表示取不到有效值。
1028
1307
  */
1029
- ConflictHandleOption?: ConflictHandleOption;
1308
+ InstanceStatus?: string;
1030
1309
  /**
1031
- * DDL同步选项,具体描述要同步那些DDL
1032
- 注意:此字段可能返回 null,表示取不到有效值。
1310
+ * 订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng
1033
1311
  */
1034
- DdlOptions?: Array<DdlOption>;
1312
+ Status?: string;
1035
1313
  /**
1036
- * kafka同步选项
1037
- 注意:此字段可能返回 null,表示取不到有效值。
1314
+ * 订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error
1038
1315
  */
1039
- KafkaOption?: KafkaOption;
1316
+ SubsStatus?: string;
1040
1317
  /**
1041
- * 任务限速信息
1318
+ * 修改时间,时间格式如:Y-m-d h:m:s
1042
1319
  注意:此字段可能返回 null,表示取不到有效值。
1043
1320
  */
1044
- RateLimitOption?: RateLimitOption;
1321
+ ModifyTime?: string;
1045
1322
  /**
1046
- * 自动重试的时间窗口设置
1323
+ * 创建时间,时间格式如:Y-m-d h:m:s
1047
1324
  注意:此字段可能返回 null,表示取不到有效值。
1048
1325
  */
1049
- AutoRetryTimeRangeMinutes?: number;
1050
- }
1051
- /**
1052
- * CompleteMigrateJob请求参数结构体
1053
- */
1054
- export interface CompleteMigrateJobRequest {
1326
+ CreateTime?: string;
1055
1327
  /**
1056
- * 数据迁移任务ID
1328
+ * 隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1329
+ 注意:此字段可能返回 null,表示取不到有效值。
1057
1330
  */
1058
- JobId: string;
1331
+ IsolateTime?: string;
1059
1332
  /**
1060
- * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
1333
+ * 包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1334
+ 注意:此字段可能返回 null,表示取不到有效值。
1061
1335
  */
1062
- CompleteMode?: string;
1063
- }
1064
- /**
1065
- * DescribeCompareTasks返回参数结构体
1066
- */
1067
- export interface DescribeCompareTasksResponse {
1336
+ ExpireTime?: string;
1068
1337
  /**
1069
- * 数量
1338
+ * 下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
1070
1339
  注意:此字段可能返回 null,表示取不到有效值。
1071
1340
  */
1072
- TotalCount?: number;
1341
+ OfflineTime?: string;
1073
1342
  /**
1074
- * 一致性校验列表
1075
- 注意:此字段可能返回 null,表示取不到有效值。
1343
+ * 付费方式,可能值为:0-包年包月,1-按量计费
1076
1344
  */
1077
- Items?: Array<CompareTaskItem>;
1345
+ PayType?: number;
1078
1346
  /**
1079
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1347
+ * 自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
1080
1348
  */
1081
- RequestId?: string;
1082
- }
1083
- /**
1084
- * StopCompare请求参数结构体
1085
- */
1086
- export interface StopCompareRequest {
1349
+ AutoRenewFlag?: number;
1087
1350
  /**
1088
- * 迁移任务 Id
1351
+ * 任务所在地域
1089
1352
  */
1090
- JobId: string;
1353
+ Region?: string;
1091
1354
  /**
1092
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1355
+ * Kafka topic
1356
+ 注意:此字段可能返回 null,表示取不到有效值。
1093
1357
  */
1094
- CompareTaskId: string;
1095
- }
1096
- /**
1097
- * 数据同步配置多节点数据库的节点信息。多节点数据库,如tdsqlmysql使用该结构;单节点数据库,如mysql使用Endpoint。
1098
- */
1099
- export interface SyncDBEndpointInfos {
1358
+ Topic?: string;
1100
1359
  /**
1101
- * 数据库所在地域
1360
+ * Kafka服务Broker地址
1102
1361
  注意:此字段可能返回 null,表示取不到有效值。
1103
1362
  */
1104
- Region: string;
1363
+ Broker?: string;
1105
1364
  /**
1106
- * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1365
+ * 数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合
1107
1366
  注意:此字段可能返回 null,表示取不到有效值。
1108
1367
  */
1109
- AccessType: string;
1368
+ SubscribeMode?: string;
1110
1369
  /**
1111
- * 实例数据库类型,如:mysql,redis,mongodb,postgresql,mariadb,percona
1370
+ * 订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档
1112
1371
  注意:此字段可能返回 null,表示取不到有效值。
1113
1372
  */
1114
- DatabaseType: string;
1373
+ Protocol?: string;
1115
1374
  /**
1116
- * 数据库信息。注意:如果数据类型为tdsqlmysql,此处Endpoint数组的顺序应该与set顺序对应,第一个分片(shardkey范围起始为0的分片)必须要输入在第一个位置
1375
+ * 订阅的数据库表信息
1117
1376
  注意:此字段可能返回 null,表示取不到有效值。
1118
1377
  */
1119
- Info: Array<Endpoint>;
1120
- }
1121
- /**
1122
- * StartModifySyncJob请求参数结构体
1123
- */
1124
- export interface StartModifySyncJobRequest {
1378
+ SubscribeObjects?: Array<SubscribeObject>;
1125
1379
  /**
1126
- * 同步任务id
1380
+ * kafka配置信息
1381
+ 注意:此字段可能返回 null,表示取不到有效值。
1127
1382
  */
1128
- JobId: string;
1129
- }
1130
- /**
1131
- * DescribeCheckSyncJobResult返回参数结构体
1132
- */
1133
- export interface DescribeCheckSyncJobResultResponse {
1383
+ KafkaConfig?: SubscribeKafkaConfig;
1134
1384
  /**
1135
- * 校验任务执行状态,如:notStarted(未开始)、running(校验中)、failed(校验任务失败)、success(任务成功)
1385
+ * 源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云主机自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
1136
1386
  注意:此字段可能返回 null,表示取不到有效值。
1137
1387
  */
1138
- Status?: string;
1388
+ AccessType?: string;
1139
1389
  /**
1140
- * 步骤总数
1390
+ * 接入类型信息
1141
1391
  注意:此字段可能返回 null,表示取不到有效值。
1142
1392
  */
1143
- StepCount?: number;
1393
+ Endpoints?: Array<EndpointItem>;
1144
1394
  /**
1145
- * 当前所在步骤
1395
+ * mongo输出聚合设置
1146
1396
  注意:此字段可能返回 null,表示取不到有效值。
1147
1397
  */
1148
- StepCur?: number;
1398
+ PipelineInfo?: Array<PipelineInfo>;
1149
1399
  /**
1150
- * 总体进度,范围为[0,100]
1400
+ * 标签
1151
1401
  注意:此字段可能返回 null,表示取不到有效值。
1152
1402
  */
1153
- Progress?: number;
1403
+ Tags?: Array<TagItem>;
1154
1404
  /**
1155
- * 步骤信息
1405
+ * 订阅任务报错信息
1156
1406
  注意:此字段可能返回 null,表示取不到有效值。
1157
1407
  */
1158
- StepInfos?: Array<StepInfo>;
1408
+ Errors?: Array<SubsErr>;
1159
1409
  /**
1160
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
1410
+ * 为业务添加的额外信息。参数名作key,参数值作value
1411
+ mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。
1412
+ mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。
1413
+ 注意:此字段可能返回 null,表示取不到有效值。
1414
+ */
1415
+ ExtraAttr?: Array<KeyValuePairOption>;
1416
+ /**
1417
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1161
1418
  */
1162
1419
  RequestId?: string;
1163
1420
  }
1164
1421
  /**
1165
- * StopSyncJob返回参数结构体
1422
+ * ContinueSyncJob返回参数结构体
1166
1423
  */
1167
- export interface StopSyncJobResponse {
1424
+ export interface ContinueSyncJobResponse {
1168
1425
  /**
1169
1426
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1170
1427
  */
1171
1428
  RequestId?: string;
1172
1429
  }
1173
1430
  /**
1174
- * 跳过校验的表详情
1431
+ * 计费状态信息
1175
1432
  */
1176
- export interface SkippedDetail {
1433
+ export interface TradeInfo {
1177
1434
  /**
1178
- * 跳过的表数量
1435
+ * 交易订单号
1179
1436
  注意:此字段可能返回 null,表示取不到有效值。
1180
1437
  */
1181
- TotalCount: number;
1438
+ DealName?: string;
1182
1439
  /**
1183
- * 跳过校验的表详情
1440
+ * 上一次交易订单号
1184
1441
  注意:此字段可能返回 null,表示取不到有效值。
1185
1442
  */
1186
- Items: Array<SkippedItem>;
1443
+ LastDealName?: string;
1444
+ /**
1445
+ * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
1446
+ 注意:此字段可能返回 null,表示取不到有效值。
1447
+ */
1448
+ InstanceClass?: string;
1449
+ /**
1450
+ * 计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
1451
+ 注意:此字段可能返回 null,表示取不到有效值。
1452
+ */
1453
+ TradeStatus?: string;
1454
+ /**
1455
+ * 到期时间,格式为"yyyy-mm-dd hh:mm:ss"
1456
+ 注意:此字段可能返回 null,表示取不到有效值。
1457
+ */
1458
+ ExpireTime?: string;
1459
+ /**
1460
+ * 下线时间,格式为"yyyy-mm-dd hh:mm:ss"
1461
+ 注意:此字段可能返回 null,表示取不到有效值。
1462
+ */
1463
+ OfflineTime?: string;
1464
+ /**
1465
+ * 隔离时间,格式为"yyyy-mm-dd hh:mm:ss"
1466
+ 注意:此字段可能返回 null,表示取不到有效值。
1467
+ */
1468
+ IsolateTime?: string;
1469
+ /**
1470
+ * 下线原因
1471
+ 注意:此字段可能返回 null,表示取不到有效值。
1472
+ */
1473
+ OfflineReason?: string;
1474
+ /**
1475
+ * 隔离原因
1476
+ 注意:此字段可能返回 null,表示取不到有效值。
1477
+ */
1478
+ IsolateReason?: string;
1479
+ /**
1480
+ * 付费类型,包括:postpay(后付费)、prepay(预付费)
1481
+ 注意:此字段可能返回 null,表示取不到有效值。
1482
+ */
1483
+ PayType?: string;
1484
+ /**
1485
+ * 任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
1486
+ 注意:此字段可能返回 null,表示取不到有效值。
1487
+ */
1488
+ BillingType?: string;
1489
+ }
1490
+ /**
1491
+ * 数据同步中的选项
1492
+ */
1493
+ export interface Options {
1494
+ /**
1495
+ * 同步初始化选项,Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化,默认)、None(仅增量)
1496
+ 注意:此字段可能返回 null,表示取不到有效值。
1497
+ */
1498
+ InitType?: string;
1499
+ /**
1500
+ * 同名表的处理,ReportErrorAfterCheck(前置校验并报错,默认)、InitializeAfterDelete(删除并重新初始化)、ExecuteAfterIgnore(忽略并继续执行)
1501
+ 注意:此字段可能返回 null,表示取不到有效值。
1502
+ */
1503
+ DealOfExistSameTable?: string;
1504
+ /**
1505
+ * 冲突处理选项,ReportError(报错,默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
1506
+ 注意:此字段可能返回 null,表示取不到有效值。
1507
+ */
1508
+ ConflictHandleType?: string;
1509
+ /**
1510
+ * 是否添加附加列
1511
+ 注意:此字段可能返回 null,表示取不到有效值。
1512
+ */
1513
+ AddAdditionalColumn?: boolean;
1514
+ /**
1515
+ * 所要同步的DML和DDL的选项,Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步), 不填(不选),PartialDDL(自定义,和DdlOptions一起起作用 )
1516
+ 注意:此字段可能返回 null,表示取不到有效值。
1517
+ */
1518
+ OpTypes?: Array<string>;
1519
+ /**
1520
+ * 冲突处理的详细选项,如条件覆盖中的条件行和条件操作
1521
+ 注意:此字段可能返回 null,表示取不到有效值。
1522
+ */
1523
+ ConflictHandleOption?: ConflictHandleOption;
1524
+ /**
1525
+ * DDL同步选项,具体描述要同步那些DDL
1526
+ 注意:此字段可能返回 null,表示取不到有效值。
1527
+ */
1528
+ DdlOptions?: Array<DdlOption>;
1529
+ /**
1530
+ * kafka同步选项
1531
+ 注意:此字段可能返回 null,表示取不到有效值。
1532
+ */
1533
+ KafkaOption?: KafkaOption;
1534
+ /**
1535
+ * 任务限速信息
1536
+ 注意:此字段可能返回 null,表示取不到有效值。
1537
+ */
1538
+ RateLimitOption?: RateLimitOption;
1539
+ /**
1540
+ * 自动重试的时间窗口设置
1541
+ 注意:此字段可能返回 null,表示取不到有效值。
1542
+ */
1543
+ AutoRetryTimeRangeMinutes?: number;
1544
+ }
1545
+ /**
1546
+ * DeleteConsumerGroup请求参数结构体
1547
+ */
1548
+ export interface DeleteConsumerGroupRequest {
1549
+ /**
1550
+ * 数据订阅实例的 ID
1551
+ */
1552
+ SubscribeId: string;
1553
+ /**
1554
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
1555
+ 请务必保证消费组名称正确。
1556
+ */
1557
+ ConsumerGroupName: string;
1558
+ /**
1559
+ * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
1560
+ 请务必保证账户名称正确。
1561
+ */
1562
+ AccountName: string;
1563
+ }
1564
+ /**
1565
+ * ModifySubscribeAutoRenewFlag请求参数结构体
1566
+ */
1567
+ export interface ModifySubscribeAutoRenewFlagRequest {
1568
+ /**
1569
+ * 订阅实例ID
1570
+ */
1571
+ SubscribeId: string;
1572
+ /**
1573
+ * 自动续费标识。1-自动续费,0-不自动续费
1574
+ */
1575
+ AutoRenewFlag: number;
1576
+ }
1577
+ /**
1578
+ * CompleteMigrateJob请求参数结构体
1579
+ */
1580
+ export interface CompleteMigrateJobRequest {
1581
+ /**
1582
+ * 数据迁移任务ID
1583
+ */
1584
+ JobId: string;
1585
+ /**
1586
+ * 完成任务的方式,仅支持旧版MySQL迁移任务。waitForSync-等待主从差距为0才停止,immediately-立即完成,不会等待主从差距一致。默认为waitForSync
1587
+ */
1588
+ CompleteMode?: string;
1589
+ }
1590
+ /**
1591
+ * CreateConsumerGroup返回参数结构体
1592
+ */
1593
+ export interface CreateConsumerGroupResponse {
1594
+ /**
1595
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1596
+ */
1597
+ RequestId?: string;
1598
+ }
1599
+ /**
1600
+ * StopCompare请求参数结构体
1601
+ */
1602
+ export interface StopCompareRequest {
1603
+ /**
1604
+ * 迁移任务 Id
1605
+ */
1606
+ JobId: string;
1607
+ /**
1608
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
1609
+ */
1610
+ CompareTaskId: string;
1611
+ }
1612
+ /**
1613
+ * 数据同步配置多节点数据库的节点信息。多节点数据库,如tdsqlmysql使用该结构;单节点数据库,如mysql使用Endpoint。
1614
+ */
1615
+ export interface SyncDBEndpointInfos {
1616
+ /**
1617
+ * 数据库所在地域
1618
+ 注意:此字段可能返回 null,表示取不到有效值。
1619
+ */
1620
+ Region: string;
1621
+ /**
1622
+ * 实例网络接入类型,如:extranet(外网)、ipv6(公网ipv6)、cvm(云主机自建)、dcg(专线接入)、vpncloud(vpn接入的实例)、cdb(云数据库)、ccn(云联网)、intranet(自研上云)、vpc(私有网络)等,注意具体可选值依赖当前链路
1623
+ 注意:此字段可能返回 null,表示取不到有效值。
1624
+ */
1625
+ AccessType: string;
1626
+ /**
1627
+ * 实例数据库类型,如:mysql,redis,mongodb,postgresql,mariadb,percona 等
1628
+ 注意:此字段可能返回 null,表示取不到有效值。
1629
+ */
1630
+ DatabaseType: string;
1631
+ /**
1632
+ * 数据库信息。注意:如果数据类型为tdsqlmysql,此处Endpoint数组的顺序应该与set顺序对应,第一个分片(shardkey范围起始为0的分片)必须要输入在第一个位置
1633
+ 注意:此字段可能返回 null,表示取不到有效值。
1634
+ */
1635
+ Info: Array<Endpoint>;
1636
+ }
1637
+ /**
1638
+ * StartModifySyncJob请求参数结构体
1639
+ */
1640
+ export interface StartModifySyncJobRequest {
1641
+ /**
1642
+ * 同步任务id
1643
+ */
1644
+ JobId: string;
1645
+ }
1646
+ /**
1647
+ * DescribeCheckSyncJobResult返回参数结构体
1648
+ */
1649
+ export interface DescribeCheckSyncJobResultResponse {
1650
+ /**
1651
+ * 校验任务执行状态,如:notStarted(未开始)、running(校验中)、failed(校验任务失败)、success(任务成功)
1652
+ 注意:此字段可能返回 null,表示取不到有效值。
1653
+ */
1654
+ Status?: string;
1655
+ /**
1656
+ * 步骤总数
1657
+ 注意:此字段可能返回 null,表示取不到有效值。
1658
+ */
1659
+ StepCount?: number;
1660
+ /**
1661
+ * 当前所在步骤
1662
+ 注意:此字段可能返回 null,表示取不到有效值。
1663
+ */
1664
+ StepCur?: number;
1665
+ /**
1666
+ * 总体进度,范围为[0,100]
1667
+ 注意:此字段可能返回 null,表示取不到有效值。
1668
+ */
1669
+ Progress?: number;
1670
+ /**
1671
+ * 步骤信息
1672
+ 注意:此字段可能返回 null,表示取不到有效值。
1673
+ */
1674
+ StepInfos?: Array<StepInfo>;
1675
+ /**
1676
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1677
+ */
1678
+ RequestId?: string;
1679
+ }
1680
+ /**
1681
+ * StopSyncJob返回参数结构体
1682
+ */
1683
+ export interface StopSyncJobResponse {
1684
+ /**
1685
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1686
+ */
1687
+ RequestId?: string;
1187
1688
  }
1188
1689
  /**
1189
1690
  * 迁移选项,描述任务如何执行迁移等一系列配置信息
@@ -1226,6 +1727,73 @@ export interface MigrateOption {
1226
1727
  */
1227
1728
  ExtraAttr?: Array<KeyValuePairOption>;
1228
1729
  }
1730
+ /**
1731
+ * DescribeSubscribeDetail请求参数结构体
1732
+ */
1733
+ export interface DescribeSubscribeDetailRequest {
1734
+ /**
1735
+ * 订阅实例ID
1736
+ */
1737
+ SubscribeId: string;
1738
+ }
1739
+ /**
1740
+ * 跳过校验的表详情
1741
+ */
1742
+ export interface SkippedDetail {
1743
+ /**
1744
+ * 跳过的表数量
1745
+ 注意:此字段可能返回 null,表示取不到有效值。
1746
+ */
1747
+ TotalCount: number;
1748
+ /**
1749
+ * 跳过校验的表详情
1750
+ 注意:此字段可能返回 null,表示取不到有效值。
1751
+ */
1752
+ Items: Array<SkippedItem>;
1753
+ }
1754
+ /**
1755
+ * 订阅报错信息
1756
+ */
1757
+ export interface SubsErr {
1758
+ /**
1759
+ * 报错信息
1760
+ */
1761
+ Message?: string;
1762
+ }
1763
+ /**
1764
+ * CreateSubscribe返回参数结构体
1765
+ */
1766
+ export interface CreateSubscribeResponse {
1767
+ /**
1768
+ * 数据订阅实例的ID数组
1769
+ 注意:此字段可能返回 null,表示取不到有效值。
1770
+ */
1771
+ SubscribeIds?: Array<string>;
1772
+ /**
1773
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1774
+ */
1775
+ RequestId?: string;
1776
+ }
1777
+ /**
1778
+ * 一致性校验选项
1779
+ */
1780
+ export interface CompareOptions {
1781
+ /**
1782
+ * 对比方式:dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比)
1783
+ 注意:此字段可能返回 null,表示取不到有效值。
1784
+ */
1785
+ Method?: string;
1786
+ /**
1787
+ * 抽样比例;范围0,100
1788
+ 注意:此字段可能返回 null,表示取不到有效值。
1789
+ */
1790
+ SampleRate?: number;
1791
+ /**
1792
+ * 线程数,取值1-5,默认为1
1793
+ 注意:此字段可能返回 null,表示取不到有效值。
1794
+ */
1795
+ ThreadCount?: number;
1796
+ }
1229
1797
  /**
1230
1798
  * ModifyMigrateName返回参数结构体
1231
1799
  */
@@ -1397,6 +1965,15 @@ export interface CreateMigrateCheckJobRequest {
1397
1965
  */
1398
1966
  JobId: string;
1399
1967
  }
1968
+ /**
1969
+ * ModifyConsumerGroupPassword返回参数结构体
1970
+ */
1971
+ export interface ModifyConsumerGroupPasswordResponse {
1972
+ /**
1973
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1974
+ */
1975
+ RequestId?: string;
1976
+ }
1400
1977
  /**
1401
1978
  * DescribeMigrationJobs请求参数结构体
1402
1979
  */
@@ -1481,6 +2058,29 @@ export interface CompareTaskInfo {
1481
2058
  */
1482
2059
  Status: string;
1483
2060
  }
2061
+ /**
2062
+ * ModifyConsumerGroupDescription请求参数结构体
2063
+ */
2064
+ export interface ModifyConsumerGroupDescriptionRequest {
2065
+ /**
2066
+ * 数据订阅实例的 ID
2067
+ */
2068
+ SubscribeId: string;
2069
+ /**
2070
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
2071
+ 请务必保证消费组名称正确。
2072
+ */
2073
+ ConsumerGroupName: string;
2074
+ /**
2075
+ * 账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
2076
+ 请务必保证账户名称正确。
2077
+ */
2078
+ AccountName: string;
2079
+ /**
2080
+ * 修改之后的消费组描述
2081
+ */
2082
+ Description: string;
2083
+ }
1484
2084
  /**
1485
2085
  * ContinueSyncJob请求参数结构体
1486
2086
  */
@@ -1490,6 +2090,15 @@ export interface ContinueSyncJobRequest {
1490
2090
  */
1491
2091
  JobId: string;
1492
2092
  }
2093
+ /**
2094
+ * ModifySubscribeObjects返回参数结构体
2095
+ */
2096
+ export interface ModifySubscribeObjectsResponse {
2097
+ /**
2098
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2099
+ */
2100
+ RequestId?: string;
2101
+ }
1493
2102
  /**
1494
2103
  * CreateMigrationService返回参数结构体
1495
2104
  */
@@ -1549,9 +2158,33 @@ export interface DescribeMigrationCheckJobResponse {
1549
2158
  */
1550
2159
  CheckFlag: string;
1551
2160
  /**
1552
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2161
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2162
+ */
2163
+ RequestId?: string;
2164
+ }
2165
+ /**
2166
+ * StopSyncJob请求参数结构体
2167
+ */
2168
+ export interface StopSyncJobRequest {
2169
+ /**
2170
+ * 同步任务id
2171
+ */
2172
+ JobId: string;
2173
+ }
2174
+ /**
2175
+ * 数据不一致的表详情
2176
+ */
2177
+ export interface DifferenceDetail {
2178
+ /**
2179
+ * 数据不一致的表数量
2180
+ 注意:此字段可能返回 null,表示取不到有效值。
2181
+ */
2182
+ TotalCount: number;
2183
+ /**
2184
+ * 校验不一致的表详情
2185
+ 注意:此字段可能返回 null,表示取不到有效值。
1553
2186
  */
1554
- RequestId?: string;
2187
+ Items: Array<DifferenceItem>;
1555
2188
  }
1556
2189
  /**
1557
2190
  * 数据库信息
@@ -1688,19 +2321,28 @@ export interface TopicRule {
1688
2321
  TableName?: string;
1689
2322
  }
1690
2323
  /**
1691
- * 数据不一致的表详情
2324
+ * DestroySyncJob请求参数结构体
1692
2325
  */
1693
- export interface DifferenceDetail {
2326
+ export interface DestroySyncJobRequest {
1694
2327
  /**
1695
- * 数据不一致的表数量
2328
+ * 同步任务id
2329
+ */
2330
+ JobId: string;
2331
+ }
2332
+ /**
2333
+ * 视图对象
2334
+ */
2335
+ export interface ViewItem {
2336
+ /**
2337
+ * 视图名称
1696
2338
  注意:此字段可能返回 null,表示取不到有效值。
1697
2339
  */
1698
- TotalCount: number;
2340
+ ViewName?: string;
1699
2341
  /**
1700
- * 校验不一致的表详情
2342
+ * 迁移后的视图名称
1701
2343
  注意:此字段可能返回 null,表示取不到有效值。
1702
2344
  */
1703
- Items: Array<DifferenceItem>;
2345
+ NewViewName?: string;
1704
2346
  }
1705
2347
  /**
1706
2348
  * CreateCheckSyncJob返回参数结构体
@@ -1711,6 +2353,24 @@ export interface CreateCheckSyncJobResponse {
1711
2353
  */
1712
2354
  RequestId?: string;
1713
2355
  }
2356
+ /**
2357
+ * CreateSubscribeCheckJob返回参数结构体
2358
+ */
2359
+ export interface CreateSubscribeCheckJobResponse {
2360
+ /**
2361
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2362
+ */
2363
+ RequestId?: string;
2364
+ }
2365
+ /**
2366
+ * ModifyConsumerGroupDescription返回参数结构体
2367
+ */
2368
+ export interface ModifyConsumerGroupDescriptionResponse {
2369
+ /**
2370
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2371
+ */
2372
+ RequestId?: string;
2373
+ }
1714
2374
  /**
1715
2375
  * 一致性校验库表对象
1716
2376
  */
@@ -1829,6 +2489,46 @@ export interface StartModifySyncJobResponse {
1829
2489
  */
1830
2490
  RequestId?: string;
1831
2491
  }
2492
+ /**
2493
+ * 订阅校验任务的各步骤信息。
2494
+ */
2495
+ export interface SubscribeCheckStepInfo {
2496
+ /**
2497
+ * 步骤名称
2498
+ 注意:此字段可能返回 null,表示取不到有效值。
2499
+ */
2500
+ StepName?: string;
2501
+ /**
2502
+ * 步骤Id
2503
+ 注意:此字段可能返回 null,表示取不到有效值。
2504
+ */
2505
+ StepId?: string;
2506
+ /**
2507
+ * 步骤编号,从 1 开始
2508
+ 注意:此字段可能返回 null,表示取不到有效值。
2509
+ */
2510
+ StepNo?: number;
2511
+ /**
2512
+ * 当前步骤状态,可能值为 notStarted,running,finished,failed
2513
+ 注意:此字段可能返回 null,表示取不到有效值。
2514
+ */
2515
+ Status?: string;
2516
+ /**
2517
+ * 当前步骤进度
2518
+ 注意:此字段可能返回 null,表示取不到有效值。
2519
+ */
2520
+ Percent?: number;
2521
+ /**
2522
+ * 错误提示
2523
+ 注意:此字段可能返回 null,表示取不到有效值。
2524
+ */
2525
+ Errors?: Array<SubscribeCheckStepTip>;
2526
+ /**
2527
+ * 告警提示
2528
+ 注意:此字段可能返回 null,表示取不到有效值。
2529
+ */
2530
+ Warnings?: Array<SubscribeCheckStepTip>;
2531
+ }
1832
2532
  /**
1833
2533
  * 查询迁移实例列表的实例对象
1834
2534
  */
@@ -2188,6 +2888,64 @@ export interface JobItem {
2188
2888
  */
2189
2889
  DumperResumeCtrl?: string;
2190
2890
  }
2891
+ /**
2892
+ * DestroyIsolatedSubscribe返回参数结构体
2893
+ */
2894
+ export interface DestroyIsolatedSubscribeResponse {
2895
+ /**
2896
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2897
+ */
2898
+ RequestId?: string;
2899
+ }
2900
+ /**
2901
+ * 数据数据订阅的对象,用于修改订阅对象接口。与SubscribeObject结构类似,只是类型和参数名不同。
2902
+ */
2903
+ export interface ModifiedSubscribeObject {
2904
+ /**
2905
+ * 订阅对象的类型,枚举值为:0-库,1-表(该值对于mongo任务来说,是集合) 。
2906
+ 注意:mongo只支持全实例、单库或者单集合订阅,因此该字段不要与SubscribeObjectType冲突。如:SubscribeObjectType=4,表示mongo单库订阅,那么该字段应该传0。
2907
+ 注意:此字段可能返回 null,表示取不到有效值。
2908
+ */
2909
+ ObjectsType: number;
2910
+ /**
2911
+ * 订阅数据库的名称
2912
+ 注意:此字段可能返回 null,表示取不到有效值。
2913
+ */
2914
+ DatabaseName: string;
2915
+ /**
2916
+ * 订阅数据库中表(或集合)的名称。如果 ObjectsType 为 1,那么此字段为必填,且不为空;
2917
+ 注意:此字段可能返回 null,表示取不到有效值。
2918
+ */
2919
+ TableNames?: Array<string>;
2920
+ }
2921
+ /**
2922
+ * DescribeCompareTasks返回参数结构体
2923
+ */
2924
+ export interface DescribeCompareTasksResponse {
2925
+ /**
2926
+ * 数量
2927
+ 注意:此字段可能返回 null,表示取不到有效值。
2928
+ */
2929
+ TotalCount?: number;
2930
+ /**
2931
+ * 一致性校验列表
2932
+ 注意:此字段可能返回 null,表示取不到有效值。
2933
+ */
2934
+ Items?: Array<CompareTaskItem>;
2935
+ /**
2936
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2937
+ */
2938
+ RequestId?: string;
2939
+ }
2940
+ /**
2941
+ * ResumeSubscribe返回参数结构体
2942
+ */
2943
+ export interface ResumeSubscribeResponse {
2944
+ /**
2945
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2946
+ */
2947
+ RequestId?: string;
2948
+ }
2191
2949
  /**
2192
2950
  * DescribeSyncJobs请求参数结构体
2193
2951
  */
@@ -2293,13 +3051,21 @@ export interface SyncDetailInfo {
2293
3051
  ErrInfo?: ErrInfo;
2294
3052
  }
2295
3053
  /**
2296
- * ResumeSyncJob请求参数结构体
3054
+ * DescribeConsumerGroups返回参数结构体
2297
3055
  */
2298
- export interface ResumeSyncJobRequest {
3056
+ export interface DescribeConsumerGroupsResponse {
2299
3057
  /**
2300
- * 同步任务id
3058
+ * 指定实例下的消费者组总数
2301
3059
  */
2302
- JobId: string;
3060
+ TotalCount?: number;
3061
+ /**
3062
+ * 消费者组列表
3063
+ */
3064
+ Items?: Array<GroupInfo>;
3065
+ /**
3066
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3067
+ */
3068
+ RequestId?: string;
2303
3069
  }
2304
3070
  /**
2305
3071
  * ModifyMigrateRateLimit请求参数结构体
@@ -2414,6 +3180,26 @@ export interface StepInfo {
2414
3180
  */
2415
3181
  Progress?: number;
2416
3182
  }
3183
+ /**
3184
+ * 订阅的的数据库表信息,用于配置和查询订阅任务接口。
3185
+ */
3186
+ export interface SubscribeObject {
3187
+ /**
3188
+ * 订阅数据的类型,枚举值:database-数据库,table-数据库的表(如果 DatabaseType 为 mongodb,则表示集合)
3189
+ 注意:此字段可能返回 null,表示取不到有效值。
3190
+ */
3191
+ ObjectType: string;
3192
+ /**
3193
+ * 订阅的数据库名称
3194
+ 注意:此字段可能返回 null,表示取不到有效值。
3195
+ */
3196
+ Database: string;
3197
+ /**
3198
+ * 订阅数据库中表的名称。如果 DatabaseType 为 mongodb,填集合名。mongodb只支持订阅单库或者单集合。
3199
+ 注意:此字段可能返回 null,表示取不到有效值。
3200
+ */
3201
+ Tables?: Array<string>;
3202
+ }
2417
3203
  /**
2418
3204
  * ResumeMigrateJob请求参数结构体
2419
3205
  */
@@ -2437,64 +3223,93 @@ export interface PauseSyncJobResponse {
2437
3223
  RequestId?: string;
2438
3224
  }
2439
3225
  /**
2440
- * 计费状态信息
3226
+ * DescribeSubscribeCheckJob请求参数结构体
2441
3227
  */
2442
- export interface TradeInfo {
3228
+ export interface DescribeSubscribeCheckJobRequest {
2443
3229
  /**
2444
- * 交易订单号
2445
- 注意:此字段可能返回 null,表示取不到有效值。
3230
+ * 数据订阅实例的 ID
2446
3231
  */
2447
- DealName?: string;
3232
+ SubscribeId: string;
3233
+ }
3234
+ /**
3235
+ * ModifySubscribeObjects请求参数结构体
3236
+ */
3237
+ export interface ModifySubscribeObjectsRequest {
2448
3238
  /**
2449
- * 上一次交易订单号
2450
- 注意:此字段可能返回 null,表示取不到有效值。
3239
+ * 数据订阅实例的ID
2451
3240
  */
2452
- LastDealName?: string;
3241
+ SubscribeId: string;
2453
3242
  /**
2454
- * 实例规格,包括:micro、small、medium、large、xlarge、2xlarge等
2455
- 注意:此字段可能返回 null,表示取不到有效值。
3243
+ * 数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合
2456
3244
  */
2457
- InstanceClass?: string;
3245
+ SubscribeObjectType: number;
2458
3246
  /**
2459
- * 计费任务状态, normal(计费或待计费)、resizing(变配中)、reversing(冲正中,比较短暂的状态)、isolating(隔离中,比较短暂的状态)、isolated(已隔离)、offlining(下线中)、offlined(已下线)、notBilled(未计费)
2460
- 注意:此字段可能返回 null,表示取不到有效值。
3247
+ * 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
2461
3248
  */
2462
- TradeStatus?: string;
3249
+ Objects?: Array<ModifiedSubscribeObject>;
2463
3250
  /**
2464
- * 到期时间,格式为"yyyy-mm-dd hh:mm:ss"
2465
- 注意:此字段可能返回 null,表示取不到有效值。
3251
+ * kafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。
2466
3252
  */
2467
- ExpireTime?: string;
3253
+ DistributeRules?: Array<DistributeRule>;
2468
3254
  /**
2469
- * 下线时间,格式为"yyyy-mm-dd hh:mm:ss"
2470
- 注意:此字段可能返回 null,表示取不到有效值。
3255
+ * 默认分区策略。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
3256
+ 非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。
3257
+ 该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。
2471
3258
  */
2472
- OfflineTime?: string;
3259
+ DefaultRuleType?: string;
2473
3260
  /**
2474
- * 隔离时间,格式为"yyyy-mm-dd hh:mm:ss"
2475
- 注意:此字段可能返回 null,表示取不到有效值。
3261
+ * mongo输出聚合设置,mongo任务可选。如果不填,默认不修改。
2476
3262
  */
2477
- IsolateTime?: string;
3263
+ PipelineInfo?: Array<PipelineInfo>;
3264
+ }
3265
+ /**
3266
+ * 数据同步view的描述
3267
+ */
3268
+ export interface View {
2478
3269
  /**
2479
- * 下线原因
3270
+ * view名
2480
3271
  注意:此字段可能返回 null,表示取不到有效值。
2481
3272
  */
2482
- OfflineReason?: string;
3273
+ ViewName?: string;
2483
3274
  /**
2484
- * 隔离原因
3275
+ * 预留字段、目前暂时不支持view的重命名
2485
3276
  注意:此字段可能返回 null,表示取不到有效值。
2486
3277
  */
2487
- IsolateReason?: string;
3278
+ NewViewName?: string;
3279
+ }
3280
+ /**
3281
+ * kafka消费者组的分区详情
3282
+ */
3283
+ export interface MonitorInfo {
2488
3284
  /**
2489
- * 付费类型,包括:postpay(后付费)、prepay(预付费)
2490
- 注意:此字段可能返回 null,表示取不到有效值。
3285
+ * 当前分区的编号,从0开始
2491
3286
  */
2492
- PayType?: string;
3287
+ PartitionNo: number;
2493
3288
  /**
2494
- * 任务计费类型,包括:billing(计费)、notBilling(不计费)、 promotions(促销活动中)
2495
- 注意:此字段可能返回 null,表示取不到有效值。
3289
+ * 当前分区的偏移量
2496
3290
  */
2497
- BillingType?: string;
3291
+ ConsumerGroupOffset: number;
3292
+ /**
3293
+ * 当前分区未消费的数据量
3294
+ */
3295
+ ConsumerGroupLag: number;
3296
+ /**
3297
+ * 当前分区的消费延迟(单位为秒)
3298
+ */
3299
+ Latency: number;
3300
+ }
3301
+ /**
3302
+ * DescribeOffsetByTime请求参数结构体
3303
+ */
3304
+ export interface DescribeOffsetByTimeRequest {
3305
+ /**
3306
+ * 数据订阅实例的 ID
3307
+ */
3308
+ SubscribeId: string;
3309
+ /**
3310
+ * 时间点,格式为:Y-m-d h:m:s。如果输入时间比当前时间晚的多,相当于查询最新offset;如果输入时间比当前时间早的多,相当于查询最老offset;如果输入空,默认0时间,等价于查询最老offset。
3311
+ */
3312
+ Time: string;
2498
3313
  }
2499
3314
  /**
2500
3315
  * StartCompare返回参数结构体
@@ -2882,13 +3697,98 @@ export interface ErrInfo {
2882
3697
  */
2883
3698
  export interface StartCompareRequest {
2884
3699
  /**
2885
- * 迁移任务 Id
3700
+ * 迁移任务 Id
3701
+ */
3702
+ JobId: string;
3703
+ /**
3704
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
3705
+ */
3706
+ CompareTaskId: string;
3707
+ }
3708
+ /**
3709
+ * 数据订阅的实例节点信息
3710
+ */
3711
+ export interface EndpointItem {
3712
+ /**
3713
+ * 源库所在地域。如果 AccessType 为 ccn,请填vpc所在地域,因为此时不知道源库在哪个地域。其他接入方式,请填订阅任务所在地域,因为确保订阅任务与源库在同一地域是最优的网络方案。
3714
+ 注意:此字段可能返回 null,表示取不到有效值。
3715
+ */
3716
+ DatabaseRegion: string;
3717
+ /**
3718
+ * 用户名
3719
+ 注意:此字段可能返回 null,表示取不到有效值。
3720
+ */
3721
+ User: string;
3722
+ /**
3723
+ * 密码。作为入参时必填,作为出参时为空。
3724
+ 注意:此字段可能返回 null,表示取不到有效值。
3725
+ */
3726
+ Password: string;
3727
+ /**
3728
+ * 目标实例ID。如果 AccessType 为 cdb,此项必填。配置InstanceId时会查询并校验实例信息。mysql的查询接口经过了鉴权,请确保子用户有 cdb:DescribeDBInstances 的接口权限。
3729
+ 注意:此字段可能返回 null,表示取不到有效值。
3730
+ */
3731
+ InstanceId?: string;
3732
+ /**
3733
+ * 云主机ID。如果 AccessType 为 cvm,此项必填。
3734
+ 注意:此字段可能返回 null,表示取不到有效值。
3735
+ */
3736
+ CvmInstanceId?: string;
3737
+ /**
3738
+ * 专线网关ID。如果 AccessType 为 dcg,此项必填。
3739
+ 注意:此字段可能返回 null,表示取不到有效值。
3740
+ */
3741
+ UniqDcgId?: string;
3742
+ /**
3743
+ * 云联网ID。如果 AccessType 为 ccn,此项必填。
3744
+ 注意:此字段可能返回 null,表示取不到有效值。
3745
+ */
3746
+ CcnId?: string;
3747
+ /**
3748
+ * vpn网关ID。如果 AccessType 为 vpncloud,此项必填。
3749
+ 注意:此字段可能返回 null,表示取不到有效值。
3750
+ */
3751
+ UniqVpnGwId?: string;
3752
+ /**
3753
+ * VpcID。如果 AccessType 为 dcg\ccn\vpncloud\vpc,此项必填。
3754
+ 注意:此字段可能返回 null,表示取不到有效值。
3755
+ */
3756
+ VpcId?: string;
3757
+ /**
3758
+ * 子网ID。如果 AccessType 为 dcg\ccn\vpncloud\vpc,此项必填。
3759
+ 注意:此字段可能返回 null,表示取不到有效值。
3760
+ */
3761
+ SubnetId?: string;
3762
+ /**
3763
+ * 数据库地址,支持域名与IP。如果 AccessType 为 dcg\ccn\vpncloud\vpc\extranet\intranet,此项必填。
3764
+ 注意:此字段可能返回 null,表示取不到有效值。
3765
+ */
3766
+ HostName?: string;
3767
+ /**
3768
+ * 数据库端口。如果 AccessType 为 dcg\ccn\vpncloud\vpc\extranet\intranet\cvm,此项必填。
3769
+ 注意:此字段可能返回 null,表示取不到有效值。
3770
+ */
3771
+ Port?: number;
3772
+ /**
3773
+ * 是否走加密传输,枚举值:UnEncrypted-不加密,Encrypted-加密。只有mysql支持,不填默认不加密,其他产品不填。
3774
+ 注意:此字段可能返回 null,表示取不到有效值。
3775
+ */
3776
+ EncryptConn?: string;
3777
+ /**
3778
+ * 数据库网络环境。如果 AccessType 为 ccn 此项必填。枚举值:UserIDC-自建idc,TencentVPC-腾讯云,Aws-aws,AliYun-阿里云,Others-其他。
3779
+ 注意:此字段可能返回 null,表示取不到有效值。
2886
3780
  */
2887
- JobId: string;
3781
+ DatabaseNetEnv?: string;
2888
3782
  /**
2889
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
3783
+ * 云联网网关所属的主账号uin、跨账号云联网需要。
3784
+ 注意:此字段可能返回 null,表示取不到有效值。
2890
3785
  */
2891
- CompareTaskId: string;
3786
+ CcnOwnerUin?: string;
3787
+ /**
3788
+ * 为业务添加的额外信息。参数名作key,参数值作value。 tdpg必填参数:PgDatabase-订阅的库名。
3789
+ 注意:此字段可能返回 null,表示取不到有效值。
3790
+ */
3791
+ ExtraAttr?: Array<KeyValuePairOption>;
2892
3792
  }
2893
3793
  /**
2894
3794
  * DescribeMigrationCheckJob请求参数结构体
@@ -3041,6 +3941,39 @@ export interface ModifyMigrateNameRequest {
3041
3941
  */
3042
3942
  JobName: string;
3043
3943
  }
3944
+ /**
3945
+ * CreateSubscribe请求参数结构体
3946
+ */
3947
+ export interface CreateSubscribeRequest {
3948
+ /**
3949
+ * 订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)
3950
+ */
3951
+ Product: string;
3952
+ /**
3953
+ * 付费方式,枚举值:0-包年包月,1-按量计费
3954
+ */
3955
+ PayType: number;
3956
+ /**
3957
+ * 购买时长。当 payType 为包年包月时,该项需要填,单位为月,最小值为 1,最大值为 120。不填默认1
3958
+ */
3959
+ Duration?: number;
3960
+ /**
3961
+ * 是否自动续费。当 payType 为包年包月时,该项需要填。枚举值:0-不自动续费,1-自动续费。默认不自动续费。按量计费设置该标识无效。
3962
+ */
3963
+ AutoRenew?: number;
3964
+ /**
3965
+ * 购买数量,默认为1,最大为10
3966
+ */
3967
+ Count?: number;
3968
+ /**
3969
+ * 实例资源标签
3970
+ */
3971
+ Tags?: Array<TagItem>;
3972
+ /**
3973
+ * 任务名,自定义
3974
+ */
3975
+ Name?: string;
3976
+ }
3044
3977
  /**
3045
3978
  * StartSyncJob返回参数结构体
3046
3979
  */
@@ -3050,6 +3983,40 @@ export interface StartSyncJobResponse {
3050
3983
  */
3051
3984
  RequestId?: string;
3052
3985
  }
3986
+ /**
3987
+ * StartMigrateJob请求参数结构体
3988
+ */
3989
+ export interface StartMigrateJobRequest {
3990
+ /**
3991
+ * 数据迁移任务ID
3992
+ */
3993
+ JobId: string;
3994
+ }
3995
+ /**
3996
+ * 订阅任务的kafka分区规则。符合库名和表名正则表达式的数据将按照RuleType计算该条数据将被投递的kafka分区。如果配置了多个规则,将按照配置的顺序,第一条命中的规则生效。
3997
+ */
3998
+ export interface DistributeRule {
3999
+ /**
4000
+ * 规则类型。非mongo产品的枚举值为: table-按表名分区,pk-按表名+主键分区,cols-按列名分区。mongo的枚举值为:collection-按集合名分区、collectionAndObjectId-按集合+主键分区。
4001
+ 注意:此字段可能返回 null,表示取不到有效值。
4002
+ */
4003
+ RuleType: string;
4004
+ /**
4005
+ * 库名匹配规则,请填写正则表达式
4006
+ 注意:此字段可能返回 null,表示取不到有效值。
4007
+ */
4008
+ DbPattern: string;
4009
+ /**
4010
+ * 表名匹配规则,如果 DatabaseType 为 mongodb,则匹配集合名
4011
+ 注意:此字段可能返回 null,表示取不到有效值。
4012
+ */
4013
+ TablePattern: string;
4014
+ /**
4015
+ * 列名。如果 RuleType 为 cols,此项必填。订阅任务会用该列的值计算分区。mongo没有按列分区,因此也不用传这个字段。
4016
+ 注意:此字段可能返回 null,表示取不到有效值。
4017
+ */
4018
+ Columns?: Array<string>;
4019
+ }
3053
4020
  /**
3054
4021
  * 同步的数据库对对象描述
3055
4022
  */
@@ -3065,190 +4032,365 @@ export interface Objects {
3065
4032
  */
3066
4033
  Databases?: Array<Database>;
3067
4034
  /**
3068
- * 高级对象类型,如function、procedure。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型。当需要同步高级对象时,初始化类型必须包含结构初始化类型,即任务的Options.InitType字段值为Structure或Full
4035
+ * 高级对象类型,如function、procedure。注意:如果要迁移同步高级对象,此配置中应该包含对应的高级对象类型。当需要同步高级对象时,初始化类型必须包含结构初始化类型,即任务的Options.InitType字段值为Structure或Full
4036
+ 注意:此字段可能返回 null,表示取不到有效值。
4037
+ */
4038
+ AdvancedObjects?: Array<string>;
4039
+ /**
4040
+ * OnlineDDL类型,冗余字段不做配置用途
4041
+ 注意:此字段可能返回 null,表示取不到有效值。
4042
+ */
4043
+ OnlineDDL?: OnlineDDL;
4044
+ }
4045
+ /**
4046
+ * DeleteConsumerGroup返回参数结构体
4047
+ */
4048
+ export interface DeleteConsumerGroupResponse {
4049
+ /**
4050
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4051
+ */
4052
+ RequestId?: string;
4053
+ }
4054
+ /**
4055
+ * 迁移对象信息,在配置库表视图等对象信息时大小写敏感
4056
+ */
4057
+ export interface DBItem {
4058
+ /**
4059
+ * 需要迁移或同步的库名,当ObjectMode为partial时,此项必填
4060
+ 注意:此字段可能返回 null,表示取不到有效值。
4061
+ */
4062
+ DbName?: string;
4063
+ /**
4064
+ * 迁移或同步后的库名,默认与源库相同
4065
+ 注意:此字段可能返回 null,表示取不到有效值。
4066
+ */
4067
+ NewDbName?: string;
4068
+ /**
4069
+ * 迁移或同步的 schema
4070
+ 注意:此字段可能返回 null,表示取不到有效值。
4071
+ */
4072
+ SchemaName?: string;
4073
+ /**
4074
+ * 迁移或同步后的 schema name
4075
+ 注意:此字段可能返回 null,表示取不到有效值。
4076
+ */
4077
+ NewSchemaName?: string;
4078
+ /**
4079
+ * DB选择模式: all(为当前对象下的所有对象),partial(部分对象),当ObjectMode为partial时,此项必填
4080
+ 注意:此字段可能返回 null,表示取不到有效值。
4081
+ */
4082
+ DBMode?: string;
4083
+ /**
4084
+ * schema选择模式: all(为当前对象下的所有对象),partial(部分对象)
4085
+ 注意:此字段可能返回 null,表示取不到有效值。
4086
+ */
4087
+ SchemaMode?: string;
4088
+ /**
4089
+ * 表选择模式: all(为当前对象下的所有对象),partial(部分对象),当DBMode为partial时此项必填
4090
+ 注意:此字段可能返回 null,表示取不到有效值。
4091
+ */
4092
+ TableMode?: string;
4093
+ /**
4094
+ * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
4095
+ 注意:此字段可能返回 null,表示取不到有效值。
4096
+ */
4097
+ Tables?: Array<TableItem>;
4098
+ /**
4099
+ * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
4100
+ 注意:此字段可能返回 null,表示取不到有效值。
4101
+ */
4102
+ ViewMode?: string;
4103
+ /**
4104
+ * 视图对象集合,当 ViewMode 为 partial 时, 此项需要填写
4105
+ 注意:此字段可能返回 null,表示取不到有效值。
4106
+ */
4107
+ Views?: Array<ViewItem>;
4108
+ /**
4109
+ * postgresql独有参数,角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象
4110
+ 注意:此字段可能返回 null,表示取不到有效值。
4111
+ */
4112
+ RoleMode?: string;
4113
+ /**
4114
+ * postgresql独有参数,当 RoleMode 为 partial 时, 此项需要填写
4115
+ 注意:此字段可能返回 null,表示取不到有效值。
4116
+ */
4117
+ Roles?: Array<RoleItem>;
4118
+ /**
4119
+ * 选择要同步的模式,partial为部分,all为整选
4120
+ 注意:此字段可能返回 null,表示取不到有效值。
4121
+ */
4122
+ FunctionMode?: string;
4123
+ /**
4124
+ * 选择要同步的模式,partial为部分,all为整选
4125
+ 注意:此字段可能返回 null,表示取不到有效值。
4126
+ */
4127
+ TriggerMode?: string;
4128
+ /**
4129
+ * 选择要同步的模式,partial为部分,all为整选
4130
+ 注意:此字段可能返回 null,表示取不到有效值。
4131
+ */
4132
+ EventMode?: string;
4133
+ /**
4134
+ * 选择要同步的模式,partial为部分,all为整选
4135
+ 注意:此字段可能返回 null,表示取不到有效值。
4136
+ */
4137
+ ProcedureMode?: string;
4138
+ /**
4139
+ * FunctionMode取值为partial时需要填写
4140
+ 注意:此字段可能返回 null,表示取不到有效值。
4141
+ */
4142
+ Functions?: Array<string>;
4143
+ /**
4144
+ * ProcedureMode取值为partial时需要填写
4145
+ 注意:此字段可能返回 null,表示取不到有效值。
4146
+ */
4147
+ Procedures?: Array<string>;
4148
+ /**
4149
+ * EventMode取值为partial时需要填写
4150
+ 注意:此字段可能返回 null,表示取不到有效值。
4151
+ */
4152
+ Events?: Array<string>;
4153
+ /**
4154
+ * TriggerMode取值为partial时需要填写
4155
+ 注意:此字段可能返回 null,表示取不到有效值。
4156
+ */
4157
+ Triggers?: Array<string>;
4158
+ }
4159
+ /**
4160
+ * DeleteCompareTask请求参数结构体
4161
+ */
4162
+ export interface DeleteCompareTaskRequest {
4163
+ /**
4164
+ * 迁移任务 Id
4165
+ */
4166
+ JobId: string;
4167
+ /**
4168
+ * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4169
+ */
4170
+ CompareTaskId: string;
4171
+ }
4172
+ /**
4173
+ * 迁移执行过程信息
4174
+ */
4175
+ export interface MigrateDetailInfo {
4176
+ /**
4177
+ * 总步骤数
4178
+ 注意:此字段可能返回 null,表示取不到有效值。
4179
+ */
4180
+ StepAll: number;
4181
+ /**
4182
+ * 当前步骤
4183
+ 注意:此字段可能返回 null,表示取不到有效值。
4184
+ */
4185
+ StepNow: number;
4186
+ /**
4187
+ * 主从差距,MB;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
4188
+ 注意:此字段可能返回 null,表示取不到有效值。
4189
+ */
4190
+ MasterSlaveDistance: number;
4191
+ /**
4192
+ * 主从差距,秒;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
4193
+ 注意:此字段可能返回 null,表示取不到有效值。
4194
+ */
4195
+ SecondsBehindMaster: number;
4196
+ /**
4197
+ * 步骤信息
4198
+ 注意:此字段可能返回 null,表示取不到有效值。
4199
+ */
4200
+ StepInfo: Array<StepDetailInfo>;
4201
+ }
4202
+ /**
4203
+ * StopMigrateJob请求参数结构体
4204
+ */
4205
+ export interface StopMigrateJobRequest {
4206
+ /**
4207
+ * 数据迁移任务ID
4208
+ */
4209
+ JobId: string;
4210
+ }
4211
+ /**
4212
+ * 数据同步中的描述源端和目的端的信息
4213
+ */
4214
+ export interface Endpoint {
4215
+ /**
4216
+ * 地域英文名,如:ap-guangzhou
4217
+ 注意:此字段可能返回 null,表示取不到有效值。
4218
+ */
4219
+ Region?: string;
4220
+ /**
4221
+ * tdsql mysql版的节点类型,枚举值为proxy、set
4222
+ 注意:此字段可能返回 null,表示取不到有效值。
4223
+ */
4224
+ Role?: string;
4225
+ /**
4226
+ * 数据库内核类型,tdsql中用于区分不同内核:percona,mariadb,mysql
4227
+ 注意:此字段可能返回 null,表示取不到有效值。
4228
+ */
4229
+ DbKernel?: string;
4230
+ /**
4231
+ * 数据库实例ID,格式如:cdb-powiqx8q
4232
+ 注意:此字段可能返回 null,表示取不到有效值。
4233
+ */
4234
+ InstanceId?: string;
4235
+ /**
4236
+ * 实例的IP地址,接入类型为非cdb时此项必填
3069
4237
  注意:此字段可能返回 null,表示取不到有效值。
3070
4238
  */
3071
- AdvancedObjects?: Array<string>;
4239
+ Ip?: string;
3072
4240
  /**
3073
- * OnlineDDL类型,冗余字段不做配置用途
4241
+ * 实例端口,接入类型为非cdb时此项必填
3074
4242
  注意:此字段可能返回 null,表示取不到有效值。
3075
4243
  */
3076
- OnlineDDL?: OnlineDDL;
3077
- }
3078
- /**
3079
- * RecoverMigrateJob返回参数结构体
3080
- */
3081
- export interface RecoverMigrateJobResponse {
4244
+ Port?: number;
3082
4245
  /**
3083
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4246
+ * 用户名,对于访问需要用户名密码认证的实例必填
4247
+ 注意:此字段可能返回 null,表示取不到有效值。
3084
4248
  */
3085
- RequestId?: string;
3086
- }
3087
- /**
3088
- * 迁移对象信息,在配置库表视图等对象信息时大小写敏感
3089
- */
3090
- export interface DBItem {
4249
+ User?: string;
3091
4250
  /**
3092
- * 需要迁移或同步的库名,当ObjectMode为partial时,此项必填
4251
+ * 密码,对于访问需要用户名密码认证的实例必填
3093
4252
  注意:此字段可能返回 null,表示取不到有效值。
3094
4253
  */
3095
- DbName?: string;
4254
+ Password?: string;
3096
4255
  /**
3097
- * 迁移或同步后的库名,默认与源库相同
4256
+ * 数据库名,数据库为cdwpg时,需要提供
3098
4257
  注意:此字段可能返回 null,表示取不到有效值。
3099
4258
  */
3100
- NewDbName?: string;
4259
+ DbName?: string;
3101
4260
  /**
3102
- * 迁移或同步的 schema
4261
+ * 私有网络ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:vpc-92jblxto
3103
4262
  注意:此字段可能返回 null,表示取不到有效值。
3104
4263
  */
3105
- SchemaName?: string;
4264
+ VpcId?: string;
3106
4265
  /**
3107
- * 迁移或同步后的 schema name
4266
+ * 私有网络下的子网ID,对于私有网络、专线、VPN的接入方式此项必填,格式如:subnet-3paxmkdz
3108
4267
  注意:此字段可能返回 null,表示取不到有效值。
3109
4268
  */
3110
- NewSchemaName?: string;
4269
+ SubnetId?: string;
3111
4270
  /**
3112
- * DB选择模式: all(为当前对象下的所有对象),partial(部分对象),当ObjectMode为partial时,此项必填
4271
+ * CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
3113
4272
  注意:此字段可能返回 null,表示取不到有效值。
3114
4273
  */
3115
- DBMode?: string;
4274
+ CvmInstanceId?: string;
3116
4275
  /**
3117
- * schema选择模式: all(为当前对象下的所有对象),partial(部分对象)
4276
+ * 专线网关ID,对于专线接入类型此项必填,格式如:dcg-0rxtqqxb
3118
4277
  注意:此字段可能返回 null,表示取不到有效值。
3119
4278
  */
3120
- SchemaMode?: string;
4279
+ UniqDcgId?: string;
3121
4280
  /**
3122
- * 表选择模式: all(为当前对象下的所有对象),partial(部分对象),当DBMode为partial时此项必填
4281
+ * VPN网关ID,对于vpn接入类型此项必填,格式如:vpngw-9ghexg7q
3123
4282
  注意:此字段可能返回 null,表示取不到有效值。
3124
4283
  */
3125
- TableMode?: string;
4284
+ UniqVpnGwId?: string;
3126
4285
  /**
3127
- * 表图对象集合,当 TableMode 为 partial 时,此项需要填写
4286
+ * 云联网ID,对于云联网接入类型此项必填,如:ccn-afp6kltc
3128
4287
  注意:此字段可能返回 null,表示取不到有效值。
3129
4288
  */
3130
- Tables?: Array<TableItem>;
4289
+ CcnId?: string;
3131
4290
  /**
3132
- * 视图选择模式: all 为当前对象下的所有视图对象,partial 为部分视图对象
4291
+ * 云厂商类型,当实例为RDS实例时,填写为aliyun, 其他情况均填写others,默认为others
3133
4292
  注意:此字段可能返回 null,表示取不到有效值。
3134
4293
  */
3135
- ViewMode?: string;
4294
+ Supplier?: string;
3136
4295
  /**
3137
- * 视图对象集合,当 ViewMode 为 partial 时, 此项需要填写
4296
+ * 数据库版本,当实例为RDS实例时才有效,其他实例忽略,格式如:5.6或者5.7,默认为5.6
3138
4297
  注意:此字段可能返回 null,表示取不到有效值。
3139
4298
  */
3140
- Views?: Array<ViewItem>;
4299
+ EngineVersion?: string;
3141
4300
  /**
3142
- * postgresql独有参数,角色选择模式: all 为当前对象下的所有角色对象,partial 为部分角色对象
4301
+ * 实例所属账号,如果为跨账号实例此项必填
3143
4302
  注意:此字段可能返回 null,表示取不到有效值。
3144
4303
  */
3145
- RoleMode?: string;
4304
+ Account?: string;
3146
4305
  /**
3147
- * postgresql独有参数,当 RoleMode 为 partial 时, 此项需要填写
4306
+ * 资源所属账号 为空或self(表示本账号内资源)、other(表示跨账号资源)
3148
4307
  注意:此字段可能返回 null,表示取不到有效值。
3149
4308
  */
3150
- Roles?: Array<RoleItem>;
4309
+ AccountMode?: string;
3151
4310
  /**
3152
- * 选择要同步的模式,partial为部分,all为整选
4311
+ * 跨账号同步时的角色,只允许[a-zA-Z0-9\-\_]+,如果为跨账号实例此项必填
3153
4312
  注意:此字段可能返回 null,表示取不到有效值。
3154
4313
  */
3155
- FunctionMode?: string;
4314
+ AccountRole?: string;
3156
4315
  /**
3157
- * 选择要同步的模式,partial为部分,all为整选
4316
+ * 外部角色id
3158
4317
  注意:此字段可能返回 null,表示取不到有效值。
3159
4318
  */
3160
- TriggerMode?: string;
4319
+ RoleExternalId?: string;
3161
4320
  /**
3162
- * 选择要同步的模式,partial为部分,all为整选
4321
+ * 临时密钥Id,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,如果为跨账号实例此项必填
3163
4322
  注意:此字段可能返回 null,表示取不到有效值。
3164
4323
  */
3165
- EventMode?: string;
4324
+ TmpSecretId?: string;
3166
4325
  /**
3167
- * 选择要同步的模式,partial为部分,all为整选
4326
+ * 临时密钥Key,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
3168
4327
  注意:此字段可能返回 null,表示取不到有效值。
3169
4328
  */
3170
- ProcedureMode?: string;
4329
+ TmpSecretKey?: string;
3171
4330
  /**
3172
- * FunctionMode取值为partial时需要填写
4331
+ * 临时Token,可通过获取联合身份临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48195,,如果为跨账号实例此项必填
3173
4332
  注意:此字段可能返回 null,表示取不到有效值。
3174
4333
  */
3175
- Functions?: Array<string>;
4334
+ TmpToken?: string;
3176
4335
  /**
3177
- * ProcedureMode取值为partial时需要填写
4336
+ * 是否走加密传输、UnEncrypted表示不走加密传输,Encrypted表示走加密传输,默认UnEncrypted
3178
4337
  注意:此字段可能返回 null,表示取不到有效值。
3179
4338
  */
3180
- Procedures?: Array<string>;
4339
+ EncryptConn?: string;
3181
4340
  /**
3182
- * EventMode取值为partial时需要填写
4341
+ * 数据库所属网络环境,AccessType为云联网(ccn)时必填, UserIDC表示用户IDC、TencentVPC表示腾讯云VPC;
3183
4342
  注意:此字段可能返回 null,表示取不到有效值。
3184
4343
  */
3185
- Events?: Array<string>;
4344
+ DatabaseNetEnv?: string;
3186
4345
  /**
3187
- * TriggerMode取值为partial时需要填写
4346
+ * 数据库为跨账号云联网下的实例时、表示云联网所属主账号
3188
4347
  注意:此字段可能返回 null,表示取不到有效值。
3189
4348
  */
3190
- Triggers?: Array<string>;
4349
+ CcnOwnerUin?: string;
3191
4350
  }
3192
4351
  /**
3193
- * DeleteCompareTask请求参数结构体
4352
+ * ConfigureSubscribeJob请求参数结构体
3194
4353
  */
3195
- export interface DeleteCompareTaskRequest {
4354
+ export interface ConfigureSubscribeJobRequest {
3196
4355
  /**
3197
- * 迁移任务 Id
4356
+ * 数据订阅实例的 ID
3198
4357
  */
3199
- JobId: string;
4358
+ SubscribeId: string;
3200
4359
  /**
3201
- * 对比任务 ID,形如:dts-8yv4w2i1-cmp-37skmii9
4360
+ * 数据订阅的类型,当 DatabaseType 不为 mongodb 时,枚举值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时,枚举值为 all-全实例更新;database-订阅单库;collection-订阅单集合
3202
4361
  */
3203
- CompareTaskId: string;
3204
- }
3205
- /**
3206
- * 迁移执行过程信息
3207
- */
3208
- export interface MigrateDetailInfo {
4362
+ SubscribeMode: string;
3209
4363
  /**
3210
- * 总步骤数
3211
- 注意:此字段可能返回 null,表示取不到有效值。
4364
+ * 源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云主机自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
3212
4365
  */
3213
- StepAll: number;
4366
+ AccessType: string;
3214
4367
  /**
3215
- * 当前步骤
3216
- 注意:此字段可能返回 null,表示取不到有效值。
4368
+ * 数据库节点信息
3217
4369
  */
3218
- StepNow: number;
4370
+ Endpoints: Array<EndpointItem>;
3219
4371
  /**
3220
- * 主从差距,MB;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
3221
- 注意:此字段可能返回 null,表示取不到有效值。
4372
+ * Kafka配置
3222
4373
  */
3223
- MasterSlaveDistance: number;
4374
+ KafkaConfig: SubscribeKafkaConfig;
3224
4375
  /**
3225
- * 主从差距,秒;只在任务正常,迁移或者同步的最后一步(追Binlog的阶段才有校),如果是非法值,返回-1
3226
- 注意:此字段可能返回 null,表示取不到有效值。
4376
+ * 订阅的数据库表信息,当 SubscribeMode 不为 all和ddl 时,SubscribeObjects 为必选参数
3227
4377
  */
3228
- SecondsBehindMaster: number;
4378
+ SubscribeObjects?: Array<SubscribeObject>;
3229
4379
  /**
3230
- * 步骤信息
3231
- 注意:此字段可能返回 null,表示取不到有效值。
4380
+ * 订阅数据格式,如:protobuf、json、avro。注意具体可选值依赖当前链路支持能力,数据格式详情参考官网的消费demo文档
3232
4381
  */
3233
- StepInfo: Array<StepDetailInfo>;
3234
- }
3235
- /**
3236
- * StopMigrateJob请求参数结构体
3237
- */
3238
- export interface StopMigrateJobRequest {
4382
+ Protocol?: string;
3239
4383
  /**
3240
- * 数据迁移任务ID
4384
+ * mongo选填参数:输出聚合设置。
3241
4385
  */
3242
- JobId: string;
3243
- }
3244
- /**
3245
- * IsolateMigrateJob返回参数结构体
3246
- */
3247
- export interface IsolateMigrateJobResponse {
4386
+ PipelineInfo?: Array<PipelineInfo>;
3248
4387
  /**
3249
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
4388
+ * 为业务添加的额外信息。参数名作key,参数值作value
4389
+ mysql选填参数:ProcessXA-是否处理XA事务,填true处理,不填或填其他值不处理。
4390
+ mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream,不填也是默认changeStream。
4391
+ 其他业务暂没有可选参数。
3250
4392
  */
3251
- RequestId?: string;
4393
+ ExtraAttr?: Array<KeyValuePairOption>;
3252
4394
  }
3253
4395
  /**
3254
4396
  * 同步任务信息
@@ -3431,29 +4573,39 @@ export interface SyncJobInfo {
3431
4573
  DumperResumeCtrl?: string;
3432
4574
  }
3433
4575
  /**
3434
- * 一致性校验选项
4576
+ * DescribeSubscribeCheckJob返回参数结构体
3435
4577
  */
3436
- export interface CompareOptions {
4578
+ export interface DescribeSubscribeCheckJobResponse {
3437
4579
  /**
3438
- * 对比方式:dataCheck(完整数据对比)、sampleDataCheck(抽样数据对比)、rowsCount(行数对比)
3439
- 注意:此字段可能返回 null,表示取不到有效值。
4580
+ * 订阅实例ID
3440
4581
  */
3441
- Method?: string;
4582
+ SubscribeId?: string;
3442
4583
  /**
3443
- * 抽样比例;范围0,100
4584
+ * 失败或者报错提示,成功则提示success。
3444
4585
  注意:此字段可能返回 null,表示取不到有效值。
3445
4586
  */
3446
- SampleRate?: number;
4587
+ Message?: string;
3447
4588
  /**
3448
- * 线程数,取值1-5,默认为1
4589
+ * 任务运行状态,可能值为 running,failed,success
4590
+ */
4591
+ Status?: string;
4592
+ /**
4593
+ * 当前总体进度,范围 0~100
4594
+ */
4595
+ Progress?: number;
4596
+ /**
4597
+ * 校验总步骤数
4598
+ */
4599
+ StepAll?: number;
4600
+ /**
4601
+ * 当前执行步骤
4602
+ */
4603
+ StepNow?: number;
4604
+ /**
4605
+ * 各个步骤运行状态
3449
4606
  注意:此字段可能返回 null,表示取不到有效值。
3450
4607
  */
3451
- ThreadCount?: number;
3452
- }
3453
- /**
3454
- * ModifySyncJobConfig返回参数结构体
3455
- */
3456
- export interface ModifySyncJobConfigResponse {
4608
+ Steps?: Array<SubscribeCheckStepInfo>;
3457
4609
  /**
3458
4610
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3459
4611
  */
@@ -3591,19 +4743,26 @@ export interface CreateSyncJobRequest {
3591
4743
  ExistedJobId?: string;
3592
4744
  }
3593
4745
  /**
3594
- * 视图对象
4746
+ * 订阅的kafka分区数和分区规则。mariadb,percona,tdsqlmysql,tdpg不支持自定义分区,所以DistributeRules和DefaultRuleType可以不填,但是NumberOfPartitions是必填。
3595
4747
  */
3596
- export interface ViewItem {
4748
+ export interface SubscribeKafkaConfig {
3597
4749
  /**
3598
- * 视图名称
4750
+ * kafka分区数量,枚举值为1,4,8
3599
4751
  注意:此字段可能返回 null,表示取不到有效值。
3600
4752
  */
3601
- ViewName?: string;
4753
+ NumberOfPartitions: number;
3602
4754
  /**
3603
- * 迁移后的视图名称
4755
+ * 分区规则。当NumberOfPartitions > 1时,该项必填。
3604
4756
  注意:此字段可能返回 null,表示取不到有效值。
3605
4757
  */
3606
- NewViewName?: string;
4758
+ DistributeRules?: Array<DistributeRule>;
4759
+ /**
4760
+ * 默认分区策略。当NumberOfPartitions > 1时,该项必填。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。
4761
+ 非mongo产品的枚举值为: table-按表名分区,pk-按表名+主键分区。mongo的枚举值为:collection-按集合名分区。
4762
+ 该字段与DistributeRules搭配使用,如果配置了该字段,视为配置了一条DistributeRules。
4763
+ 注意:此字段可能返回 null,表示取不到有效值。
4764
+ */
4765
+ DefaultRuleType?: string;
3607
4766
  }
3608
4767
  /**
3609
4768
  * DescribeCompareReport请求参数结构体
@@ -3671,19 +4830,31 @@ export interface SkippedItem {
3671
4830
  Reason?: string;
3672
4831
  }
3673
4832
  /**
3674
- * 数据同步view的描述
4833
+ * IsolateSubscribe请求参数结构体
3675
4834
  */
3676
- export interface View {
4835
+ export interface IsolateSubscribeRequest {
3677
4836
  /**
3678
- * view名
3679
- 注意:此字段可能返回 null,表示取不到有效值。
4837
+ * 订阅实例ID
3680
4838
  */
3681
- ViewName?: string;
4839
+ SubscribeId: string;
4840
+ }
4841
+ /**
4842
+ * DescribeSubscribeReturnable返回参数结构体
4843
+ */
4844
+ export interface DescribeSubscribeReturnableResponse {
3682
4845
  /**
3683
- * 预留字段、目前暂时不支持view的重命名
4846
+ * 实例是否支持退还/退货
4847
+ */
4848
+ IsReturnable?: boolean;
4849
+ /**
4850
+ * 不支持退还的原因
3684
4851
  注意:此字段可能返回 null,表示取不到有效值。
3685
4852
  */
3686
- NewViewName?: string;
4853
+ ReturnFailMessage?: string;
4854
+ /**
4855
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4856
+ */
4857
+ RequestId?: string;
3687
4858
  }
3688
4859
  /**
3689
4860
  * 标签
@@ -3719,6 +4890,32 @@ export interface OnlineDDL {
3719
4890
  */
3720
4891
  Status: string;
3721
4892
  }
4893
+ /**
4894
+ * DescribeSubscribeJobs返回参数结构体
4895
+ */
4896
+ export interface DescribeSubscribeJobsResponse {
4897
+ /**
4898
+ * 符合查询条件的实例总数
4899
+ */
4900
+ TotalCount?: number;
4901
+ /**
4902
+ * 数据订阅实例的信息列表
4903
+ */
4904
+ Items?: Array<SubscribeInfo>;
4905
+ /**
4906
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4907
+ */
4908
+ RequestId?: string;
4909
+ }
4910
+ /**
4911
+ * ResetSubscribe请求参数结构体
4912
+ */
4913
+ export interface ResetSubscribeRequest {
4914
+ /**
4915
+ * 数据订阅实例的ID
4916
+ */
4917
+ SubscribeId: string;
4918
+ }
3722
4919
  /**
3723
4920
  * 迁移对象选项,需要告知迁移服务迁移哪些库表对象
3724
4921
  */
@@ -3801,6 +4998,21 @@ export interface Table {
3801
4998
  */
3802
4999
  TableEditMode?: string;
3803
5000
  }
5001
+ /**
5002
+ * 订阅校验任务的提示信息
5003
+ */
5004
+ export interface SubscribeCheckStepTip {
5005
+ /**
5006
+ * 错误或告警的详细信息
5007
+ 注意:此字段可能返回 null,表示取不到有效值。
5008
+ */
5009
+ Message?: string;
5010
+ /**
5011
+ * 帮助文档
5012
+ 注意:此字段可能返回 null,表示取不到有效值。
5013
+ */
5014
+ HelpDoc?: string;
5015
+ }
3804
5016
  /**
3805
5017
  * 一致性校验详细信息
3806
5018
  */
@@ -3816,6 +5028,55 @@ export interface CompareDetailInfo {
3816
5028
  */
3817
5029
  Skipped: SkippedDetail;
3818
5030
  }
5031
+ /**
5032
+ * DescribeSubscribeJobs请求参数结构体
5033
+ */
5034
+ export interface DescribeSubscribeJobsRequest {
5035
+ /**
5036
+ * 订阅 ID 筛选,精确匹配
5037
+ */
5038
+ SubscribeId?: string;
5039
+ /**
5040
+ * 订阅名称,前缀模糊匹配
5041
+ */
5042
+ SubscribeName?: string;
5043
+ /**
5044
+ * 订阅的云上数据库实例的 ID,精确匹配
5045
+ */
5046
+ InstanceId?: string;
5047
+ /**
5048
+ * 计费模式筛选,可能的值:0-包年包月,1-按量计费
5049
+ */
5050
+ PayType?: number;
5051
+ /**
5052
+ * 订阅的数据库产品,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
5053
+ */
5054
+ Product?: string;
5055
+ /**
5056
+ * 数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining,按量转包年包月中 post2PrePayIng
5057
+ */
5058
+ Status?: Array<string>;
5059
+ /**
5060
+ * 数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
5061
+ */
5062
+ SubsStatus?: Array<string>;
5063
+ /**
5064
+ * 返回记录的起始偏移量。默认0
5065
+ */
5066
+ Offset?: number;
5067
+ /**
5068
+ * 单次返回的记录数量。默认20,最大100
5069
+ */
5070
+ Limit?: number;
5071
+ /**
5072
+ * 排序方向,可选的值为"DESC"和"ASC",默认为"DESC",按创建时间逆序排序
5073
+ */
5074
+ OrderDirection?: string;
5075
+ /**
5076
+ * tag 过滤条件,多个 TagFilter 之间关系为且
5077
+ */
5078
+ TagFilters?: Array<TagFilter>;
5079
+ }
3819
5080
  /**
3820
5081
  * StartMigrateJob返回参数结构体
3821
5082
  */