tencentcloud-sdk-nodejs 4.0.973 → 4.0.975
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 +776 -0
- package/SERVICE_CHANGELOG.md +804 -522
- package/package.json +1 -1
- package/products.md +41 -40
- package/src/common/sdk_version.ts +1 -1
- package/src/services/apigateway/v20180808/apigateway_models.ts +1 -1
- package/src/services/as/v20180419/as_models.ts +14 -0
- package/src/services/asr/v20190614/asr_models.ts +1 -1
- package/src/services/bh/index.ts +5 -0
- package/src/services/bh/v20230418/bh_client.ts +799 -0
- package/src/services/bh/v20230418/bh_models.ts +3912 -0
- package/src/services/bh/v20230418/index.ts +6 -0
- package/src/services/billing/v20180709/billing_client.ts +12 -6
- package/src/services/ccc/v20200210/ccc_models.ts +24 -0
- package/src/services/cdb/v20170320/cdb_models.ts +5 -1
- package/src/services/ckafka/v20190819/ckafka_models.ts +25 -17
- package/src/services/clb/v20180317/clb_client.ts +1 -1
- package/src/services/clb/v20180317/clb_models.ts +25 -15
- package/src/services/dasb/v20191018/dasb_models.ts +25 -1
- package/src/services/emr/v20190103/emr_models.ts +1 -1
- package/src/services/ess/v20201111/ess_client.ts +5 -6
- package/src/services/ess/v20201111/ess_models.ts +24 -4
- package/src/services/essbasic/v20210526/essbasic_client.ts +26 -7
- package/src/services/essbasic/v20210526/essbasic_models.ts +19 -5
- package/src/services/facefusion/v20181201/facefusion_models.ts +14 -14
- package/src/services/facefusion/v20220927/facefusion_models.ts +4 -10
- package/src/services/gme/v20180711/gme_models.ts +8 -8
- package/src/services/hunyuan/v20230901/hunyuan_models.ts +9 -1
- package/src/services/index.ts +1 -0
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +4 -4
- package/src/services/iotvideo/v20191126/iotvideo_models.ts +21 -21
- package/src/services/live/v20180801/live_client.ts +40 -2
- package/src/services/live/v20180801/live_models.ts +199 -55
- package/src/services/monitor/v20180724/monitor_models.ts +19 -14
- package/src/services/mrs/v20200910/mrs_models.ts +2 -4
- package/src/services/ocr/v20181119/ocr_client.ts +1 -3
- package/src/services/ocr/v20181119/ocr_models.ts +78 -78
- package/src/services/omics/v20221128/omics_client.ts +1 -0
- package/src/services/omics/v20221128/omics_models.ts +27 -86
- package/src/services/partners/v20180321/partners_models.ts +0 -6
- package/src/services/privatedns/v20201028/privatedns_models.ts +1 -1
- package/src/services/rce/v20201103/rce_client.ts +14 -0
- package/src/services/rce/v20201103/rce_models.ts +79 -0
- package/src/services/redis/v20180412/redis_client.ts +1 -1
- package/src/services/redis/v20180412/redis_models.ts +17 -15
- package/src/services/rum/v20210622/rum_models.ts +4 -0
- package/src/services/tdmq/v20200217/tdmq_models.ts +13 -5
- package/src/services/thpc/v20230321/thpc_models.ts +1 -1
- package/src/services/tke/v20180525/tke_models.ts +1 -1
- package/src/services/tke/v20220501/tke_client.ts +48 -1
- package/src/services/tke/v20220501/tke_models.ts +160 -74
- package/src/services/tmt/v20180321/tmt_models.ts +20 -3
- package/src/services/vod/v20180717/vod_client.ts +1 -1
- package/src/services/vod/v20180717/vod_models.ts +1 -1
- package/src/services/vod/v20240718/vod_models.ts +8 -8
- package/src/services/vpc/v20170312/vpc_client.ts +9 -5
- package/src/services/vpc/v20170312/vpc_models.ts +130 -103
- package/src/services/waf/v20180125/waf_client.ts +45 -7
- package/src/services/waf/v20180125/waf_models.ts +191 -26
- package/src/services/wav/v20210129/wav_models.ts +38 -38
- package/src/services/wedata/v20210820/wedata_models.ts +7 -3
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +1 -1
- package/tencentcloud/services/as/v20180419/as_models.d.ts +14 -0
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +1 -1
- package/tencentcloud/services/bh/index.d.ts +6 -0
- package/tencentcloud/services/bh/index.js +7 -0
- package/tencentcloud/services/bh/v20230418/bh_client.d.ts +258 -0
- package/tencentcloud/services/bh/v20230418/bh_client.js +403 -0
- package/tencentcloud/services/bh/v20230418/bh_models.d.ts +3748 -0
- package/tencentcloud/services/bh/v20230418/bh_models.js +18 -0
- package/tencentcloud/services/bh/v20230418/index.d.ts +6 -0
- package/tencentcloud/services/bh/v20230418/index.js +9 -0
- package/tencentcloud/services/billing/v20180709/billing_client.d.ts +9 -3
- package/tencentcloud/services/billing/v20180709/billing_client.js +9 -3
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +24 -0
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +5 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +25 -17
- package/tencentcloud/services/clb/v20180317/clb_client.d.ts +1 -1
- package/tencentcloud/services/clb/v20180317/clb_client.js +1 -1
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +25 -15
- package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +25 -1
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1 -1
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -6
- package/tencentcloud/services/ess/v20201111/ess_client.js +5 -6
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +23 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +26 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +18 -4
- package/tencentcloud/services/facefusion/v20181201/facefusion_models.d.ts +14 -14
- package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +4 -10
- package/tencentcloud/services/gme/v20180711/gme_models.d.ts +8 -8
- package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +9 -1
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +2 -0
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +4 -4
- package/tencentcloud/services/iotvideo/v20191126/iotvideo_models.d.ts +21 -21
- package/tencentcloud/services/live/v20180801/live_client.d.ts +13 -1
- package/tencentcloud/services/live/v20180801/live_client.js +18 -0
- package/tencentcloud/services/live/v20180801/live_models.d.ts +191 -55
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +19 -14
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +2 -4
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -3
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -3
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +78 -78
- package/tencentcloud/services/omics/v20221128/omics_models.d.ts +26 -86
- package/tencentcloud/services/partners/v20180321/partners_models.d.ts +0 -6
- package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +1 -1
- package/tencentcloud/services/rce/v20201103/rce_client.d.ts +5 -1
- package/tencentcloud/services/rce/v20201103/rce_client.js +6 -0
- package/tencentcloud/services/rce/v20201103/rce_models.d.ts +75 -0
- package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
- package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +17 -15
- package/tencentcloud/services/rum/v20210622/rum_models.d.ts +4 -0
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +13 -5
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +1 -1
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -1
- package/tencentcloud/services/tke/v20220501/tke_client.d.ts +24 -1
- package/tencentcloud/services/tke/v20220501/tke_client.js +29 -0
- package/tencentcloud/services/tke/v20220501/tke_models.d.ts +155 -75
- package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +20 -3
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_client.js +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20240718/vod_models.d.ts +8 -8
- package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +7 -3
- package/tencentcloud/services/vpc/v20170312/vpc_client.js +7 -3
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +130 -103
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +15 -3
- package/tencentcloud/services/waf/v20180125/waf_client.js +21 -3
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +183 -26
- package/tencentcloud/services/wav/v20210129/wav_models.d.ts +38 -38
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +7 -3
- package/test/bh.v20230418.test.js +641 -0
- package/test/live.v20180801.test.js +30 -0
- package/test/rce.v20201103.test.js +10 -0
- package/test/tke.v20220501.test.js +30 -0
- package/test/waf.v20180125.test.js +32 -2
|
@@ -298,8 +298,10 @@ export class Client extends AbstractClient {
|
|
|
298
298
|
}
|
|
299
299
|
|
|
300
300
|
/**
|
|
301
|
-
|
|
302
|
-
|
|
301
|
+
* 接口迁移到其他业务
|
|
302
|
+
|
|
303
|
+
查用当前用户明细节省计划总览查询时段内的使用情况
|
|
304
|
+
*/
|
|
303
305
|
async DescribeSavingPlanOverview(
|
|
304
306
|
req: DescribeSavingPlanOverviewRequest,
|
|
305
307
|
cb?: (error: string, rep: DescribeSavingPlanOverviewResponse) => void
|
|
@@ -481,8 +483,10 @@ export class Client extends AbstractClient {
|
|
|
481
483
|
}
|
|
482
484
|
|
|
483
485
|
/**
|
|
484
|
-
|
|
485
|
-
|
|
486
|
+
* 接口迁移到其他业务
|
|
487
|
+
|
|
488
|
+
查用当前用户明细节省计划查询时段内的使用情况
|
|
489
|
+
*/
|
|
486
490
|
async DescribeSavingPlanUsage(
|
|
487
491
|
req: DescribeSavingPlanUsageRequest,
|
|
488
492
|
cb?: (error: string, rep: DescribeSavingPlanUsageResponse) => void
|
|
@@ -611,8 +615,10 @@ export class Client extends AbstractClient {
|
|
|
611
615
|
}
|
|
612
616
|
|
|
613
617
|
/**
|
|
614
|
-
|
|
615
|
-
|
|
618
|
+
* 接口迁移到其他业务
|
|
619
|
+
|
|
620
|
+
创建节省计划订单,创建订单完成需调用PayDeals接口完成订单支付
|
|
621
|
+
*/
|
|
616
622
|
async CreateSavingPlanOrder(
|
|
617
623
|
req: CreateSavingPlanOrderRequest,
|
|
618
624
|
cb?: (error: string, rep: CreateSavingPlanOrderResponse) => void
|
|
@@ -510,6 +510,18 @@ export interface CreatePredictiveDialingCampaignRequest {
|
|
|
510
510
|
* 呼叫重试次数,0 - 2
|
|
511
511
|
*/
|
|
512
512
|
RetryTimes?: number
|
|
513
|
+
/**
|
|
514
|
+
* 自定义变量
|
|
515
|
+
*/
|
|
516
|
+
Variables?: Array<Variable>
|
|
517
|
+
/**
|
|
518
|
+
* UUI
|
|
519
|
+
*/
|
|
520
|
+
UUI?: string
|
|
521
|
+
/**
|
|
522
|
+
* 被叫属性
|
|
523
|
+
*/
|
|
524
|
+
CalleeAttributes?: Array<CalleeAttribute>
|
|
513
525
|
}
|
|
514
526
|
|
|
515
527
|
/**
|
|
@@ -1689,6 +1701,18 @@ export interface UpdatePredictiveDialingCampaignRequest {
|
|
|
1689
1701
|
* 呼叫重试次数,0 - 2
|
|
1690
1702
|
*/
|
|
1691
1703
|
RetryTimes?: number
|
|
1704
|
+
/**
|
|
1705
|
+
* 自定义变量
|
|
1706
|
+
*/
|
|
1707
|
+
Variables?: Array<Variable>
|
|
1708
|
+
/**
|
|
1709
|
+
* UUI
|
|
1710
|
+
*/
|
|
1711
|
+
UUI?: string
|
|
1712
|
+
/**
|
|
1713
|
+
* 被叫属性
|
|
1714
|
+
*/
|
|
1715
|
+
CalleeAttributes?: Array<CalleeAttribute>
|
|
1692
1716
|
}
|
|
1693
1717
|
|
|
1694
1718
|
/**
|
|
@@ -9735,7 +9735,7 @@ export interface DescribeDBPriceRequest {
|
|
|
9735
9735
|
*/
|
|
9736
9736
|
ProtectMode?: number
|
|
9737
9737
|
/**
|
|
9738
|
-
* 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC_V2" - 单节点云盘版实例。 不指定则默认为通用型实例。
|
|
9738
|
+
* 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC_V2" - 单节点云盘版实例。 "CLOUD_NATIVE_CLUSTER" - 集群版标准型, "CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - 集群版加强型。 不指定则默认为通用型实例。
|
|
9739
9739
|
*/
|
|
9740
9740
|
DeviceType?: string
|
|
9741
9741
|
/**
|
|
@@ -9754,6 +9754,10 @@ export interface DescribeDBPriceRequest {
|
|
|
9754
9754
|
* 按量计费阶梯。仅PayType=HOUR_PAID有效,支持值包括:1,2,3。阶梯时长见https://cloud.tencent.com/document/product/236/18335。
|
|
9755
9755
|
*/
|
|
9756
9756
|
Ladder?: number
|
|
9757
|
+
/**
|
|
9758
|
+
* 磁盘类型,查询集群版、单节点云盘版实例价格可以指定该参数。支持值包括: "CLOUD_SSD" - SSD云硬盘, "CLOUD_HSSD" - 增强型SSD云硬盘。 默认为 SSD云硬盘。
|
|
9759
|
+
*/
|
|
9760
|
+
DiskType?: string
|
|
9757
9761
|
}
|
|
9758
9762
|
|
|
9759
9763
|
/**
|
|
@@ -661,16 +661,16 @@ export interface JgwOperateResponse {
|
|
|
661
661
|
/**
|
|
662
662
|
* 返回的code,0为正常,非0为错误
|
|
663
663
|
*/
|
|
664
|
-
ReturnCode
|
|
664
|
+
ReturnCode?: string
|
|
665
665
|
/**
|
|
666
666
|
* 成功消息
|
|
667
667
|
*/
|
|
668
|
-
ReturnMessage
|
|
668
|
+
ReturnMessage?: string
|
|
669
669
|
/**
|
|
670
670
|
* 操作型返回的Data数据,可能有flowId等
|
|
671
671
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
672
672
|
*/
|
|
673
|
-
Data
|
|
673
|
+
Data?: OperateResponseData
|
|
674
674
|
}
|
|
675
675
|
|
|
676
676
|
/**
|
|
@@ -2921,7 +2921,7 @@ export interface CreateInstancePostResponse {
|
|
|
2921
2921
|
*/
|
|
2922
2922
|
export interface RouteDTO {
|
|
2923
2923
|
/**
|
|
2924
|
-
*
|
|
2924
|
+
* 路由Id
|
|
2925
2925
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2926
2926
|
*/
|
|
2927
2927
|
RouteId?: number
|
|
@@ -5289,17 +5289,17 @@ export interface CreateInstancePreData {
|
|
|
5289
5289
|
* CreateInstancePre返回固定为0,不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
|
|
5290
5290
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5291
5291
|
*/
|
|
5292
|
-
FlowId
|
|
5292
|
+
FlowId?: number
|
|
5293
5293
|
/**
|
|
5294
5294
|
* 订单号列表
|
|
5295
5295
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5296
5296
|
*/
|
|
5297
|
-
DealNames
|
|
5297
|
+
DealNames?: Array<string>
|
|
5298
5298
|
/**
|
|
5299
|
-
*
|
|
5299
|
+
* ckafka集群实例Id,当购买多个实例时,默认返回购买的第一个实例 id
|
|
5300
5300
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5301
5301
|
*/
|
|
5302
|
-
InstanceId
|
|
5302
|
+
InstanceId?: string
|
|
5303
5303
|
/**
|
|
5304
5304
|
* 订单和购买实例对应映射列表
|
|
5305
5305
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
@@ -6297,11 +6297,11 @@ export interface DescribeInstancesRequest {
|
|
|
6297
6297
|
*/
|
|
6298
6298
|
export interface CreateInstancePostRequest {
|
|
6299
6299
|
/**
|
|
6300
|
-
*
|
|
6300
|
+
* ckafka集群实例Name,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
|
|
6301
6301
|
*/
|
|
6302
6302
|
InstanceName: string
|
|
6303
6303
|
/**
|
|
6304
|
-
* 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例,因此该参数必填
|
|
6304
|
+
* 私有网络Id 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例,因此该参数必填
|
|
6305
6305
|
*/
|
|
6306
6306
|
VpcId: string
|
|
6307
6307
|
/**
|
|
@@ -6372,6 +6372,10 @@ export interface CreateInstancePostRequest {
|
|
|
6372
6372
|
* 标签
|
|
6373
6373
|
*/
|
|
6374
6374
|
Tags?: Array<Tag>
|
|
6375
|
+
/**
|
|
6376
|
+
* 弹性带宽开关 0不开启 1开启(0默认)
|
|
6377
|
+
*/
|
|
6378
|
+
ElasticBandwidthSwitch?: number
|
|
6375
6379
|
}
|
|
6376
6380
|
|
|
6377
6381
|
/**
|
|
@@ -6916,7 +6920,7 @@ export interface ModifyTopicAttributesRequest {
|
|
|
6916
6920
|
*/
|
|
6917
6921
|
export interface CreateInstancePreRequest {
|
|
6918
6922
|
/**
|
|
6919
|
-
*
|
|
6923
|
+
* ckafka集群实例Name,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
|
|
6920
6924
|
*/
|
|
6921
6925
|
InstanceName: string
|
|
6922
6926
|
/**
|
|
@@ -6932,7 +6936,7 @@ export interface CreateInstancePreRequest {
|
|
|
6932
6936
|
*/
|
|
6933
6937
|
InstanceType: number
|
|
6934
6938
|
/**
|
|
6935
|
-
*
|
|
6939
|
+
* 私有网络Id,必填
|
|
6936
6940
|
*/
|
|
6937
6941
|
VpcId?: string
|
|
6938
6942
|
/**
|
|
@@ -6964,7 +6968,7 @@ export interface CreateInstancePreRequest {
|
|
|
6964
6968
|
*/
|
|
6965
6969
|
DiskSize?: number
|
|
6966
6970
|
/**
|
|
6967
|
-
*
|
|
6971
|
+
* 实例带宽,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s
|
|
6968
6972
|
*/
|
|
6969
6973
|
BandWidth?: number
|
|
6970
6974
|
/**
|
|
@@ -6999,6 +7003,10 @@ export interface CreateInstancePreRequest {
|
|
|
6999
7003
|
* 是否自动选择代金券:1-是;0否。默认为0
|
|
7000
7004
|
*/
|
|
7001
7005
|
AutoVoucher?: number
|
|
7006
|
+
/**
|
|
7007
|
+
* 弹性带宽开关 0不开启 1开启(0默认)
|
|
7008
|
+
*/
|
|
7009
|
+
ElasticBandwidthSwitch?: number
|
|
7002
7010
|
}
|
|
7003
7011
|
|
|
7004
7012
|
/**
|
|
@@ -7619,16 +7627,16 @@ export interface CreateInstancePreResp {
|
|
|
7619
7627
|
/**
|
|
7620
7628
|
* 返回的code,0为正常,非0为错误
|
|
7621
7629
|
*/
|
|
7622
|
-
ReturnCode
|
|
7630
|
+
ReturnCode?: string
|
|
7623
7631
|
/**
|
|
7624
7632
|
* 成功消息
|
|
7625
7633
|
*/
|
|
7626
|
-
ReturnMessage
|
|
7634
|
+
ReturnMessage?: string
|
|
7627
7635
|
/**
|
|
7628
7636
|
* 操作型返回的Data数据
|
|
7629
7637
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
7630
7638
|
*/
|
|
7631
|
-
Data
|
|
7639
|
+
Data?: CreateInstancePreData
|
|
7632
7640
|
/**
|
|
7633
7641
|
* 删除时间。目前该参数字段已废弃,将会在未来被删除
|
|
7634
7642
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
@@ -7972,7 +7980,7 @@ export interface CreateCdcClusterResponse {
|
|
|
7972
7980
|
*/
|
|
7973
7981
|
export interface OperateResponseData {
|
|
7974
7982
|
/**
|
|
7975
|
-
*
|
|
7983
|
+
* 流程Id
|
|
7976
7984
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
7977
7985
|
*/
|
|
7978
7986
|
FlowId?: number
|
|
@@ -945,7 +945,7 @@ export class Client extends AbstractClient {
|
|
|
945
945
|
|
|
946
946
|
/**
|
|
947
947
|
* 本接口(CreateLoadBalancer)用来创建负载均衡实例(本接口只支持购买按量计费的负载均衡,包年包月的负载均衡请通过控制台购买)。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
|
|
948
|
-
注意:(1)
|
|
948
|
+
注意:(1)可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的是是否支持创建IPv6实例;(2)一个账号在每个地域的默认购买配额为:公网100个,内网100个。
|
|
949
949
|
本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
|
|
950
950
|
*/
|
|
951
951
|
async CreateLoadBalancer(
|
|
@@ -212,12 +212,12 @@ OPEN:公网属性, INTERNAL:内网属性。
|
|
|
212
212
|
*/
|
|
213
213
|
Number?: number
|
|
214
214
|
/**
|
|
215
|
-
*
|
|
216
|
-
注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213)
|
|
215
|
+
* 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
|
|
216
|
+
注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
|
|
217
217
|
*/
|
|
218
218
|
MasterZoneId?: string
|
|
219
219
|
/**
|
|
220
|
-
*
|
|
220
|
+
* 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
|
|
221
221
|
*/
|
|
222
222
|
ZoneId?: string
|
|
223
223
|
/**
|
|
@@ -271,8 +271,8 @@ OPEN:公网属性, INTERNAL:内网属性。
|
|
|
271
271
|
*/
|
|
272
272
|
ClusterTag?: string
|
|
273
273
|
/**
|
|
274
|
-
*
|
|
275
|
-
注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213)
|
|
274
|
+
* 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
|
|
275
|
+
注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
|
|
276
276
|
*/
|
|
277
277
|
SlaveZoneId?: string
|
|
278
278
|
/**
|
|
@@ -1670,6 +1670,11 @@ export interface DescribeTaskStatusResponse {
|
|
|
1670
1670
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1671
1671
|
*/
|
|
1672
1672
|
LoadBalancerIds?: Array<string>
|
|
1673
|
+
/**
|
|
1674
|
+
* 辅助描述信息,如失败原因等。
|
|
1675
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1676
|
+
*/
|
|
1677
|
+
Message?: string
|
|
1673
1678
|
/**
|
|
1674
1679
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1675
1680
|
*/
|
|
@@ -1793,7 +1798,7 @@ export interface Target {
|
|
|
1793
1798
|
*/
|
|
1794
1799
|
Type?: string
|
|
1795
1800
|
/**
|
|
1796
|
-
* 绑定CVM时需要传入此参数,代表CVM的唯一 ID,可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IP
|
|
1801
|
+
* 绑定CVM时需要传入此参数,代表CVM的唯一 ID,可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IPv4地址;以下场景都不支持指定InstanceId:绑定非CVM,绑定CVM上的辅助网卡IP,通过跨域2.0绑定CVM,以及绑定CVM的IPv6地址等。
|
|
1797
1802
|
注意:参数 InstanceId、EniIp 有且只能传入其中一个参数。
|
|
1798
1803
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1799
1804
|
*/
|
|
@@ -2910,7 +2915,7 @@ export interface CreateClsLogSetResponse {
|
|
|
2910
2915
|
*/
|
|
2911
2916
|
export interface Backend {
|
|
2912
2917
|
/**
|
|
2913
|
-
* 后端服务的类型,可取:CVM、ENI、CCN
|
|
2918
|
+
* 后端服务的类型,可取:CVM、ENI、CCN、EVM、GLOBALROUTE、NAT、SRV等
|
|
2914
2919
|
*/
|
|
2915
2920
|
Type?: string
|
|
2916
2921
|
/**
|
|
@@ -4187,28 +4192,33 @@ export interface TargetHealth {
|
|
|
4187
4192
|
/**
|
|
4188
4193
|
* Target的内网IP
|
|
4189
4194
|
*/
|
|
4190
|
-
IP
|
|
4195
|
+
IP?: string
|
|
4191
4196
|
/**
|
|
4192
4197
|
* Target绑定的端口
|
|
4193
4198
|
*/
|
|
4194
|
-
Port
|
|
4199
|
+
Port?: number
|
|
4195
4200
|
/**
|
|
4196
4201
|
* 当前健康状态,true:健康,false:不健康(包括尚未开始探测、探测中、状态异常等几种状态)。只有处于健康状态(且权重大于0),负载均衡才会向其转发流量。
|
|
4197
4202
|
*/
|
|
4198
|
-
HealthStatus
|
|
4203
|
+
HealthStatus?: boolean
|
|
4199
4204
|
/**
|
|
4200
4205
|
* Target的实例ID,如 ins-12345678
|
|
4201
4206
|
*/
|
|
4202
|
-
TargetId
|
|
4207
|
+
TargetId?: string
|
|
4203
4208
|
/**
|
|
4204
|
-
* 当前健康状态的详细信息。如:Alive、Dead、Unknown。Alive状态为健康,Dead状态为异常,Unknown
|
|
4209
|
+
* 当前健康状态的详细信息。如:Alive、Dead、Unknown、Close。Alive状态为健康,Dead状态为异常,Unknown状态包括尚未开始探测、探测中、状态未知,Close表示健康检查关闭或监听器状态停止。
|
|
4205
4210
|
*/
|
|
4206
|
-
HealthStatusDetail
|
|
4211
|
+
HealthStatusDetail?: string
|
|
4207
4212
|
/**
|
|
4208
4213
|
* (**该参数对象即将下线,不推荐使用,请使用HealthStatusDetail获取健康详情**) 当前健康状态的详细信息。如:Alive、Dead、Unknown。Alive状态为健康,Dead状态为异常,Unknown状态包括尚未开始探测、探测中、状态未知。
|
|
4209
4214
|
* @deprecated
|
|
4210
4215
|
*/
|
|
4211
4216
|
HealthStatusDetial?: string
|
|
4217
|
+
/**
|
|
4218
|
+
* 目标组唯一ID。
|
|
4219
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4220
|
+
*/
|
|
4221
|
+
TargetGroupId?: string
|
|
4212
4222
|
}
|
|
4213
4223
|
|
|
4214
4224
|
/**
|
|
@@ -4225,7 +4235,7 @@ export interface LoadBalancerDetail {
|
|
|
4225
4235
|
LoadBalancerName?: string
|
|
4226
4236
|
/**
|
|
4227
4237
|
* 负载均衡实例的网络类型:
|
|
4228
|
-
OPEN:公网属性,INTERNAL
|
|
4238
|
+
OPEN:公网属性,INTERNAL:内网属性;对于内网属性的负载均衡,可通过绑定EIP出公网,具体可参考EIP文档。
|
|
4229
4239
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4230
4240
|
*/
|
|
4231
4241
|
LoadBalancerType?: string
|
|
@@ -5744,7 +5754,7 @@ export interface LoadBalancer {
|
|
|
5744
5754
|
LoadBalancerName?: string
|
|
5745
5755
|
/**
|
|
5746
5756
|
* 负载均衡实例的网络类型:
|
|
5747
|
-
OPEN:公网属性, INTERNAL
|
|
5757
|
+
OPEN:公网属性, INTERNAL:内网属性;对于内网属性的负载均衡,可通过绑定EIP出公网,具体可参考EIP文档。
|
|
5748
5758
|
*/
|
|
5749
5759
|
LoadBalancerType?: string
|
|
5750
5760
|
/**
|
|
@@ -717,6 +717,10 @@ export interface SearchFileBySidResult {
|
|
|
717
717
|
* 堡垒机拦截情况, 1-已执行, 2-被阻断
|
|
718
718
|
*/
|
|
719
719
|
Action?: number
|
|
720
|
+
/**
|
|
721
|
+
* 签名值
|
|
722
|
+
*/
|
|
723
|
+
SignValue?: string
|
|
720
724
|
}
|
|
721
725
|
|
|
722
726
|
/**
|
|
@@ -955,6 +959,10 @@ export interface SearchCommandResult {
|
|
|
955
959
|
* 会话大小
|
|
956
960
|
*/
|
|
957
961
|
Size?: number
|
|
962
|
+
/**
|
|
963
|
+
* 签名值
|
|
964
|
+
*/
|
|
965
|
+
SignValue?: string
|
|
958
966
|
}
|
|
959
967
|
|
|
960
968
|
/**
|
|
@@ -1140,6 +1148,10 @@ export interface OperationEvent {
|
|
|
1140
1148
|
* 操作结果,1-成功,2-失败
|
|
1141
1149
|
*/
|
|
1142
1150
|
Result?: number
|
|
1151
|
+
/**
|
|
1152
|
+
* 签名值
|
|
1153
|
+
*/
|
|
1154
|
+
SignValue?: string
|
|
1143
1155
|
}
|
|
1144
1156
|
|
|
1145
1157
|
/**
|
|
@@ -1600,6 +1612,10 @@ export interface Command {
|
|
|
1600
1612
|
* 会话大小
|
|
1601
1613
|
*/
|
|
1602
1614
|
Size?: number
|
|
1615
|
+
/**
|
|
1616
|
+
* 签名值
|
|
1617
|
+
*/
|
|
1618
|
+
SignValue?: string
|
|
1603
1619
|
}
|
|
1604
1620
|
|
|
1605
1621
|
/**
|
|
@@ -2468,6 +2484,10 @@ export interface User {
|
|
|
2468
2484
|
* 锁定状态 0 - 未锁定 1 - 锁定
|
|
2469
2485
|
*/
|
|
2470
2486
|
LockStatus?: number
|
|
2487
|
+
/**
|
|
2488
|
+
* ukey绑定状态 0 - 未绑定 1 - 已绑定
|
|
2489
|
+
*/
|
|
2490
|
+
UKeyStatus?: number
|
|
2471
2491
|
/**
|
|
2472
2492
|
* 状态 与Filter中一致
|
|
2473
2493
|
*/
|
|
@@ -3529,7 +3549,7 @@ export interface Resource {
|
|
|
3529
3549
|
*/
|
|
3530
3550
|
DeployModel?: number
|
|
3531
3551
|
/**
|
|
3532
|
-
* 0 默认值,非内网访问,1
|
|
3552
|
+
* 0 默认值,非内网访问,1 内网访问,2 内网访问开通中,3 内网访问关闭中
|
|
3533
3553
|
*/
|
|
3534
3554
|
IntranetAccess?: number
|
|
3535
3555
|
/**
|
|
@@ -4000,6 +4020,10 @@ export interface SearchFileResult {
|
|
|
4000
4020
|
* 上传或新建文件(夹)路径及名称
|
|
4001
4021
|
*/
|
|
4002
4022
|
FileNew?: string
|
|
4023
|
+
/**
|
|
4024
|
+
* 签名值
|
|
4025
|
+
*/
|
|
4026
|
+
SignValue?: string
|
|
4003
4027
|
}
|
|
4004
4028
|
|
|
4005
4029
|
/**
|
|
@@ -1829,7 +1829,7 @@ export interface CreateSLInstanceRequest {
|
|
|
1829
1829
|
*/
|
|
1830
1830
|
DiskType: string
|
|
1831
1831
|
/**
|
|
1832
|
-
* 实例单节点磁盘容量,单位GB,单节点磁盘容量需大于等于100,小于等于
|
|
1832
|
+
* 实例单节点磁盘容量,单位GB,单节点磁盘容量需大于等于100,小于等于250*CPU核心数,容量调整步长为100。
|
|
1833
1833
|
*/
|
|
1834
1834
|
DiskSize: number
|
|
1835
1835
|
/**
|
|
@@ -1689,14 +1689,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1689
1689
|
}
|
|
1690
1690
|
|
|
1691
1691
|
/**
|
|
1692
|
-
*
|
|
1692
|
+
* 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
|
|
1693
1693
|
**注意:**
|
|
1694
|
-
1.
|
|
1695
|
-
2.
|
|
1696
|
-
3.
|
|
1697
|
-
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1694
|
+
1. 该接口可生成签署人的批量、合同组签署/查看链接 。
|
|
1695
|
+
2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
1696
|
+
3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
1698
1697
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
1699
|
-
|
|
1698
|
+
4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1700
1699
|
*/
|
|
1701
1700
|
async CreateBatchQuickSignUrl(
|
|
1702
1701
|
req: CreateBatchQuickSignUrlRequest,
|
|
@@ -1626,6 +1626,13 @@ export interface CreateOrganizationAuthUrlRequest {
|
|
|
1626
1626
|
|
|
1627
1627
|
*/
|
|
1628
1628
|
Endpoint?: string
|
|
1629
|
+
/**
|
|
1630
|
+
* 指定企业初始化引导,现在可以配置如下的选项:
|
|
1631
|
+
|
|
1632
|
+
<b>1</b>: 启用此选项后,在企业认证的最终步骤将添加创建印章的引导。如下图的位置
|
|
1633
|
+

|
|
1634
|
+
*/
|
|
1635
|
+
Initialization?: Array<number | bigint>
|
|
1629
1636
|
}
|
|
1630
1637
|
|
|
1631
1638
|
/**
|
|
@@ -9434,6 +9441,11 @@ export interface CreateMultiFlowSignQRCodeRequest {
|
|
|
9434
9441
|
* 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
|
|
9435
9442
|
*/
|
|
9436
9443
|
ForbidPersonalMultipleSign?: boolean
|
|
9444
|
+
/**
|
|
9445
|
+
* 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
|
|
9446
|
+
例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
|
|
9447
|
+
*/
|
|
9448
|
+
FlowNameAppendScannerInfo?: boolean
|
|
9437
9449
|
}
|
|
9438
9450
|
|
|
9439
9451
|
/**
|
|
@@ -9672,10 +9684,13 @@ export interface CreateFlowBlockchainEvidenceUrlRequest {
|
|
|
9672
9684
|
export interface CreateBatchQuickSignUrlRequest {
|
|
9673
9685
|
/**
|
|
9674
9686
|
* 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
|
9687
|
+
<ul>
|
|
9688
|
+
<li>若为个人参与方:ApproverType=1</li>
|
|
9689
|
+
<li>若为企业参与方:ApproverType=0。同时 OrganizationName 参数需传入参与方企业名称。 </li>
|
|
9690
|
+
</ul>
|
|
9675
9691
|
注:
|
|
9676
|
-
`1.
|
|
9677
|
-
`2.
|
|
9678
|
-
`3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
9692
|
+
`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
|
|
9693
|
+
`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
9679
9694
|
*/
|
|
9680
9695
|
FlowApproverInfo: FlowCreateApprover
|
|
9681
9696
|
/**
|
|
@@ -9713,6 +9728,7 @@ export interface CreateBatchQuickSignUrlRequest {
|
|
|
9713
9728
|
<ul><li>默认情况下,签名类型为手写签名</li>
|
|
9714
9729
|
<li>您可以传递多种值,表示可用多种签名类型。</li>
|
|
9715
9730
|
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
|
|
9731
|
+
<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
|
|
9716
9732
|
</ul>
|
|
9717
9733
|
*/
|
|
9718
9734
|
SignatureTypes?: Array<number | bigint>
|
|
@@ -9735,7 +9751,9 @@ export interface CreateBatchQuickSignUrlRequest {
|
|
|
9735
9751
|
*/
|
|
9736
9752
|
SignTypeSelector?: number
|
|
9737
9753
|
/**
|
|
9738
|
-
* 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
9754
|
+
* 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
9755
|
+
|
|
9756
|
+
注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
|
|
9739
9757
|
*/
|
|
9740
9758
|
FlowBatchUrlInfo?: FlowBatchUrlInfo
|
|
9741
9759
|
/**
|
|
@@ -9749,6 +9767,8 @@ export interface CreateBatchQuickSignUrlRequest {
|
|
|
9749
9767
|
Intention?: Intention
|
|
9750
9768
|
/**
|
|
9751
9769
|
* 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
|
|
9770
|
+
|
|
9771
|
+
注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
|
|
9752
9772
|
*/
|
|
9753
9773
|
CacheApproverInfo?: boolean
|
|
9754
9774
|
}
|
|
@@ -656,11 +656,10 @@ export class Client extends AbstractClient {
|
|
|
656
656
|
}
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
*
|
|
659
|
+
* 该接口用于发起合同后,生成个人/企业用户的批量待办链接。
|
|
660
660
|
**注意:**
|
|
661
|
-
1.
|
|
662
|
-
2.
|
|
663
|
-
3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
661
|
+
1. 该接口可生成签署人的批量、合同组签署/查看链接 。
|
|
662
|
+
2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
664
663
|
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
665
664
|
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
666
665
|
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -2013,12 +2012,32 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
|
|
|
2013
2012
|
}
|
|
2014
2013
|
|
|
2015
2014
|
/**
|
|
2016
|
-
*
|
|
2015
|
+
* 您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
|
|
2017
2016
|
|
|
2018
|
-
|
|
2017
|
+
无论是<font color="red"><b>发起方还是签署方</b></font>填写的控件,均包含在查询结果中。
|
|
2019
2018
|
|
|
2019
|
+

|
|
2020
|
+
### 2. 那些控件会出现在结果里边?
|
|
2021
|
+
**A.不返回的控件类型:**
|
|
2022
|
+
- 动态表格
|
|
2023
|
+
- 附件控件
|
|
2024
|
+
- 水印控件
|
|
2025
|
+
|
|
2026
|
+
**B.返回的控件类型:**
|
|
2027
|
+
- 单行文本
|
|
2028
|
+
- 多行文本
|
|
2029
|
+
- 勾选框控件
|
|
2030
|
+
- 数字控件
|
|
2031
|
+
- 日期控件
|
|
2032
|
+
- 图片控件(图片下载地址)
|
|
2033
|
+
- 邮箱控件
|
|
2034
|
+
- 地址控件
|
|
2035
|
+
- 学历控件
|
|
2036
|
+
- 性别控件
|
|
2037
|
+
- 省市区控件
|
|
2038
|
+
|
|
2039
|
+
### 3.怎么授权?
|
|
2020
2040
|
|
|
2021
|
-
**授权**:
|
|
2022
2041
|
此接口需要授权, 有两种开通权限的途径
|
|
2023
2042
|
|
|
2024
2043
|
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
|
|
@@ -4505,10 +4505,14 @@ export interface ResourceUrlInfo {
|
|
|
4505
4505
|
export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
4506
4506
|
/**
|
|
4507
4507
|
* 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
|
4508
|
+
<ul>
|
|
4509
|
+
<li>若为个人参与方:ApproverType:"PERSON"</li>
|
|
4510
|
+
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
|
|
4511
|
+
</ul>
|
|
4512
|
+
|
|
4508
4513
|
注:
|
|
4509
|
-
`1.
|
|
4510
|
-
`2.
|
|
4511
|
-
`3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
4514
|
+
`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
|
|
4515
|
+
`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
4512
4516
|
*/
|
|
4513
4517
|
FlowApproverInfo: FlowApproverInfo
|
|
4514
4518
|
/**
|
|
@@ -4539,7 +4543,9 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
4539
4543
|
注:
|
|
4540
4544
|
<ul><li>默认情况下,签名类型为手写签名</li>
|
|
4541
4545
|
<li>您可以传递多种值,表示可用多种签名类型。</li>
|
|
4542
|
-
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li
|
|
4546
|
+
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
|
|
4547
|
+
<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
|
|
4548
|
+
</ul>
|
|
4543
4549
|
*/
|
|
4544
4550
|
SignatureTypes?: Array<number | bigint>
|
|
4545
4551
|
/**
|
|
@@ -4561,7 +4567,9 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
4561
4567
|
*/
|
|
4562
4568
|
SignTypeSelector?: number
|
|
4563
4569
|
/**
|
|
4564
|
-
* 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
4570
|
+
* 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
4571
|
+
|
|
4572
|
+
注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
|
|
4565
4573
|
*/
|
|
4566
4574
|
FlowBatchUrlInfo?: FlowBatchUrlInfo
|
|
4567
4575
|
/**
|
|
@@ -4570,6 +4578,8 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
4570
4578
|
Intention?: Intention
|
|
4571
4579
|
/**
|
|
4572
4580
|
* 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
|
|
4581
|
+
|
|
4582
|
+
注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
|
|
4573
4583
|
*/
|
|
4574
4584
|
CacheApproverInfo?: boolean
|
|
4575
4585
|
}
|
|
@@ -5096,6 +5106,10 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
5096
5106
|
* 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
|
|
5097
5107
|
*/
|
|
5098
5108
|
ForbidPersonalMultipleSign?: boolean
|
|
5109
|
+
/**
|
|
5110
|
+
* 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
|
|
5111
|
+
*/
|
|
5112
|
+
FlowNameAppendScannerInfo?: boolean
|
|
5099
5113
|
}
|
|
5100
5114
|
|
|
5101
5115
|
/**
|