tencentcloud-sdk-nodejs 4.1.124 → 4.1.125

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/es/common/sdk_version.js +1 -1
  2. package/es/services/cdb/v20170320/cdb_client.js +3 -0
  3. package/es/services/dbbrain/v20210527/dbbrain_client.js +7 -4
  4. package/es/services/teo/v20220901/teo_client.js +9 -0
  5. package/package.json +1 -1
  6. package/tencentcloud/common/sdk_version.d.ts +1 -1
  7. package/tencentcloud/common/sdk_version.js +1 -1
  8. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +12 -0
  9. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -1
  10. package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -0
  11. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +89 -59
  12. package/tencentcloud/services/cdwpg/v20201230/cdwpg_models.d.ts +4 -0
  13. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +3 -3
  14. package/tencentcloud/services/dbbrain/v20191016/dbbrain_models.d.ts +66 -41
  15. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +9 -5
  16. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +12 -6
  17. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +281 -153
  18. package/tencentcloud/services/dts/v20180330/dts_client.d.ts +1 -2
  19. package/tencentcloud/services/dts/v20180330/dts_client.js +1 -2
  20. package/tencentcloud/services/dts/v20180330/dts_models.d.ts +4 -2
  21. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +6 -6
  22. package/tencentcloud/services/dts/v20211206/dts_client.js +6 -6
  23. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +68 -47
  24. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +56 -1
  25. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  26. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +99 -48
  27. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +4 -0
  28. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +80 -24
  29. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +8 -8
  30. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +8 -8
  31. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +513 -281
  32. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +12 -8
  33. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +1 -1
  34. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +13 -1
  35. package/tencentcloud/services/teo/v20220901/teo_client.js +18 -0
  36. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +465 -296
  37. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +13 -4
  38. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +8 -0
@@ -78,7 +78,7 @@ export declare class Client extends AbstractClient {
78
78
  */
79
79
  ResetSubscribe(req: ResetSubscribeRequest, cb?: (error: string, rep: ResetSubscribeResponse) => void): Promise<ResetSubscribeResponse>;
80
80
  /**
81
- * 本接口(StartMigrationJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
81
+ * 本接口(StartMigrateJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
82
82
  调用此接口前,请务必先使用CreateMigrateCheckJob校验数据迁移任务,并通过DescribeMigrateJobs接口查询到任务状态为校验通过(status=4)时,才能启动数据迁移任务。
83
83
  */
84
84
  StartMigrateJob(req: StartMigrateJobRequest, cb?: (error: string, rep: StartMigrateJobResponse) => void): Promise<StartMigrateJobResponse>;
@@ -109,7 +109,6 @@ export declare class Client extends AbstractClient {
109
109
  * 本接口(CompleteMigrateJob)用于完成数据迁移任务。
110
110
  选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。
111
111
  通过DescribeMigrateJobs接口查询到任务的状态为准备完成(status=8)时,此时可以调用本接口完成迁移任务。
112
-
113
112
  */
114
113
  CompleteMigrateJob(req: CompleteMigrateJobRequest, cb?: (error: string, rep: CompleteMigrateJobResponse) => void): Promise<CompleteMigrateJobResponse>;
115
114
  }
@@ -128,7 +128,7 @@ class Client extends abstract_client_1.AbstractClient {
128
128
  return this.request("ResetSubscribe", req, cb);
129
129
  }
130
130
  /**
131
- * 本接口(StartMigrationJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
131
+ * 本接口(StartMigrateJob)用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移,定时任务则会开始倒计时。
132
132
  调用此接口前,请务必先使用CreateMigrateCheckJob校验数据迁移任务,并通过DescribeMigrateJobs接口查询到任务状态为校验通过(status=4)时,才能启动数据迁移任务。
133
133
  */
134
134
  async StartMigrateJob(req, cb) {
@@ -171,7 +171,6 @@ class Client extends abstract_client_1.AbstractClient {
171
171
  * 本接口(CompleteMigrateJob)用于完成数据迁移任务。
172
172
  选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。
173
173
  通过DescribeMigrateJobs接口查询到任务的状态为准备完成(status=8)时,此时可以调用本接口完成迁移任务。
174
-
175
174
  */
176
175
  async CompleteMigrateJob(req, cb) {
177
176
  return this.request("CompleteMigrateJob", req, cb);
@@ -959,7 +959,8 @@ export interface ModifySubscribeAutoRenewFlagRequest {
959
959
  */
960
960
  export interface CompleteMigrateJobRequest {
961
961
  /**
962
- * 数据迁移任务ID
962
+ * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
963
+
963
964
  */
964
965
  JobId: string;
965
966
  /**
@@ -1282,7 +1283,8 @@ export interface StartMigrateJobResponse {
1282
1283
  */
1283
1284
  export interface StartMigrateJobRequest {
1284
1285
  /**
1285
- * 数据迁移任务ID
1286
+ * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1287
+
1286
1288
  */
1287
1289
  JobId: string;
1288
1290
  }
@@ -52,7 +52,7 @@ export declare class Client extends AbstractClient {
52
52
  */
53
53
  DescribeSubscribeReturnable(req: DescribeSubscribeReturnableRequest, cb?: (error: string, rep: DescribeSubscribeReturnableResponse) => void): Promise<DescribeSubscribeReturnableResponse>;
54
54
  /**
55
- * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
55
+ * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
56
56
  */
57
57
  IsolateSyncJob(req: IsolateSyncJobRequest, cb?: (error: string, rep: IsolateSyncJobResponse) => void): Promise<IsolateSyncJobResponse>;
58
58
  /**
@@ -72,7 +72,8 @@ export declare class Client extends AbstractClient {
72
72
  */
73
73
  DescribeConsumerGroups(req: DescribeConsumerGroupsRequest, cb?: (error: string, rep: DescribeConsumerGroupsResponse) => void): Promise<DescribeConsumerGroupsResponse>;
74
74
  /**
75
- * 为订阅实例创建消费者组
75
+ * 为订阅实例创建消费者组。
76
+ 只有状态为运行中的实例支持创建消费组。
76
77
  */
77
78
  CreateConsumerGroup(req: CreateConsumerGroupRequest, cb?: (error: string, rep: CreateConsumerGroupResponse) => void): Promise<CreateConsumerGroupResponse>;
78
79
  /**
@@ -198,10 +199,9 @@ export declare class Client extends AbstractClient {
198
199
  */
199
200
  CreateSubscribeCheckJob(req: CreateSubscribeCheckJobRequest, cb?: (error: string, rep: CreateSubscribeCheckJobResponse) => void): Promise<CreateSubscribeCheckJobResponse>;
200
201
  /**
201
- * 校验迁移任务,
202
+ * 创建校验迁移任务,
202
203
  在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看,
203
204
  校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移
204
-
205
205
  */
206
206
  CreateMigrateCheckJob(req: CreateMigrateCheckJobRequest, cb?: (error: string, rep: CreateMigrateCheckJobResponse) => void): Promise<CreateMigrateCheckJobResponse>;
207
207
  /**
@@ -237,12 +237,12 @@ export declare class Client extends AbstractClient {
237
237
  */
238
238
  CreateSubscribe(req: CreateSubscribeRequest, cb?: (error: string, rep: CreateSubscribeResponse) => void): Promise<CreateSubscribeResponse>;
239
239
  /**
240
- * 解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。
240
+ * 解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。注意,此接口只支持按量计费实例。
241
241
  */
242
242
  RecoverSyncJob(req: RecoverSyncJobRequest, cb?: (error: string, rep: RecoverSyncJobResponse) => void): Promise<RecoverSyncJobResponse>;
243
243
  /**
244
244
  * 本接口(ResetSubscribe)用于重置订阅实例,重置后,可以重新配置订阅任务。
245
- 可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
245
+ 可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
246
246
  */
247
247
  ResetSubscribe(req: ResetSubscribeRequest, cb?: (error: string, rep: ResetSubscribeResponse) => void): Promise<ResetSubscribeResponse>;
248
248
  /**
@@ -94,7 +94,7 @@ class Client extends abstract_client_1.AbstractClient {
94
94
  return this.request("DescribeSubscribeReturnable", req, cb);
95
95
  }
96
96
  /**
97
- * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
97
+ * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线(DestroySyncJob)操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
98
98
  */
99
99
  async IsolateSyncJob(req, cb) {
100
100
  return this.request("IsolateSyncJob", req, cb);
@@ -124,7 +124,8 @@ class Client extends abstract_client_1.AbstractClient {
124
124
  return this.request("DescribeConsumerGroups", req, cb);
125
125
  }
126
126
  /**
127
- * 为订阅实例创建消费者组
127
+ * 为订阅实例创建消费者组。
128
+ 只有状态为运行中的实例支持创建消费组。
128
129
  */
129
130
  async CreateConsumerGroup(req, cb) {
130
131
  return this.request("CreateConsumerGroup", req, cb);
@@ -312,10 +313,9 @@ class Client extends abstract_client_1.AbstractClient {
312
313
  return this.request("CreateSubscribeCheckJob", req, cb);
313
314
  }
314
315
  /**
315
- * 校验迁移任务,
316
+ * 创建校验迁移任务,
316
317
  在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移. 校验的结果可以通过DescribeMigrationCheckJob查看,
317
318
  校验成功后,迁移任务若有修改, 则必须重新校验并通过后, 才能开始迁移
318
-
319
319
  */
320
320
  async CreateMigrateCheckJob(req, cb) {
321
321
  return this.request("CreateMigrateCheckJob", req, cb);
@@ -369,14 +369,14 @@ class Client extends abstract_client_1.AbstractClient {
369
369
  return this.request("CreateSubscribe", req, cb);
370
370
  }
371
371
  /**
372
- * 解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。
372
+ * 解除隔离同步任务,任务在已隔离状态下可调用该接口解除隔离状态任务,同时可通过查询同步任务信息接口DescribeSyncJobs,获取操作后状态。注意,此接口只支持按量计费实例。
373
373
  */
374
374
  async RecoverSyncJob(req, cb) {
375
375
  return this.request("RecoverSyncJob", req, cb);
376
376
  }
377
377
  /**
378
378
  * 本接口(ResetSubscribe)用于重置订阅实例,重置后,可以重新配置订阅任务。
379
- 可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
379
+ 可以调用 [DescribeSubscribeDetail](https://cloud.tencent.com/document/product/571/102944) 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时,表示重置成功。
380
380
  */
381
381
  async ResetSubscribe(req, cb) {
382
382
  return this.request("ResetSubscribe", req, cb);
@@ -87,15 +87,16 @@ export interface IsolateSubscribeResponse {
87
87
  */
88
88
  export interface ModifyConsumerGroupPasswordRequest {
89
89
  /**
90
- * 数据订阅实例的 ID
90
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
91
+
91
92
  */
92
93
  SubscribeId: string;
93
94
  /**
94
- * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}
95
+ * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
95
96
  */
96
97
  AccountName: string;
97
98
  /**
98
- * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
99
+ * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
99
100
  */
100
101
  ConsumerGroupName: string;
101
102
  /**
@@ -142,7 +143,8 @@ export interface ModifySyncRateLimitResponse {
142
143
  */
143
144
  export interface DestroyMigrateJobRequest {
144
145
  /**
145
- * 任务id
146
+ * 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
147
+
146
148
  */
147
149
  JobId?: string;
148
150
  }
@@ -151,7 +153,7 @@ export interface DestroyMigrateJobRequest {
151
153
  */
152
154
  export interface ModifySubscribeNameRequest {
153
155
  /**
154
- * 数据订阅实例的ID
156
+ * 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
155
157
  */
156
158
  SubscribeId: string;
157
159
  /**
@@ -190,7 +192,8 @@ export interface SkipCheckItemResponse {
190
192
  */
191
193
  export interface ResumeSyncJobRequest {
192
194
  /**
193
- * 同步任务id
195
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
196
+
194
197
  */
195
198
  JobId: string;
196
199
  }
@@ -243,7 +246,7 @@ export interface ResizeSyncJobResponse {
243
246
  */
244
247
  export interface CreateSubscribeCheckJobRequest {
245
248
  /**
246
- * 数据订阅实例的 ID
249
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
247
250
  */
248
251
  SubscribeId: string;
249
252
  }
@@ -310,7 +313,7 @@ export interface DifferenceItem {
310
313
  */
311
314
  export interface CreateModifyCheckSyncJobRequest {
312
315
  /**
313
- * 同步任务id
316
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
314
317
  */
315
318
  JobId: string;
316
319
  }
@@ -319,7 +322,7 @@ export interface CreateModifyCheckSyncJobRequest {
319
322
  */
320
323
  export interface IsolateSyncJobRequest {
321
324
  /**
322
- * 同步任务id
325
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
323
326
  */
324
327
  JobId: string;
325
328
  }
@@ -328,7 +331,8 @@ export interface IsolateSyncJobRequest {
328
331
  */
329
332
  export interface PauseMigrateJobRequest {
330
333
  /**
331
- * 数据迁移任务ID
334
+ * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
335
+
332
336
  */
333
337
  JobId: string;
334
338
  }
@@ -337,7 +341,8 @@ export interface PauseMigrateJobRequest {
337
341
  */
338
342
  export interface ContinueMigrateJobRequest {
339
343
  /**
340
- * 数据迁移任务ID
344
+ * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
345
+
341
346
  */
342
347
  JobId: string;
343
348
  }
@@ -404,7 +409,8 @@ export interface ModifySyncRateLimitRequest {
404
409
  */
405
410
  export interface DescribeCheckSyncJobResultRequest {
406
411
  /**
407
- * 同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填
412
+ * 同步实例id(即标识一个同步作业),形如sync-werwfs23,此值必填,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
413
+
408
414
  */
409
415
  JobId?: string;
410
416
  }
@@ -675,7 +681,8 @@ export interface DifferenceData {
675
681
  */
676
682
  export interface CreateCheckSyncJobRequest {
677
683
  /**
678
- * 同步任务id
684
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
685
+
679
686
  */
680
687
  JobId: string;
681
688
  }
@@ -723,7 +730,7 @@ export interface StartSubscribeResponse {
723
730
  */
724
731
  export interface DescribeSubscribeReturnableRequest {
725
732
  /**
726
- * 数据订阅实例的ID
733
+ * 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
727
734
  */
728
735
  SubscribeId: string;
729
736
  }
@@ -741,7 +748,8 @@ export interface DescribeMigrationDetailRequest {
741
748
  */
742
749
  export interface CreateConsumerGroupRequest {
743
750
  /**
744
- * 订阅实例id
751
+ * 订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
752
+
745
753
  */
746
754
  SubscribeId: string;
747
755
  /**
@@ -882,7 +890,7 @@ export interface StartSyncJobRequest {
882
890
  */
883
891
  export interface StartSubscribeRequest {
884
892
  /**
885
- * 数据订阅实例的 ID
893
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
886
894
  */
887
895
  SubscribeId: string;
888
896
  }
@@ -913,7 +921,8 @@ export interface DescribeOffsetByTimeResponse {
913
921
  */
914
922
  export interface PauseSyncJobRequest {
915
923
  /**
916
- * 同步任务id
924
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
925
+
917
926
  */
918
927
  JobId: string;
919
928
  }
@@ -1056,7 +1065,7 @@ export interface DescribeCompareTasksRequest {
1056
1065
  */
1057
1066
  export interface DestroyIsolatedSubscribeRequest {
1058
1067
  /**
1059
- * 数据订阅实例的ID
1068
+ * 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1060
1069
  */
1061
1070
  SubscribeId: string;
1062
1071
  }
@@ -1140,7 +1149,7 @@ export interface ConfigureSubscribeJobResponse {
1140
1149
  */
1141
1150
  export interface DescribeConsumerGroupsRequest {
1142
1151
  /**
1143
- * 订阅实例id
1152
+ * 订阅实例id,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1144
1153
  */
1145
1154
  SubscribeId: string;
1146
1155
  /**
@@ -1270,7 +1279,7 @@ export interface DBEndpointInfo {
1270
1279
  */
1271
1280
  export interface ResumeSubscribeRequest {
1272
1281
  /**
1273
- * 数据订阅实例的 ID
1282
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1274
1283
  */
1275
1284
  SubscribeId: string;
1276
1285
  }
@@ -1509,17 +1518,18 @@ export interface DifferenceDataDetail {
1509
1518
  */
1510
1519
  export interface DeleteConsumerGroupRequest {
1511
1520
  /**
1512
- * 数据订阅实例的 ID
1521
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1522
+
1513
1523
  */
1514
1524
  SubscribeId: string;
1515
1525
  /**
1516
1526
  * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
1517
- 请务必保证消费组名称正确。
1527
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
1518
1528
  */
1519
1529
  ConsumerGroupName: string;
1520
1530
  /**
1521
1531
  * 账号名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
1522
- 请务必保证账户名称正确。
1532
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
1523
1533
  */
1524
1534
  AccountName: string;
1525
1535
  }
@@ -1528,7 +1538,7 @@ export interface DeleteConsumerGroupRequest {
1528
1538
  */
1529
1539
  export interface ModifySubscribeAutoRenewFlagRequest {
1530
1540
  /**
1531
- * 订阅实例ID
1541
+ * 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1532
1542
  */
1533
1543
  SubscribeId: string;
1534
1544
  /**
@@ -1602,7 +1612,8 @@ export interface SyncDBEndpointInfos {
1602
1612
  */
1603
1613
  export interface StartModifySyncJobRequest {
1604
1614
  /**
1605
- * 同步任务id
1615
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1616
+
1606
1617
  */
1607
1618
  JobId: string;
1608
1619
  }
@@ -1689,7 +1700,7 @@ export interface MigrateOption {
1689
1700
  */
1690
1701
  export interface DescribeSubscribeDetailRequest {
1691
1702
  /**
1692
- * 订阅实例ID
1703
+ * 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
1693
1704
  */
1694
1705
  SubscribeId: string;
1695
1706
  }
@@ -1885,7 +1896,8 @@ export interface SkipSyncCheckItemRequest {
1885
1896
  */
1886
1897
  export interface DescribeModifyCheckSyncJobResultRequest {
1887
1898
  /**
1888
- * 同步任务id
1899
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
1900
+
1889
1901
  */
1890
1902
  JobId: string;
1891
1903
  }
@@ -1912,7 +1924,8 @@ export interface IsolateSyncJobResponse {
1912
1924
  */
1913
1925
  export interface CreateMigrateCheckJobRequest {
1914
1926
  /**
1915
- * 数据迁移任务ID
1927
+ * 数据迁移任务ID,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
1928
+
1916
1929
  */
1917
1930
  JobId: string;
1918
1931
  }
@@ -2012,17 +2025,17 @@ export interface CompareTaskInfo {
2012
2025
  */
2013
2026
  export interface ModifyConsumerGroupDescriptionRequest {
2014
2027
  /**
2015
- * 数据订阅实例的 ID
2028
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
2016
2029
  */
2017
2030
  SubscribeId: string;
2018
2031
  /**
2019
2032
  * 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。
2020
- 请务必保证消费组名称正确。
2033
+ 请务必保证消费组名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
2021
2034
  */
2022
2035
  ConsumerGroupName: string;
2023
2036
  /**
2024
2037
  * 账户名称。实际的账户全称形如:account-#{SubscribeId}-#{AccountName}。
2025
- 请务必保证账户名称正确。
2038
+ 请务必保证账户名称正确。可通过[DescribeConsumerGroups](https://cloud.tencent.com/document/product/571/102947)接口获取。
2026
2039
  */
2027
2040
  AccountName: string;
2028
2041
  /**
@@ -2035,7 +2048,8 @@ export interface ModifyConsumerGroupDescriptionRequest {
2035
2048
  */
2036
2049
  export interface ContinueSyncJobRequest {
2037
2050
  /**
2038
- * 同步任务id
2051
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2052
+
2039
2053
  */
2040
2054
  JobId: string;
2041
2055
  }
@@ -2113,7 +2127,8 @@ export interface DescribeMigrationCheckJobResponse {
2113
2127
  */
2114
2128
  export interface StopSyncJobRequest {
2115
2129
  /**
2116
- * 同步任务id
2130
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2131
+
2117
2132
  */
2118
2133
  JobId: string;
2119
2134
  }
@@ -2263,7 +2278,8 @@ export interface TopicRule {
2263
2278
  */
2264
2279
  export interface DestroySyncJobRequest {
2265
2280
  /**
2266
- * 同步任务id
2281
+ * 同步任务id,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2282
+
2267
2283
  */
2268
2284
  JobId: string;
2269
2285
  }
@@ -2421,15 +2437,16 @@ export interface CompareObjectItem {
2421
2437
  */
2422
2438
  export interface ConfigureSyncJobRequest {
2423
2439
  /**
2424
- * 同步实例id(即标识一个同步作业),形如sync-werwfs23
2440
+ * 同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2441
+
2425
2442
  */
2426
2443
  JobId: string;
2427
2444
  /**
2428
- * 源端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
2445
+ * 源端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路
2429
2446
  */
2430
2447
  SrcAccessType: string;
2431
2448
  /**
2432
- * 目标端接入类型,cdb(云数据库)、cvm(云主机自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
2449
+ * 目标端接入类型,cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路
2433
2450
  */
2434
2451
  DstAccessType: string;
2435
2452
  /**
@@ -2682,7 +2699,8 @@ export interface StopMigrateJobRequest {
2682
2699
  */
2683
2700
  export interface RecoverSyncJobRequest {
2684
2701
  /**
2685
- * 同步实例id(即标识一个同步作业),形如sync-werwfs23
2702
+ * 同步实例id(即标识一个同步作业),形如sync-werwfs23,可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
2703
+
2686
2704
  */
2687
2705
  JobId: string;
2688
2706
  }
@@ -3212,7 +3230,7 @@ export interface DescribeSubscribeCheckJobRequest {
3212
3230
  */
3213
3231
  export interface ModifySubscribeObjectsRequest {
3214
3232
  /**
3215
- * 数据订阅实例的ID
3233
+ * 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
3216
3234
  */
3217
3235
  SubscribeId: string;
3218
3236
  /**
@@ -3220,7 +3238,7 @@ export interface ModifySubscribeObjectsRequest {
3220
3238
  */
3221
3239
  SubscribeObjectType: number;
3222
3240
  /**
3223
- * 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则改字段必填。
3241
+ * 修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。
3224
3242
  */
3225
3243
  Objects?: Array<ModifiedSubscribeObject>;
3226
3244
  /**
@@ -3277,7 +3295,7 @@ export interface MonitorInfo {
3277
3295
  */
3278
3296
  export interface DescribeOffsetByTimeRequest {
3279
3297
  /**
3280
- * 数据订阅实例的 ID
3298
+ * 数据订阅实例的 ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
3281
3299
  */
3282
3300
  SubscribeId: string;
3283
3301
  /**
@@ -3740,7 +3758,8 @@ export interface EndpointItem {
3740
3758
  */
3741
3759
  export interface DescribeMigrationCheckJobRequest {
3742
3760
  /**
3743
- * 任务id
3761
+ * 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
3762
+
3744
3763
  */
3745
3764
  JobId: string;
3746
3765
  }
@@ -4616,11 +4635,11 @@ export interface SubscribeKafkaConfig {
4616
4635
  */
4617
4636
  export interface DescribeCompareReportRequest {
4618
4637
  /**
4619
- * 迁移任务 Id
4638
+ * 迁移任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4620
4639
  */
4621
4640
  JobId: string;
4622
4641
  /**
4623
- * 校验任务 Id
4642
+ * 校验任务 Id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4624
4643
  */
4625
4644
  CompareTaskId: string;
4626
4645
  /**
@@ -4682,7 +4701,7 @@ export interface SkippedItem {
4682
4701
  */
4683
4702
  export interface IsolateSubscribeRequest {
4684
4703
  /**
4685
- * 订阅实例ID
4704
+ * 订阅实例ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4686
4705
  */
4687
4706
  SubscribeId: string;
4688
4707
  }
@@ -4721,7 +4740,8 @@ export interface TagItem {
4721
4740
  */
4722
4741
  export interface RecoverMigrateJobRequest {
4723
4742
  /**
4724
- * 任务id
4743
+ * 任务id,可通过[DescribeMigrationJobs](https://cloud.tencent.com/document/product/571/82084)接口获取。
4744
+
4725
4745
  */
4726
4746
  JobId: string;
4727
4747
  }
@@ -4756,7 +4776,8 @@ export interface DescribeSubscribeJobsResponse {
4756
4776
  */
4757
4777
  export interface ResetSubscribeRequest {
4758
4778
  /**
4759
- * 数据订阅实例的ID
4779
+ * 数据订阅实例的ID,可通过[DescribeSubscribeJobs](https://cloud.tencent.com/document/product/571/102943)接口获取。
4780
+
4760
4781
  */
4761
4782
  SubscribeId: string;
4762
4783
  }
@@ -142,6 +142,10 @@ export interface CreateSealRequest {
142
142
  * 印章描述内容
143
143
  */
144
144
  SealDescription?: string;
145
+ /**
146
+ * 个性化配置字段,默认不传。
147
+ */
148
+ Options?: Array<Option>;
145
149
  }
146
150
  /**
147
151
  * ModifyIntegrationDepartment返回参数结构体
@@ -337,6 +341,14 @@ export interface IntentionQuestionResult {
337
341
  * OperateSeals返回参数结构体
338
342
  */
339
343
  export interface OperateSealsResponse {
344
+ /**
345
+ * 人脸验证操作人链接,用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)",默认为空。
346
+ */
347
+ SealOperatorVerifyPath?: string;
348
+ /**
349
+ * 人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。
350
+ */
351
+ SealOperatorVerifyQrcodeUrl?: string;
340
352
  /**
341
353
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
342
354
  */
@@ -1828,6 +1840,10 @@ export interface OperateSealsRequest {
1828
1840
  * 需要操作的印章ID,数组形式,印章ID可从【web控制台->印章 】获取。
1829
1841
  */
1830
1842
  SealIds?: Array<string>;
1843
+ /**
1844
+ * 个性化配置字段,默认不传。
1845
+ */
1846
+ Options?: Array<Option>;
1831
1847
  }
1832
1848
  /**
1833
1849
  * 企业员工信息。
@@ -2510,6 +2526,14 @@ export interface CreateSealResponse {
2510
2526
  可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
2511
2527
  */
2512
2528
  SealId?: string;
2529
+ /**
2530
+ * 人脸验证操作人链接,用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)",默认为空。
2531
+ */
2532
+ SealOperatorVerifyPath?: string;
2533
+ /**
2534
+ * 人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。
2535
+ */
2536
+ SealOperatorVerifyQrcodeUrl?: string;
2513
2537
  /**
2514
2538
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2515
2539
  */
@@ -2535,8 +2559,12 @@ export interface MiniAppCreateFlowOption {
2535
2559
  * 小程序集成发起,是否禁止发起时修改合同内容
2536
2560
  <ul>
2537
2561
  <li>false:默认值,不禁止发起时修改合同内容</li>
2538
- <li>true:禁止发起时修改合同内容</li>
2562
+ <li>true:禁止发起时修改合同内容(将直接跳过添加/编辑签署人步骤,直接到核对合同信息页面</li>
2539
2563
  </ul>
2564
+ 指定为true,效果如下:
2565
+
2566
+ 效果如下:![ForbidEditFlow](https://qcloudimg.tencent-cloud.cn/raw/2440eca624f2f6730fecbf69daad0533.jpg)
2567
+
2540
2568
  */
2541
2569
  ForbidEditFlow?: boolean;
2542
2570
  }
@@ -4139,6 +4167,14 @@ export interface CreateSealPolicyResponse {
4139
4167
  可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4140
4168
  */
4141
4169
  UserIds?: Array<string>;
4170
+ /**
4171
+ * 人脸验证操作人链接,用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)",默认为空。
4172
+ */
4173
+ SealOperatorVerifyPath?: string;
4174
+ /**
4175
+ * 人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。
4176
+ */
4177
+ SealOperatorVerifyQrcodeUrl?: string;
4142
4178
  /**
4143
4179
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4144
4180
  */
@@ -8141,6 +8177,10 @@ export interface CreateSealPolicyRequest {
8141
8177
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8142
8178
  */
8143
8179
  Agent?: Agent;
8180
+ /**
8181
+ * 个性化配置字段,默认不传。
8182
+ */
8183
+ Options?: Array<Option>;
8144
8184
  }
8145
8185
  /**
8146
8186
  * DescribeContractReviewTask返回参数结构体
@@ -9716,6 +9756,21 @@ export interface CreateBatchOrganizationRegistrationTasksResponse {
9716
9756
  */
9717
9757
  RequestId?: string;
9718
9758
  }
9759
+ /**
9760
+ * 业务逻辑个性化配置字段,默认不传
9761
+
9762
+ 注: `配置前请联系对接的客户经理沟通确认。`
9763
+ */
9764
+ export interface Option {
9765
+ /**
9766
+ * 个性化配置参数Key字段,对应传入字段的字段名
9767
+ */
9768
+ Key: string;
9769
+ /**
9770
+ * 个性化配置参数Value字段,对应传入字段的字段值
9771
+ */
9772
+ Value: string;
9773
+ }
9719
9774
  /**
9720
9775
  * DescribeBillUsageDetail请求参数结构体
9721
9776
  */