tencentcloud-sdk-nodejs 4.0.491 → 4.0.493

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 (50) hide show
  1. package/CHANGELOG.md +73 -0
  2. package/SERVICE_CHANGELOG.md +96 -210
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/batch/v20170312/batch_models.ts +2 -2
  7. package/src/services/cdb/v20170320/cdb_models.ts +1 -1
  8. package/src/services/cdwch/v20200915/cdwch_client.ts +16 -2
  9. package/src/services/cdwch/v20200915/cdwch_models.ts +150 -10
  10. package/src/services/cls/v20201016/cls_models.ts +1 -1
  11. package/src/services/cvm/v20170312/cvm_client.ts +1 -1
  12. package/src/services/cvm/v20170312/cvm_models.ts +13 -13
  13. package/src/services/dts/v20211206/dts_client.ts +2 -2
  14. package/src/services/dts/v20211206/dts_models.ts +6 -6
  15. package/src/services/es/v20180416/es_models.ts +24 -12
  16. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +36 -26
  18. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +1 -1
  19. package/src/services/lcic/v20220817/lcic_models.ts +14 -14
  20. package/src/services/lighthouse/v20200324/lighthouse_client.ts +42 -16
  21. package/src/services/lighthouse/v20200324/lighthouse_models.ts +163 -43
  22. package/src/services/tcm/v20210413/tcm_models.ts +2 -2
  23. package/src/services/vod/v20180717/vod_models.ts +27 -29
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  27. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
  28. package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +5 -1
  29. package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +6 -0
  30. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +127 -10
  31. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  32. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -1
  33. package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -1
  34. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +13 -13
  35. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +2 -2
  36. package/tencentcloud/services/dts/v20211206/dts_client.js +2 -2
  37. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +6 -6
  38. package/tencentcloud/services/es/v20180416/es_models.d.ts +14 -2
  39. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  40. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +32 -24
  42. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +1 -1
  43. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +14 -14
  44. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +13 -5
  45. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +18 -6
  46. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +141 -39
  47. package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +2 -2
  48. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +24 -28
  49. package/test/cdwch.v20200915.test.js +10 -0
  50. package/test/lighthouse.v20200324.test.js +24 -4
@@ -57,6 +57,12 @@ class Client extends abstract_client_1.AbstractClient {
57
57
  async ModifyClusterConfigs(req, cb) {
58
58
  return this.request("ModifyClusterConfigs", req, cb);
59
59
  }
60
+ /**
61
+ * 购买页拉取集群的数据节点和zookeeper节点的规格列表
62
+ */
63
+ async DescribeSpec(req, cb) {
64
+ return this.request("DescribeSpec", req, cb);
65
+ }
60
66
  /**
61
67
  * 针对ck账号的权限做管控(新版)
62
68
  */
@@ -8,9 +8,22 @@ export interface DescribeInstanceShardsRequest {
8
8
  InstanceId: string;
9
9
  }
10
10
  /**
11
- * ModifyUserNewPrivilege请求参数结构体
11
+ * ModifyClusterConfigs请求参数结构体
12
12
  */
13
- export declare type ModifyUserNewPrivilegeRequest = null;
13
+ export interface ModifyClusterConfigsRequest {
14
+ /**
15
+ * 集群ID,例如cdwch-xxxx
16
+ */
17
+ InstanceId: string;
18
+ /**
19
+ * 配置文件修改信息
20
+ */
21
+ ModifyConfContext: Array<ConfigSubmitContext>;
22
+ /**
23
+ * 修改原因
24
+ */
25
+ Remark?: string;
26
+ }
14
27
  /**
15
28
  * CreateBackUpSchedule请求参数结构体
16
29
  */
@@ -80,6 +93,31 @@ export interface ModifyClusterConfigsResponse {
80
93
  */
81
94
  RequestId?: string;
82
95
  }
96
+ /**
97
+ * 磁盘规格描述
98
+ */
99
+ export interface DiskSpec {
100
+ /**
101
+ * 磁盘类型,例如“CLOUD_SSD", "LOCAL_SSD"等
102
+ */
103
+ DiskType: string;
104
+ /**
105
+ * 磁盘类型说明,例如"云SSD", "本地SSD"等
106
+ */
107
+ DiskDesc: string;
108
+ /**
109
+ * 磁盘最小规格大小,单位G
110
+ */
111
+ MinDiskSize: number;
112
+ /**
113
+ * 磁盘最大规格大小,单位G
114
+ */
115
+ MaxDiskSize: number;
116
+ /**
117
+ * 磁盘数目
118
+ */
119
+ DiskCount: number;
120
+ }
83
121
  /**
84
122
  * 备份表信息
85
123
  */
@@ -114,6 +152,27 @@ export interface OpenBackUpResponse {
114
152
  */
115
153
  RequestId?: string;
116
154
  }
155
+ /**
156
+ * ModifyUserNewPrivilege请求参数结构体
157
+ */
158
+ export declare type ModifyUserNewPrivilegeRequest = null;
159
+ /**
160
+ * DescribeSpec请求参数结构体
161
+ */
162
+ export interface DescribeSpecRequest {
163
+ /**
164
+ * 地域信息,例如"ap-guangzhou-1"
165
+ */
166
+ Zone: string;
167
+ /**
168
+ * 计费类型,PREPAID 包年包月,POSTPAID_BY_HOUR 按量计费
169
+ */
170
+ PayMode?: string;
171
+ /**
172
+ * 是否弹性ck
173
+ */
174
+ IsElastic?: boolean;
175
+ }
117
176
  /**
118
177
  * 配置文件修改信息
119
178
  */
@@ -214,21 +273,79 @@ export interface CreateBackUpScheduleResponse {
214
273
  RequestId?: string;
215
274
  }
216
275
  /**
217
- * ModifyClusterConfigs请求参数结构体
276
+ * 资源规格描述信息
218
277
  */
219
- export interface ModifyClusterConfigsRequest {
278
+ export interface ResourceSpec {
220
279
  /**
221
- * 集群ID,例如cdwch-xxxx
280
+ * 规格名称,例如“SCH1"
222
281
  */
223
- InstanceId: string;
282
+ Name: string;
224
283
  /**
225
- * 配置文件修改信息
284
+ * cpu核数
226
285
  */
227
- ModifyConfContext: Array<ConfigSubmitContext>;
286
+ Cpu: number;
228
287
  /**
229
- * 修改原因
288
+ * 内存大小,单位G
230
289
  */
231
- Remark?: string;
290
+ Mem: number;
291
+ /**
292
+ * 分类标记,STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO
293
+ */
294
+ Type: string;
295
+ /**
296
+ * 系统盘描述信息
297
+ */
298
+ SystemDisk: DiskSpec;
299
+ /**
300
+ * 数据盘描述信息
301
+ */
302
+ DataDisk: DiskSpec;
303
+ /**
304
+ * 最大节点数目限制
305
+ */
306
+ MaxNodeSize: number;
307
+ /**
308
+ * 是否可用,false代表售罄
309
+ 注意:此字段可能返回 null,表示取不到有效值。
310
+ */
311
+ Available: boolean;
312
+ /**
313
+ * 规格描述信息
314
+ 注意:此字段可能返回 null,表示取不到有效值。
315
+ */
316
+ ComputeSpecDesc: string;
317
+ /**
318
+ * 规格名
319
+ 注意:此字段可能返回 null,表示取不到有效值。
320
+ */
321
+ DisplayName: string;
322
+ /**
323
+ * 库存数
324
+ 注意:此字段可能返回 null,表示取不到有效值。
325
+ */
326
+ InstanceQuota: number;
327
+ }
328
+ /**
329
+ * DescribeSpec返回参数结构体
330
+ */
331
+ export interface DescribeSpecResponse {
332
+ /**
333
+ * zookeeper节点规格描述
334
+ */
335
+ CommonSpec: Array<ResourceSpec>;
336
+ /**
337
+ * 数据节点规格描述
338
+ */
339
+ DataSpec: Array<ResourceSpec>;
340
+ /**
341
+ * 云盘列表
342
+ 注意:此字段可能返回 null,表示取不到有效值。
343
+ */
344
+ AttachCBSSpec: Array<DiskSpec>;
345
+ /**
346
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
347
+ */
348
+ RequestId?: string;
232
349
  }
233
350
  /**
234
351
  * DescribeCkSqlApis返回参数结构体
@@ -228,7 +228,7 @@ export interface ModifyTopicRequest {
228
228
  */
229
229
  MaxSplitPartitions?: number;
230
230
  /**
231
- * 生命周期,单位天,标准存储取值范围1~3600,低频存储取值范围7~3600。取值为3640时代表永久保存
231
+ * 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存
232
232
  */
233
233
  Period?: number;
234
234
  }
@@ -62,7 +62,7 @@ export declare class Client extends AbstractClient {
62
62
  */
63
63
  ModifyLaunchTemplateDefaultVersion(req: ModifyLaunchTemplateDefaultVersionRequest, cb?: (error: string, rep: ModifyLaunchTemplateDefaultVersionResponse) => void): Promise<ModifyLaunchTemplateDefaultVersionResponse>;
64
64
  /**
65
- * 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络ip
65
+ * 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络IP
66
66
  * 此操作默认会关闭实例,完成后再启动。
67
67
  * 当指定私有网络ID和子网ID(子网必须在实例所在的可用区)与指定实例所在私有网络不一致时,会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/document/product/214)。
68
68
  * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
@@ -96,7 +96,7 @@ class Client extends abstract_client_1.AbstractClient {
96
96
  return this.request("ModifyLaunchTemplateDefaultVersion", req, cb);
97
97
  }
98
98
  /**
99
- * 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络ip
99
+ * 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络IP
100
100
  * 此操作默认会关闭实例,完成后再启动。
101
101
  * 当指定私有网络ID和子网ID(子网必须在实例所在的可用区)与指定实例所在私有网络不一致时,会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/document/product/214)。
102
102
  * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
@@ -137,11 +137,11 @@ export interface ResetInstancesTypeResponse {
137
137
  */
138
138
  export interface HostResource {
139
139
  /**
140
- * 专用宿主机实例总cpu核数
140
+ * 专用宿主机实例总CPU核数
141
141
  */
142
142
  CpuTotal?: number;
143
143
  /**
144
- * 专用宿主机实例可用cpu核数
144
+ * 专用宿主机实例可用CPU核数
145
145
  */
146
146
  CpuAvailable?: number;
147
147
  /**
@@ -1538,7 +1538,7 @@ export interface CreateHpcClusterResponse {
1538
1538
  RequestId?: string;
1539
1539
  }
1540
1540
  /**
1541
- * 描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机ip
1541
+ * 描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机IP
1542
1542
  */
1543
1543
  export interface Placement {
1544
1544
  /**
@@ -1554,7 +1554,7 @@ export interface Placement {
1554
1554
  */
1555
1555
  HostIds?: Array<string>;
1556
1556
  /**
1557
- * 指定母机ip生产子机
1557
+ * 指定母机IP生产子机
1558
1558
  */
1559
1559
  HostIps?: Array<string>;
1560
1560
  /**
@@ -2333,7 +2333,7 @@ export interface LaunchTemplateVersionData {
2333
2333
  */
2334
2334
  UserData?: string;
2335
2335
  /**
2336
- * 置放群组id,仅支持指定一个。
2336
+ * 置放群组ID,仅支持指定一个。
2337
2337
  注意:此字段可能返回 null,表示取不到有效值。
2338
2338
  */
2339
2339
  DisasterRecoverGroupIds?: Array<string>;
@@ -2386,7 +2386,7 @@ export interface HostItem {
2386
2386
  */
2387
2387
  Placement?: Placement;
2388
2388
  /**
2389
- * 专用宿主机实例id
2389
+ * 专用宿主机实例ID
2390
2390
  */
2391
2391
  HostId?: string;
2392
2392
  /**
@@ -2422,7 +2422,7 @@ export interface HostItem {
2422
2422
  */
2423
2423
  HostState?: string;
2424
2424
  /**
2425
- * 专用宿主机实例ip
2425
+ * 专用宿主机实例IP
2426
2426
  */
2427
2427
  HostIp?: string;
2428
2428
  /**
@@ -2522,7 +2522,7 @@ export interface CreateImageRequest {
2522
2522
  */
2523
2523
  Sysprep?: string;
2524
2524
  /**
2525
- * 基于实例创建整机镜像时,指定包含在镜像里的数据盘Id
2525
+ * 基于实例创建整机镜像时,指定包含在镜像里的数据盘ID
2526
2526
  */
2527
2527
  DataDiskIds?: Array<string>;
2528
2528
  /**
@@ -4045,16 +4045,16 @@ export interface InquiryPriceTerminateInstancesRequest {
4045
4045
  InstanceIds: Array<string>;
4046
4046
  }
4047
4047
  /**
4048
- * 支持的操作系统类型,根据windows和Linux分类。
4048
+ * 支持的操作系统类型,根据Windows和Linux分类。
4049
4049
  */
4050
4050
  export interface ImageOsList {
4051
4051
  /**
4052
- * 支持的windows操作系统。
4052
+ * 支持的Windows操作系统。
4053
4053
  注意:此字段可能返回 null,表示取不到有效值。
4054
4054
  */
4055
4055
  Windows: Array<string>;
4056
4056
  /**
4057
- * 支持的linux操作系统
4057
+ * 支持的Linux操作系统
4058
4058
  注意:此字段可能返回 null,表示取不到有效值。
4059
4059
  */
4060
4060
  Linux: Array<string>;
@@ -4449,8 +4449,8 @@ export interface ReservedInstancePriceItem {
4449
4449
  */
4450
4450
  Duration: number;
4451
4451
  /**
4452
- * 预留实例计费的平台描述(即操作系统)。形如:linux
4453
- 返回项: linux
4452
+ * 预留实例计费的平台描述(即操作系统)。形如:Linux
4453
+ 返回项: Linux
4454
4454
  */
4455
4455
  ProductDescription: string;
4456
4456
  }
@@ -73,7 +73,7 @@ export declare class Client extends AbstractClient {
73
73
  */
74
74
  StopMigrateJob(req: StopMigrateJobRequest, cb?: (error: string, rep: StopMigrateJobResponse) => void): Promise<StopMigrateJobResponse>;
75
75
  /**
76
- * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs,获取下线后任务列表,此操作成功后无法看到此任务表示下线成功。
76
+ * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态,此操作成功后无法看到此任务表示下线成功。
77
77
  */
78
78
  DestroySyncJob(req: DestroySyncJobRequest, cb?: (error: string, rep: DestroySyncJobResponse) => void): Promise<DestroySyncJobResponse>;
79
79
  /**
@@ -157,7 +157,7 @@ export declare class Client extends AbstractClient {
157
157
  */
158
158
  ModifyMigrateName(req: ModifyMigrateNameRequest, cb?: (error: string, rep: ModifyMigrateNameResponse) => void): Promise<ModifyMigrateNameResponse>;
159
159
  /**
160
- * 销毁(隔离)同步任务,销毁后可通过查询同步任务信息接口DescribeSyncJobs,获取销毁后状态。在任务销毁后可进行解除隔离(RecoverSyncJob)操作或直接进行立即下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
160
+ * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
161
161
  */
162
162
  IsolateSyncJob(req: IsolateSyncJobRequest, cb?: (error: string, rep: IsolateSyncJobResponse) => void): Promise<IsolateSyncJobResponse>;
163
163
  }
@@ -125,7 +125,7 @@ class Client extends abstract_client_1.AbstractClient {
125
125
  return this.request("StopMigrateJob", req, cb);
126
126
  }
127
127
  /**
128
- * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs,获取下线后任务列表,此操作成功后无法看到此任务表示下线成功。
128
+ * 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态,此操作成功后无法看到此任务表示下线成功。
129
129
  */
130
130
  async DestroySyncJob(req, cb) {
131
131
  return this.request("DestroySyncJob", req, cb);
@@ -247,7 +247,7 @@ class Client extends abstract_client_1.AbstractClient {
247
247
  return this.request("ModifyMigrateName", req, cb);
248
248
  }
249
249
  /**
250
- * 销毁(隔离)同步任务,销毁后可通过查询同步任务信息接口DescribeSyncJobs,获取销毁后状态。在任务销毁后可进行解除隔离(RecoverSyncJob)操作或直接进行立即下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
250
+ * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
251
251
  */
252
252
  async IsolateSyncJob(req, cb) {
253
253
  return this.request("IsolateSyncJob", req, cb);
@@ -2766,7 +2766,7 @@ export interface StepDetailInfo {
2766
2766
  */
2767
2767
  export interface CreateSyncJobRequest {
2768
2768
  /**
2769
- * 支付类型,PrePay:包年包月 PostPay:按时按量
2769
+ * 付款类型, 如:PrePay(表示包年包月)、PostPay(表示按时按量)
2770
2770
  */
2771
2771
  PayMode: string;
2772
2772
  /**
@@ -2790,23 +2790,23 @@ export interface CreateSyncJobRequest {
2790
2790
  */
2791
2791
  Specification?: string;
2792
2792
  /**
2793
- *
2793
+ * 标签信息
2794
2794
  */
2795
2795
  Tags?: Array<TagItem>;
2796
2796
  /**
2797
- * 同步任务数量
2797
+ * 一次购买的同步任务数量,取值范围为[1, 10],默认为1
2798
2798
  */
2799
2799
  Count?: number;
2800
2800
  /**
2801
- * 自动续费标识
2801
+ * 自动续费标识,当PayMode值为PrePay则此项配置有意义,取值为:1(表示自动续费)、0(不自动续费,默认为此值)
2802
2802
  */
2803
2803
  AutoRenew?: number;
2804
2804
  /**
2805
- * 同步链路规格
2805
+ * 同步链路规格,如micro,small,medium,large,默认为medium
2806
2806
  */
2807
2807
  InstanceClass?: string;
2808
2808
  /**
2809
- * 同步链路名称
2809
+ * 同步任务名称
2810
2810
  */
2811
2811
  JobName?: string;
2812
2812
  /**
@@ -2839,7 +2839,9 @@ export interface UpdateInstanceRequest {
2839
2839
  */
2840
2840
  NodeInfoList?: Array<NodeInfo>;
2841
2841
  /**
2842
- * 公网访问状态
2842
+ * ES集群公网访问状态
2843
+ OPEN 开启
2844
+ CLOSE 关闭
2843
2845
  */
2844
2846
  PublicAccess?: string;
2845
2847
  /**
@@ -2848,10 +2850,14 @@ export interface UpdateInstanceRequest {
2848
2850
  EsPublicAcl?: EsPublicAcl;
2849
2851
  /**
2850
2852
  * Kibana公网访问状态
2853
+ OPEN 开启
2854
+ CLOSE 关闭
2851
2855
  */
2852
2856
  KibanaPublicAccess?: string;
2853
2857
  /**
2854
2858
  * Kibana内网访问状态
2859
+ OPEN 开启
2860
+ CLOSE 关闭
2855
2861
  */
2856
2862
  KibanaPrivateAccess?: string;
2857
2863
  /**
@@ -2892,10 +2898,14 @@ export interface UpdateInstanceRequest {
2892
2898
  EnableCerebro?: boolean;
2893
2899
  /**
2894
2900
  * Cerebro公网访问状态
2901
+ OPEN 开启
2902
+ CLOSE 关闭
2895
2903
  */
2896
2904
  CerebroPublicAccess?: string;
2897
2905
  /**
2898
2906
  * Cerebro内网访问状态
2907
+ OPEN 开启
2908
+ CLOSE 关闭
2899
2909
  */
2900
2910
  CerebroPrivateAccess?: string;
2901
2911
  /**
@@ -2907,7 +2917,9 @@ export interface UpdateInstanceRequest {
2907
2917
  */
2908
2918
  OperationDuration?: OperationDurationUpdated;
2909
2919
  /**
2910
- * 是否开启Altering 外网告警输出
2920
+ * 是否开启Alerting 外网告警输出:
2921
+ OPEN 开启
2922
+ CLOSE 关闭
2911
2923
  */
2912
2924
  KibanaAlteringPublicAccess?: string;
2913
2925
  }
@@ -82,7 +82,7 @@ export declare class Client extends AbstractClient {
82
82
  */
83
83
  CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
84
84
  /**
85
- * 此接口(CreateConsoleLoginUrl)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取
85
+ * 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。
86
86
  */
87
87
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
88
88
  /**
@@ -124,7 +124,7 @@ class Client extends abstract_client_1.AbstractClient {
124
124
  return this.request("CreateConsoleLoginUrl", req, cb);
125
125
  }
126
126
  /**
127
- * 此接口(CreateConsoleLoginUrl)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取
127
+ * 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。
128
128
  */
129
129
  async ChannelCreateBoundFlows(req, cb) {
130
130
  return this.request("ChannelCreateBoundFlows", req, cb);
@@ -319,11 +319,11 @@ export interface CreateSealByImageRequest {
319
319
  */
320
320
  Agent: Agent;
321
321
  /**
322
- * 印章名称,最大长度不超过30字符
322
+ * 印章名称,最大长度不超过50字符
323
323
  */
324
324
  SealName: string;
325
325
  /**
326
- * 印章图片base64
326
+ * 印章图片base64,大小不超过10M(原始图片不超过7.6M)
327
327
  */
328
328
  SealImage: string;
329
329
  /**
@@ -480,23 +480,23 @@ MobileCheck:手机号验证
480
480
  */
481
481
  export interface Agent {
482
482
  /**
483
- * 腾讯电子签颁发给渠道的应用ID,32位字符串
483
+ * 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
484
484
  */
485
485
  AppId: string;
486
486
  /**
487
- * 渠道/平台合作企业的企业ID,最大64位字符串
487
+ * 渠道平台自定义,对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要渠道平台保存),最大64位字符串
488
488
  */
489
489
  ProxyOrganizationOpenId?: string;
490
490
  /**
491
- * 渠道/平台合作企业经办人(操作员)
491
+ * 渠道子客企业中的员工/经办人,通过渠道平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
492
492
  */
493
493
  ProxyOperator?: UserInfo;
494
494
  /**
495
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
495
+ * 在子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
496
496
  */
497
497
  ProxyAppId?: string;
498
498
  /**
499
- * 内部参数,腾讯电子签颁发给渠道侧合作企业的企业ID,不需要传
499
+ * 内部参数,暂未开放使用
500
500
  */
501
501
  ProxyOrganizationId?: string;
502
502
  }
@@ -781,14 +781,14 @@ export interface TemplateInfo {
781
781
  * 模板控件信息结构
782
782
  */
783
783
  Components: Array<Component>;
784
- /**
785
- * 签署区模板信息结构
786
- */
787
- SignComponents: Array<Component>;
788
784
  /**
789
785
  * 模板中的流程参与人信息
790
786
  */
791
787
  Recipients: Array<Recipient>;
788
+ /**
789
+ * 签署区模板信息结构
790
+ */
791
+ SignComponents: Array<Component>;
792
792
  /**
793
793
  * 模板类型:1-静默签;3-普通模板
794
794
  */
@@ -812,9 +812,13 @@ export interface TemplateInfo {
812
812
  PreviewUrl: string;
813
813
  /**
814
814
  * 渠道模板ID
815
- 注意:此字段可能返回 null,表示取不到有效值。
816
815
  */
817
816
  ChannelTemplateId: string;
817
+ /**
818
+ * 渠道版-模板PDF文件链接
819
+ 注意:此字段可能返回 null,表示取不到有效值。
820
+ */
821
+ PdfUrl: string;
818
822
  }
819
823
  /**
820
824
  * GetDownloadFlowUrl返回参数结构体
@@ -1104,7 +1108,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
1104
1108
  */
1105
1109
  export interface ProxyOrganizationOperator {
1106
1110
  /**
1107
- * 经办人ID(渠道颁发),最大长度64个字符
1111
+ * 对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(比如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
1108
1112
  */
1109
1113
  Id: string;
1110
1114
  /**
@@ -1329,23 +1333,23 @@ export interface FlowInfo {
1329
1333
  */
1330
1334
  export interface UserInfo {
1331
1335
  /**
1332
- * 用户在渠道的编号,最大64位字符串
1336
+ * 渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
1333
1337
  */
1334
1338
  OpenId?: string;
1335
1339
  /**
1336
- * 用户的来源渠道
1340
+ * 内部参数,暂未开放使用
1337
1341
  */
1338
1342
  Channel?: string;
1339
1343
  /**
1340
- * 自定义用户编号
1344
+ * 内部参数,暂未开放使用
1341
1345
  */
1342
1346
  CustomUserId?: string;
1343
1347
  /**
1344
- * 用户真实IP
1348
+ * 内部参数,暂未开放使用
1345
1349
  */
1346
1350
  ClientIp?: string;
1347
1351
  /**
1348
- * 用户代理IP
1352
+ * 内部参数,暂未开放使用
1349
1353
  */
1350
1354
  ProxyIp?: string;
1351
1355
  }
@@ -1445,7 +1449,7 @@ export interface ChannelCreateBoundFlowsRequest {
1445
1449
  */
1446
1450
  FlowIds?: Array<string>;
1447
1451
  /**
1448
- * 操作者的信息
1452
+ * 暂未开放
1449
1453
  */
1450
1454
  Operator?: UserInfo;
1451
1455
  }
@@ -2155,6 +2159,10 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
2155
2159
  * ChannelCreateReleaseFlow请求参数结构体
2156
2160
  */
2157
2161
  export interface ChannelCreateReleaseFlowRequest {
2162
+ /**
2163
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
2164
+ */
2165
+ Agent: Agent;
2158
2166
  /**
2159
2167
  * 待解除的流程编号(即原流程的编号)
2160
2168
  */
@@ -2164,11 +2172,7 @@ export interface ChannelCreateReleaseFlowRequest {
2164
2172
  */
2165
2173
  ReliveInfo: RelieveInfo;
2166
2174
  /**
2167
- * 应用相关信息
2168
- */
2169
- Agent: Agent;
2170
- /**
2171
- * 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(比如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
2175
+ * 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
2172
2176
  */
2173
2177
  ReleasedApprovers?: Array<ReleasedApprover>;
2174
2178
  /**
@@ -2583,6 +2587,10 @@ export interface DescribeTemplatesRequest {
2583
2587
  * 是否获取模板预览链接
2584
2588
  */
2585
2589
  WithPreviewUrl?: boolean;
2590
+ /**
2591
+ * 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
2592
+ */
2593
+ WithPdfUrl?: boolean;
2586
2594
  }
2587
2595
  /**
2588
2596
  * 持有的电子印章信息
@@ -1940,7 +1940,7 @@ export interface DescribeDeviceLocationSolveResponse {
1940
1940
  */
1941
1941
  Longitude: number;
1942
1942
  /**
1943
- * 维度
1943
+ * 纬度
1944
1944
  */
1945
1945
  Latitude: number;
1946
1946
  /**