tencentcloud-sdk-nodejs 4.0.491 → 4.0.492
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.
- package/CHANGELOG.md +45 -0
- package/SERVICE_CHANGELOG.md +81 -200
- package/package.json +1 -1
- package/products.md +12 -12
- package/src/common/sdk_version.ts +1 -1
- package/src/services/batch/v20170312/batch_models.ts +2 -2
- package/src/services/cdb/v20170320/cdb_models.ts +1 -1
- package/src/services/cdwch/v20200915/cdwch_client.ts +16 -2
- package/src/services/cdwch/v20200915/cdwch_models.ts +150 -10
- package/src/services/cls/v20201016/cls_models.ts +1 -1
- package/src/services/cvm/v20170312/cvm_client.ts +1 -1
- package/src/services/cvm/v20170312/cvm_models.ts +13 -13
- package/src/services/dts/v20211206/dts_client.ts +2 -2
- package/src/services/dts/v20211206/dts_models.ts +6 -6
- package/src/services/es/v20180416/es_models.ts +24 -12
- package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
- package/src/services/essbasic/v20210526/essbasic_models.ts +36 -26
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +1 -1
- package/src/services/lcic/v20220817/lcic_models.ts +14 -14
- package/src/services/lighthouse/v20200324/lighthouse_client.ts +42 -16
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +163 -43
- package/src/services/tcm/v20210413/tcm_models.ts +2 -2
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
- package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +5 -1
- package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +6 -0
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +127 -10
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
- package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -1
- package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -1
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +13 -13
- package/tencentcloud/services/dts/v20211206/dts_client.d.ts +2 -2
- package/tencentcloud/services/dts/v20211206/dts_client.js +2 -2
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +6 -6
- package/tencentcloud/services/es/v20180416/es_models.d.ts +14 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +32 -24
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +1 -1
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +14 -14
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +13 -5
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +18 -6
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +141 -39
- package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +2 -2
- package/test/cdwch.v20200915.test.js +10 -0
- package/test/lighthouse.v20200324.test.js +24 -4
|
@@ -26,9 +26,24 @@ export interface DescribeInstanceShardsRequest {
|
|
|
26
26
|
}
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* ModifyClusterConfigs请求参数结构体
|
|
30
30
|
*/
|
|
31
|
-
export
|
|
31
|
+
export interface ModifyClusterConfigsRequest {
|
|
32
|
+
/**
|
|
33
|
+
* 集群ID,例如cdwch-xxxx
|
|
34
|
+
*/
|
|
35
|
+
InstanceId: string
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* 配置文件修改信息
|
|
39
|
+
*/
|
|
40
|
+
ModifyConfContext: Array<ConfigSubmitContext>
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* 修改原因
|
|
44
|
+
*/
|
|
45
|
+
Remark?: string
|
|
46
|
+
}
|
|
32
47
|
|
|
33
48
|
/**
|
|
34
49
|
* CreateBackUpSchedule请求参数结构体
|
|
@@ -111,6 +126,36 @@ export interface ModifyClusterConfigsResponse {
|
|
|
111
126
|
RequestId?: string
|
|
112
127
|
}
|
|
113
128
|
|
|
129
|
+
/**
|
|
130
|
+
* 磁盘规格描述
|
|
131
|
+
*/
|
|
132
|
+
export interface DiskSpec {
|
|
133
|
+
/**
|
|
134
|
+
* 磁盘类型,例如“CLOUD_SSD", "LOCAL_SSD"等
|
|
135
|
+
*/
|
|
136
|
+
DiskType: string
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* 磁盘类型说明,例如"云SSD", "本地SSD"等
|
|
140
|
+
*/
|
|
141
|
+
DiskDesc: string
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* 磁盘最小规格大小,单位G
|
|
145
|
+
*/
|
|
146
|
+
MinDiskSize: number
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* 磁盘最大规格大小,单位G
|
|
150
|
+
*/
|
|
151
|
+
MaxDiskSize: number
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* 磁盘数目
|
|
155
|
+
*/
|
|
156
|
+
DiskCount: number
|
|
157
|
+
}
|
|
158
|
+
|
|
114
159
|
/**
|
|
115
160
|
* 备份表信息
|
|
116
161
|
*/
|
|
@@ -151,6 +196,31 @@ export interface OpenBackUpResponse {
|
|
|
151
196
|
RequestId?: string
|
|
152
197
|
}
|
|
153
198
|
|
|
199
|
+
/**
|
|
200
|
+
* ModifyUserNewPrivilege请求参数结构体
|
|
201
|
+
*/
|
|
202
|
+
export type ModifyUserNewPrivilegeRequest = null
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* DescribeSpec请求参数结构体
|
|
206
|
+
*/
|
|
207
|
+
export interface DescribeSpecRequest {
|
|
208
|
+
/**
|
|
209
|
+
* 地域信息,例如"ap-guangzhou-1"
|
|
210
|
+
*/
|
|
211
|
+
Zone: string
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* 计费类型,PREPAID 包年包月,POSTPAID_BY_HOUR 按量计费
|
|
215
|
+
*/
|
|
216
|
+
PayMode?: string
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* 是否弹性ck
|
|
220
|
+
*/
|
|
221
|
+
IsElastic?: boolean
|
|
222
|
+
}
|
|
223
|
+
|
|
154
224
|
/**
|
|
155
225
|
* 配置文件修改信息
|
|
156
226
|
*/
|
|
@@ -268,23 +338,93 @@ export interface CreateBackUpScheduleResponse {
|
|
|
268
338
|
}
|
|
269
339
|
|
|
270
340
|
/**
|
|
271
|
-
*
|
|
341
|
+
* 资源规格描述信息
|
|
272
342
|
*/
|
|
273
|
-
export interface
|
|
343
|
+
export interface ResourceSpec {
|
|
274
344
|
/**
|
|
275
|
-
*
|
|
345
|
+
* 规格名称,例如“SCH1"
|
|
276
346
|
*/
|
|
277
|
-
|
|
347
|
+
Name: string
|
|
278
348
|
|
|
279
349
|
/**
|
|
280
|
-
*
|
|
350
|
+
* cpu核数
|
|
281
351
|
*/
|
|
282
|
-
|
|
352
|
+
Cpu: number
|
|
283
353
|
|
|
284
354
|
/**
|
|
285
|
-
*
|
|
355
|
+
* 内存大小,单位G
|
|
286
356
|
*/
|
|
287
|
-
|
|
357
|
+
Mem: number
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
* 分类标记,STANDARD/BIGDATA/HIGHIO分别表示标准型/大数据型/高IO
|
|
361
|
+
*/
|
|
362
|
+
Type: string
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* 系统盘描述信息
|
|
366
|
+
*/
|
|
367
|
+
SystemDisk: DiskSpec
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* 数据盘描述信息
|
|
371
|
+
*/
|
|
372
|
+
DataDisk: DiskSpec
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* 最大节点数目限制
|
|
376
|
+
*/
|
|
377
|
+
MaxNodeSize: number
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* 是否可用,false代表售罄
|
|
381
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
382
|
+
*/
|
|
383
|
+
Available: boolean
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* 规格描述信息
|
|
387
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
388
|
+
*/
|
|
389
|
+
ComputeSpecDesc: string
|
|
390
|
+
|
|
391
|
+
/**
|
|
392
|
+
* 规格名
|
|
393
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
394
|
+
*/
|
|
395
|
+
DisplayName: string
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* 库存数
|
|
399
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
400
|
+
*/
|
|
401
|
+
InstanceQuota: number
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* DescribeSpec返回参数结构体
|
|
406
|
+
*/
|
|
407
|
+
export interface DescribeSpecResponse {
|
|
408
|
+
/**
|
|
409
|
+
* zookeeper节点规格描述
|
|
410
|
+
*/
|
|
411
|
+
CommonSpec: Array<ResourceSpec>
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* 数据节点规格描述
|
|
415
|
+
*/
|
|
416
|
+
DataSpec: Array<ResourceSpec>
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* 云盘列表
|
|
420
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
421
|
+
*/
|
|
422
|
+
AttachCBSSpec: Array<DiskSpec>
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
426
|
+
*/
|
|
427
|
+
RequestId?: string
|
|
288
428
|
}
|
|
289
429
|
|
|
290
430
|
/**
|
|
@@ -376,7 +376,7 @@ export class Client extends AbstractClient {
|
|
|
376
376
|
}
|
|
377
377
|
|
|
378
378
|
/**
|
|
379
|
-
* 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络
|
|
379
|
+
* 本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络IP。
|
|
380
380
|
* 此操作默认会关闭实例,完成后再启动。
|
|
381
381
|
* 当指定私有网络ID和子网ID(子网必须在实例所在的可用区)与指定实例所在私有网络不一致时,会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/document/product/214)。
|
|
382
382
|
* 实例操作结果可以通过调用 [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”,则代表操作成功。
|
|
@@ -176,12 +176,12 @@ export interface ResetInstancesTypeResponse {
|
|
|
176
176
|
*/
|
|
177
177
|
export interface HostResource {
|
|
178
178
|
/**
|
|
179
|
-
* 专用宿主机实例总
|
|
179
|
+
* 专用宿主机实例总CPU核数
|
|
180
180
|
*/
|
|
181
181
|
CpuTotal?: number
|
|
182
182
|
|
|
183
183
|
/**
|
|
184
|
-
* 专用宿主机实例可用
|
|
184
|
+
* 专用宿主机实例可用CPU核数
|
|
185
185
|
*/
|
|
186
186
|
CpuAvailable?: number
|
|
187
187
|
|
|
@@ -1811,7 +1811,7 @@ export interface CreateHpcClusterResponse {
|
|
|
1811
1811
|
}
|
|
1812
1812
|
|
|
1813
1813
|
/**
|
|
1814
|
-
* 描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机
|
|
1814
|
+
* 描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机IP等
|
|
1815
1815
|
*/
|
|
1816
1816
|
export interface Placement {
|
|
1817
1817
|
/**
|
|
@@ -1830,7 +1830,7 @@ export interface Placement {
|
|
|
1830
1830
|
HostIds?: Array<string>
|
|
1831
1831
|
|
|
1832
1832
|
/**
|
|
1833
|
-
* 指定母机
|
|
1833
|
+
* 指定母机IP生产子机
|
|
1834
1834
|
*/
|
|
1835
1835
|
HostIps?: Array<string>
|
|
1836
1836
|
|
|
@@ -2752,7 +2752,7 @@ export interface LaunchTemplateVersionData {
|
|
|
2752
2752
|
UserData?: string
|
|
2753
2753
|
|
|
2754
2754
|
/**
|
|
2755
|
-
* 置放群组
|
|
2755
|
+
* 置放群组ID,仅支持指定一个。
|
|
2756
2756
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2757
2757
|
*/
|
|
2758
2758
|
DisasterRecoverGroupIds?: Array<string>
|
|
@@ -2814,7 +2814,7 @@ export interface HostItem {
|
|
|
2814
2814
|
Placement?: Placement
|
|
2815
2815
|
|
|
2816
2816
|
/**
|
|
2817
|
-
* 专用宿主机实例
|
|
2817
|
+
* 专用宿主机实例ID
|
|
2818
2818
|
*/
|
|
2819
2819
|
HostId?: string
|
|
2820
2820
|
|
|
@@ -2859,7 +2859,7 @@ export interface HostItem {
|
|
|
2859
2859
|
HostState?: string
|
|
2860
2860
|
|
|
2861
2861
|
/**
|
|
2862
|
-
* 专用宿主机实例
|
|
2862
|
+
* 专用宿主机实例IP
|
|
2863
2863
|
*/
|
|
2864
2864
|
HostIp?: string
|
|
2865
2865
|
|
|
@@ -2977,7 +2977,7 @@ export interface CreateImageRequest {
|
|
|
2977
2977
|
Sysprep?: string
|
|
2978
2978
|
|
|
2979
2979
|
/**
|
|
2980
|
-
* 基于实例创建整机镜像时,指定包含在镜像里的数据盘
|
|
2980
|
+
* 基于实例创建整机镜像时,指定包含在镜像里的数据盘ID
|
|
2981
2981
|
*/
|
|
2982
2982
|
DataDiskIds?: Array<string>
|
|
2983
2983
|
|
|
@@ -4780,17 +4780,17 @@ export interface InquiryPriceTerminateInstancesRequest {
|
|
|
4780
4780
|
}
|
|
4781
4781
|
|
|
4782
4782
|
/**
|
|
4783
|
-
* 支持的操作系统类型,根据
|
|
4783
|
+
* 支持的操作系统类型,根据Windows和Linux分类。
|
|
4784
4784
|
*/
|
|
4785
4785
|
export interface ImageOsList {
|
|
4786
4786
|
/**
|
|
4787
|
-
* 支持的
|
|
4787
|
+
* 支持的Windows操作系统。
|
|
4788
4788
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4789
4789
|
*/
|
|
4790
4790
|
Windows: Array<string>
|
|
4791
4791
|
|
|
4792
4792
|
/**
|
|
4793
|
-
* 支持的
|
|
4793
|
+
* 支持的Linux操作系统
|
|
4794
4794
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4795
4795
|
*/
|
|
4796
4796
|
Linux: Array<string>
|
|
@@ -5250,8 +5250,8 @@ export interface ReservedInstancePriceItem {
|
|
|
5250
5250
|
Duration: number
|
|
5251
5251
|
|
|
5252
5252
|
/**
|
|
5253
|
-
* 预留实例计费的平台描述(即操作系统)。形如:
|
|
5254
|
-
返回项:
|
|
5253
|
+
* 预留实例计费的平台描述(即操作系统)。形如:Linux。
|
|
5254
|
+
返回项: Linux 。
|
|
5255
5255
|
*/
|
|
5256
5256
|
ProductDescription: string
|
|
5257
5257
|
}
|
|
@@ -311,7 +311,7 @@ export class Client extends AbstractClient {
|
|
|
311
311
|
}
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
|
-
* 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs
|
|
314
|
+
* 下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态,此操作成功后无法看到此任务表示下线成功。
|
|
315
315
|
*/
|
|
316
316
|
async DestroySyncJob(
|
|
317
317
|
req: DestroySyncJobRequest,
|
|
@@ -509,7 +509,7 @@ export class Client extends AbstractClient {
|
|
|
509
509
|
}
|
|
510
510
|
|
|
511
511
|
/**
|
|
512
|
-
*
|
|
512
|
+
* 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
|
|
513
513
|
*/
|
|
514
514
|
async IsolateSyncJob(
|
|
515
515
|
req: IsolateSyncJobRequest,
|
|
@@ -3257,7 +3257,7 @@ export interface StepDetailInfo {
|
|
|
3257
3257
|
*/
|
|
3258
3258
|
export interface CreateSyncJobRequest {
|
|
3259
3259
|
/**
|
|
3260
|
-
*
|
|
3260
|
+
* 付款类型, 如:PrePay(表示包年包月)、PostPay(表示按时按量)
|
|
3261
3261
|
*/
|
|
3262
3262
|
PayMode: string
|
|
3263
3263
|
|
|
@@ -3287,27 +3287,27 @@ export interface CreateSyncJobRequest {
|
|
|
3287
3287
|
Specification?: string
|
|
3288
3288
|
|
|
3289
3289
|
/**
|
|
3290
|
-
*
|
|
3290
|
+
* 标签信息
|
|
3291
3291
|
*/
|
|
3292
3292
|
Tags?: Array<TagItem>
|
|
3293
3293
|
|
|
3294
3294
|
/**
|
|
3295
|
-
*
|
|
3295
|
+
* 一次购买的同步任务数量,取值范围为[1, 10],默认为1
|
|
3296
3296
|
*/
|
|
3297
3297
|
Count?: number
|
|
3298
3298
|
|
|
3299
3299
|
/**
|
|
3300
|
-
*
|
|
3300
|
+
* 自动续费标识,当PayMode值为PrePay则此项配置有意义,取值为:1(表示自动续费)、0(不自动续费,默认为此值)
|
|
3301
3301
|
*/
|
|
3302
3302
|
AutoRenew?: number
|
|
3303
3303
|
|
|
3304
3304
|
/**
|
|
3305
|
-
*
|
|
3305
|
+
* 同步链路规格,如micro,small,medium,large,默认为medium
|
|
3306
3306
|
*/
|
|
3307
3307
|
InstanceClass?: string
|
|
3308
3308
|
|
|
3309
3309
|
/**
|
|
3310
|
-
*
|
|
3310
|
+
* 同步任务名称
|
|
3311
3311
|
*/
|
|
3312
3312
|
JobName?: string
|
|
3313
3313
|
|
|
@@ -3408,8 +3408,10 @@ export interface UpdateInstanceRequest {
|
|
|
3408
3408
|
NodeInfoList?: Array<NodeInfo>
|
|
3409
3409
|
|
|
3410
3410
|
/**
|
|
3411
|
-
|
|
3412
|
-
|
|
3411
|
+
* ES集群公网访问状态
|
|
3412
|
+
OPEN 开启
|
|
3413
|
+
CLOSE 关闭
|
|
3414
|
+
*/
|
|
3413
3415
|
PublicAccess?: string
|
|
3414
3416
|
|
|
3415
3417
|
/**
|
|
@@ -3418,13 +3420,17 @@ export interface UpdateInstanceRequest {
|
|
|
3418
3420
|
EsPublicAcl?: EsPublicAcl
|
|
3419
3421
|
|
|
3420
3422
|
/**
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
+
* Kibana公网访问状态
|
|
3424
|
+
OPEN 开启
|
|
3425
|
+
CLOSE 关闭
|
|
3426
|
+
*/
|
|
3423
3427
|
KibanaPublicAccess?: string
|
|
3424
3428
|
|
|
3425
3429
|
/**
|
|
3426
|
-
|
|
3427
|
-
|
|
3430
|
+
* Kibana内网访问状态
|
|
3431
|
+
OPEN 开启
|
|
3432
|
+
CLOSE 关闭
|
|
3433
|
+
*/
|
|
3428
3434
|
KibanaPrivateAccess?: string
|
|
3429
3435
|
|
|
3430
3436
|
/**
|
|
@@ -3473,13 +3479,17 @@ export interface UpdateInstanceRequest {
|
|
|
3473
3479
|
EnableCerebro?: boolean
|
|
3474
3480
|
|
|
3475
3481
|
/**
|
|
3476
|
-
|
|
3477
|
-
|
|
3482
|
+
* Cerebro公网访问状态
|
|
3483
|
+
OPEN 开启
|
|
3484
|
+
CLOSE 关闭
|
|
3485
|
+
*/
|
|
3478
3486
|
CerebroPublicAccess?: string
|
|
3479
3487
|
|
|
3480
3488
|
/**
|
|
3481
|
-
|
|
3482
|
-
|
|
3489
|
+
* Cerebro内网访问状态
|
|
3490
|
+
OPEN 开启
|
|
3491
|
+
CLOSE 关闭
|
|
3492
|
+
*/
|
|
3483
3493
|
CerebroPrivateAccess?: string
|
|
3484
3494
|
|
|
3485
3495
|
/**
|
|
@@ -3493,8 +3503,10 @@ export interface UpdateInstanceRequest {
|
|
|
3493
3503
|
OperationDuration?: OperationDurationUpdated
|
|
3494
3504
|
|
|
3495
3505
|
/**
|
|
3496
|
-
|
|
3497
|
-
|
|
3506
|
+
* 是否开启Alerting 外网告警输出:
|
|
3507
|
+
OPEN 开启
|
|
3508
|
+
CLOSE 关闭
|
|
3509
|
+
*/
|
|
3498
3510
|
KibanaAlteringPublicAccess?: string
|
|
3499
3511
|
}
|
|
3500
3512
|
|
|
@@ -268,7 +268,7 @@ export class Client extends AbstractClient {
|
|
|
268
268
|
}
|
|
269
269
|
|
|
270
270
|
/**
|
|
271
|
-
* 此接口(
|
|
271
|
+
* 此接口(ChannelCreateBoundFlows)用于渠道子客领取合同,经办人需要有相应的角色,领取后的合同不能重复领取。
|
|
272
272
|
*/
|
|
273
273
|
async ChannelCreateBoundFlows(
|
|
274
274
|
req: ChannelCreateBoundFlowsRequest,
|
|
@@ -392,12 +392,12 @@ export interface CreateSealByImageRequest {
|
|
|
392
392
|
Agent: Agent
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
|
-
* 印章名称,最大长度不超过
|
|
395
|
+
* 印章名称,最大长度不超过50字符
|
|
396
396
|
*/
|
|
397
397
|
SealName: string
|
|
398
398
|
|
|
399
399
|
/**
|
|
400
|
-
* 印章图片base64
|
|
400
|
+
* 印章图片base64,大小不超过10M(原始图片不超过7.6M)
|
|
401
401
|
*/
|
|
402
402
|
SealImage: string
|
|
403
403
|
|
|
@@ -585,27 +585,27 @@ MobileCheck:手机号验证
|
|
|
585
585
|
*/
|
|
586
586
|
export interface Agent {
|
|
587
587
|
/**
|
|
588
|
-
*
|
|
588
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
589
589
|
*/
|
|
590
590
|
AppId: string
|
|
591
591
|
|
|
592
592
|
/**
|
|
593
|
-
*
|
|
593
|
+
* 渠道平台自定义,对于渠道子客企业的唯一标识。一个渠道子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要渠道平台保存),最大64位字符串
|
|
594
594
|
*/
|
|
595
595
|
ProxyOrganizationOpenId?: string
|
|
596
596
|
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
598
|
+
* 渠道子客企业中的员工/经办人,通过渠道平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
599
599
|
*/
|
|
600
600
|
ProxyOperator?: UserInfo
|
|
601
601
|
|
|
602
602
|
/**
|
|
603
|
-
*
|
|
603
|
+
* 在子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
604
604
|
*/
|
|
605
605
|
ProxyAppId?: string
|
|
606
606
|
|
|
607
607
|
/**
|
|
608
|
-
*
|
|
608
|
+
* 内部参数,暂未开放使用
|
|
609
609
|
*/
|
|
610
610
|
ProxyOrganizationId?: string
|
|
611
611
|
}
|
|
@@ -945,14 +945,14 @@ export interface TemplateInfo {
|
|
|
945
945
|
Components: Array<Component>
|
|
946
946
|
|
|
947
947
|
/**
|
|
948
|
-
*
|
|
948
|
+
* 模板中的流程参与人信息
|
|
949
949
|
*/
|
|
950
|
-
|
|
950
|
+
Recipients: Array<Recipient>
|
|
951
951
|
|
|
952
952
|
/**
|
|
953
|
-
*
|
|
953
|
+
* 签署区模板信息结构
|
|
954
954
|
*/
|
|
955
|
-
|
|
955
|
+
SignComponents: Array<Component>
|
|
956
956
|
|
|
957
957
|
/**
|
|
958
958
|
* 模板类型:1-静默签;3-普通模板
|
|
@@ -981,10 +981,15 @@ export interface TemplateInfo {
|
|
|
981
981
|
PreviewUrl: string
|
|
982
982
|
|
|
983
983
|
/**
|
|
984
|
-
|
|
984
|
+
* 渠道模板ID
|
|
985
|
+
*/
|
|
986
|
+
ChannelTemplateId: string
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* 渠道版-模板PDF文件链接
|
|
985
990
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
986
991
|
*/
|
|
987
|
-
|
|
992
|
+
PdfUrl: string
|
|
988
993
|
}
|
|
989
994
|
|
|
990
995
|
/**
|
|
@@ -1331,7 +1336,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
1331
1336
|
*/
|
|
1332
1337
|
export interface ProxyOrganizationOperator {
|
|
1333
1338
|
/**
|
|
1334
|
-
*
|
|
1339
|
+
* 对应Agent-ProxyOperator-OpenId。渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(比如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
|
|
1335
1340
|
*/
|
|
1336
1341
|
Id: string
|
|
1337
1342
|
|
|
@@ -1576,27 +1581,27 @@ export interface FlowInfo {
|
|
|
1576
1581
|
*/
|
|
1577
1582
|
export interface UserInfo {
|
|
1578
1583
|
/**
|
|
1579
|
-
*
|
|
1584
|
+
* 渠道平台自定义,对渠道子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要渠道平台保存),最大64位字符串
|
|
1580
1585
|
*/
|
|
1581
1586
|
OpenId?: string
|
|
1582
1587
|
|
|
1583
1588
|
/**
|
|
1584
|
-
*
|
|
1589
|
+
* 内部参数,暂未开放使用
|
|
1585
1590
|
*/
|
|
1586
1591
|
Channel?: string
|
|
1587
1592
|
|
|
1588
1593
|
/**
|
|
1589
|
-
*
|
|
1594
|
+
* 内部参数,暂未开放使用
|
|
1590
1595
|
*/
|
|
1591
1596
|
CustomUserId?: string
|
|
1592
1597
|
|
|
1593
1598
|
/**
|
|
1594
|
-
*
|
|
1599
|
+
* 内部参数,暂未开放使用
|
|
1595
1600
|
*/
|
|
1596
1601
|
ClientIp?: string
|
|
1597
1602
|
|
|
1598
1603
|
/**
|
|
1599
|
-
*
|
|
1604
|
+
* 内部参数,暂未开放使用
|
|
1600
1605
|
*/
|
|
1601
1606
|
ProxyIp?: string
|
|
1602
1607
|
}
|
|
@@ -1714,7 +1719,7 @@ export interface ChannelCreateBoundFlowsRequest {
|
|
|
1714
1719
|
FlowIds?: Array<string>
|
|
1715
1720
|
|
|
1716
1721
|
/**
|
|
1717
|
-
*
|
|
1722
|
+
* 暂未开放
|
|
1718
1723
|
*/
|
|
1719
1724
|
Operator?: UserInfo
|
|
1720
1725
|
}
|
|
@@ -2554,6 +2559,11 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
|
|
|
2554
2559
|
* ChannelCreateReleaseFlow请求参数结构体
|
|
2555
2560
|
*/
|
|
2556
2561
|
export interface ChannelCreateReleaseFlowRequest {
|
|
2562
|
+
/**
|
|
2563
|
+
* 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
|
|
2564
|
+
*/
|
|
2565
|
+
Agent: Agent
|
|
2566
|
+
|
|
2557
2567
|
/**
|
|
2558
2568
|
* 待解除的流程编号(即原流程的编号)
|
|
2559
2569
|
*/
|
|
@@ -2565,12 +2575,7 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
2565
2575
|
ReliveInfo: RelieveInfo
|
|
2566
2576
|
|
|
2567
2577
|
/**
|
|
2568
|
-
*
|
|
2569
|
-
*/
|
|
2570
|
-
Agent: Agent
|
|
2571
|
-
|
|
2572
|
-
/**
|
|
2573
|
-
* 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(比如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
|
|
2578
|
+
* 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,解除协议的签署人数量不能多于原流程的签署人数量
|
|
2574
2579
|
*/
|
|
2575
2580
|
ReleasedApprovers?: Array<ReleasedApprover>
|
|
2576
2581
|
|
|
@@ -3050,6 +3055,11 @@ export interface DescribeTemplatesRequest {
|
|
|
3050
3055
|
* 是否获取模板预览链接
|
|
3051
3056
|
*/
|
|
3052
3057
|
WithPreviewUrl?: boolean
|
|
3058
|
+
|
|
3059
|
+
/**
|
|
3060
|
+
* 是否获取模板的PDF文件链接-渠道版需要开启白名单时才能使用。
|
|
3061
|
+
*/
|
|
3062
|
+
WithPdfUrl?: boolean
|
|
3053
3063
|
}
|
|
3054
3064
|
|
|
3055
3065
|
/**
|