tencentcloud-sdk-nodejs 4.0.877 → 4.0.878
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 +68 -0
- package/SERVICE_CHANGELOG.md +80 -168
- package/package.json +1 -1
- package/products.md +11 -11
- package/src/common/sdk_version.ts +1 -1
- package/src/services/csip/v20221121/csip_client.ts +31 -3
- package/src/services/csip/v20221121/csip_models.ts +339 -31
- package/src/services/ess/v20201111/ess_client.ts +2 -2
- package/src/services/ess/v20201111/ess_models.ts +3 -2
- package/src/services/essbasic/v20210526/essbasic_client.ts +6 -2
- package/src/services/essbasic/v20210526/essbasic_models.ts +3 -2
- package/src/services/gaap/v20180529/gaap_models.ts +10 -0
- package/src/services/ocr/v20181119/ocr_models.ts +22 -16
- package/src/services/redis/v20180412/redis_client.ts +2 -2
- package/src/services/redis/v20180412/redis_models.ts +37 -16
- package/src/services/wedata/v20210820/wedata_client.ts +12 -0
- package/src/services/wedata/v20210820/wedata_models.ts +42 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/csip/v20221121/csip_client.d.ts +9 -1
- package/tencentcloud/services/csip/v20221121/csip_client.js +12 -0
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +331 -31
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +2 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +2 -2
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +3 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +6 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -2
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +3 -2
- package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +10 -0
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +22 -16
- package/tencentcloud/services/redis/v20180412/redis_client.d.ts +2 -2
- package/tencentcloud/services/redis/v20180412/redis_client.js +2 -2
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +37 -16
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +5 -1
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +6 -0
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +40 -1
- package/test/csip.v20221121.test.js +20 -0
- package/test/wedata.v20210820.test.js +10 -0
|
@@ -221,6 +221,28 @@ export interface ReportItemKey {
|
|
|
221
221
|
TaskLogList: Array<string>
|
|
222
222
|
}
|
|
223
223
|
|
|
224
|
+
/**
|
|
225
|
+
* 任务高级配置
|
|
226
|
+
*/
|
|
227
|
+
export interface TaskAdvanceCFG {
|
|
228
|
+
/**
|
|
229
|
+
* 端口风险高级配置
|
|
230
|
+
*/
|
|
231
|
+
PortRisk?: Array<PortRiskAdvanceCFGParamItem>
|
|
232
|
+
/**
|
|
233
|
+
* 漏洞风险高级配置
|
|
234
|
+
*/
|
|
235
|
+
VulRisk?: Array<TaskCenterVulRiskInputParam>
|
|
236
|
+
/**
|
|
237
|
+
* 弱口令风险高级配置
|
|
238
|
+
*/
|
|
239
|
+
WeakPwdRisk?: Array<TaskCenterWeakPwdRiskInputParam>
|
|
240
|
+
/**
|
|
241
|
+
* 配置风险高级配置
|
|
242
|
+
*/
|
|
243
|
+
CFGRisk?: Array<TaskCenterCFGRiskInputParam>
|
|
244
|
+
}
|
|
245
|
+
|
|
224
246
|
/**
|
|
225
247
|
* 主机资产信息
|
|
226
248
|
*/
|
|
@@ -1046,17 +1068,21 @@ export interface PortRiskAdvanceCFGParamItem {
|
|
|
1046
1068
|
}
|
|
1047
1069
|
|
|
1048
1070
|
/**
|
|
1049
|
-
*
|
|
1071
|
+
* DescribeVULRiskDetail请求参数结构体
|
|
1050
1072
|
*/
|
|
1051
|
-
export interface
|
|
1052
|
-
/**
|
|
1053
|
-
* 任务id 列表
|
|
1054
|
-
*/
|
|
1055
|
-
TaskIdList: Array<TaskIdListKey>
|
|
1073
|
+
export interface DescribeVULRiskDetailRequest {
|
|
1056
1074
|
/**
|
|
1057
1075
|
* 集团账号的成员id
|
|
1058
1076
|
*/
|
|
1059
1077
|
MemberId?: Array<string>
|
|
1078
|
+
/**
|
|
1079
|
+
* 风险id
|
|
1080
|
+
*/
|
|
1081
|
+
RiskId?: string
|
|
1082
|
+
/**
|
|
1083
|
+
* pcMgrId
|
|
1084
|
+
*/
|
|
1085
|
+
PCMGRId?: string
|
|
1060
1086
|
}
|
|
1061
1087
|
|
|
1062
1088
|
/**
|
|
@@ -1481,6 +1507,36 @@ export interface DescribeTopAttackInfoResponse {
|
|
|
1481
1507
|
RequestId?: string
|
|
1482
1508
|
}
|
|
1483
1509
|
|
|
1510
|
+
/**
|
|
1511
|
+
* DescribeVULRiskDetail返回参数结构体
|
|
1512
|
+
*/
|
|
1513
|
+
export interface DescribeVULRiskDetailResponse {
|
|
1514
|
+
/**
|
|
1515
|
+
* 安全产品支持情况
|
|
1516
|
+
*/
|
|
1517
|
+
ServiceSupport?: Array<ServiceSupport>
|
|
1518
|
+
/**
|
|
1519
|
+
* 漏洞趋势
|
|
1520
|
+
*/
|
|
1521
|
+
VulTrend?: Array<VulTrend>
|
|
1522
|
+
/**
|
|
1523
|
+
* 漏洞补充信息
|
|
1524
|
+
*/
|
|
1525
|
+
VulData?: VULRiskInfo
|
|
1526
|
+
/**
|
|
1527
|
+
* 小助手问答id
|
|
1528
|
+
*/
|
|
1529
|
+
QuestionId?: string
|
|
1530
|
+
/**
|
|
1531
|
+
* 会话id
|
|
1532
|
+
*/
|
|
1533
|
+
SessionId?: string
|
|
1534
|
+
/**
|
|
1535
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1536
|
+
*/
|
|
1537
|
+
RequestId?: string
|
|
1538
|
+
}
|
|
1539
|
+
|
|
1484
1540
|
/**
|
|
1485
1541
|
* DescribeVULRiskAdvanceCFGList请求参数结构体
|
|
1486
1542
|
*/
|
|
@@ -2957,6 +3013,22 @@ export interface DescribeCVMAssetsResponse {
|
|
|
2957
3013
|
RequestId?: string
|
|
2958
3014
|
}
|
|
2959
3015
|
|
|
3016
|
+
/**
|
|
3017
|
+
* 漏洞影响组件信息
|
|
3018
|
+
*/
|
|
3019
|
+
export interface VulImpactComponentInfo {
|
|
3020
|
+
/**
|
|
3021
|
+
* 组件名称
|
|
3022
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3023
|
+
*/
|
|
3024
|
+
Component?: string
|
|
3025
|
+
/**
|
|
3026
|
+
* 版本名称
|
|
3027
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3028
|
+
*/
|
|
3029
|
+
Version?: string
|
|
3030
|
+
}
|
|
3031
|
+
|
|
2960
3032
|
/**
|
|
2961
3033
|
* 漏洞风险高级配置列表
|
|
2962
3034
|
*/
|
|
@@ -3056,6 +3128,30 @@ export interface VULRiskAdvanceCFGList {
|
|
|
3056
3128
|
RecentScanTime?: string
|
|
3057
3129
|
}
|
|
3058
3130
|
|
|
3131
|
+
/**
|
|
3132
|
+
* 过滤条件
|
|
3133
|
+
*/
|
|
3134
|
+
export interface WhereFilter {
|
|
3135
|
+
/**
|
|
3136
|
+
* 过滤的项
|
|
3137
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3138
|
+
*/
|
|
3139
|
+
Name: string
|
|
3140
|
+
/**
|
|
3141
|
+
* 过滤的值
|
|
3142
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3143
|
+
*/
|
|
3144
|
+
Values: Array<string>
|
|
3145
|
+
/**
|
|
3146
|
+
* 中台定义:
|
|
3147
|
+
1等于 2大于 3小于 4大于等于 5小于等于 6不等于 9模糊匹配 13非模糊匹配 14按位与
|
|
3148
|
+
精确匹配填 7 模糊匹配填9
|
|
3149
|
+
|
|
3150
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3151
|
+
*/
|
|
3152
|
+
OperatorType?: number
|
|
3153
|
+
}
|
|
3154
|
+
|
|
3059
3155
|
/**
|
|
3060
3156
|
* DescribePublicIpAssets请求参数结构体
|
|
3061
3157
|
*/
|
|
@@ -3570,25 +3666,17 @@ export interface TaskCenterVulRiskInputParam {
|
|
|
3570
3666
|
}
|
|
3571
3667
|
|
|
3572
3668
|
/**
|
|
3573
|
-
*
|
|
3669
|
+
* StopRiskCenterTask请求参数结构体
|
|
3574
3670
|
*/
|
|
3575
|
-
export interface
|
|
3576
|
-
/**
|
|
3577
|
-
* 端口风险高级配置
|
|
3578
|
-
*/
|
|
3579
|
-
PortRisk?: Array<PortRiskAdvanceCFGParamItem>
|
|
3580
|
-
/**
|
|
3581
|
-
* 漏洞风险高级配置
|
|
3582
|
-
*/
|
|
3583
|
-
VulRisk?: Array<TaskCenterVulRiskInputParam>
|
|
3671
|
+
export interface StopRiskCenterTaskRequest {
|
|
3584
3672
|
/**
|
|
3585
|
-
*
|
|
3673
|
+
* 任务id 列表
|
|
3586
3674
|
*/
|
|
3587
|
-
|
|
3675
|
+
TaskIdList: Array<TaskIdListKey>
|
|
3588
3676
|
/**
|
|
3589
|
-
*
|
|
3677
|
+
* 集团账号的成员id
|
|
3590
3678
|
*/
|
|
3591
|
-
|
|
3679
|
+
MemberId?: Array<string>
|
|
3592
3680
|
}
|
|
3593
3681
|
|
|
3594
3682
|
/**
|
|
@@ -3902,6 +3990,32 @@ export interface PortViewPortRisk {
|
|
|
3902
3990
|
Service?: string
|
|
3903
3991
|
}
|
|
3904
3992
|
|
|
3993
|
+
/**
|
|
3994
|
+
* 漏洞风险信息
|
|
3995
|
+
*/
|
|
3996
|
+
export interface VULRiskInfo {
|
|
3997
|
+
/**
|
|
3998
|
+
* 修复建议
|
|
3999
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4000
|
+
*/
|
|
4001
|
+
Fix?: string
|
|
4002
|
+
/**
|
|
4003
|
+
* 技术参考/参考链接
|
|
4004
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4005
|
+
*/
|
|
4006
|
+
References?: string
|
|
4007
|
+
/**
|
|
4008
|
+
* 漏洞描述
|
|
4009
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4010
|
+
*/
|
|
4011
|
+
Describe?: string
|
|
4012
|
+
/**
|
|
4013
|
+
* 受影响组件
|
|
4014
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4015
|
+
*/
|
|
4016
|
+
ImpactComponent?: Array<VulImpactComponentInfo>
|
|
4017
|
+
}
|
|
4018
|
+
|
|
3905
4019
|
/**
|
|
3906
4020
|
* DescribeClusterPodAssets请求参数结构体
|
|
3907
4021
|
*/
|
|
@@ -3976,6 +4090,24 @@ export interface DescribePublicIpAssetsResponse {
|
|
|
3976
4090
|
RequestId?: string
|
|
3977
4091
|
}
|
|
3978
4092
|
|
|
4093
|
+
/**
|
|
4094
|
+
* DescribeVulViewVulRiskList请求参数结构体
|
|
4095
|
+
*/
|
|
4096
|
+
export interface DescribeVulViewVulRiskListRequest {
|
|
4097
|
+
/**
|
|
4098
|
+
* 集团账号的成员id
|
|
4099
|
+
*/
|
|
4100
|
+
MemberId?: Array<string>
|
|
4101
|
+
/**
|
|
4102
|
+
* 过滤内容
|
|
4103
|
+
*/
|
|
4104
|
+
Filter?: Filter
|
|
4105
|
+
/**
|
|
4106
|
+
* 资产标签
|
|
4107
|
+
*/
|
|
4108
|
+
Tags?: Array<AssetTag>
|
|
4109
|
+
}
|
|
4110
|
+
|
|
3979
4111
|
/**
|
|
3980
4112
|
* DescribeTaskLogURL返回参数结构体
|
|
3981
4113
|
*/
|
|
@@ -3990,6 +4122,32 @@ export interface DescribeTaskLogURLResponse {
|
|
|
3990
4122
|
RequestId?: string
|
|
3991
4123
|
}
|
|
3992
4124
|
|
|
4125
|
+
/**
|
|
4126
|
+
* 漏洞趋势-攻击趋势、影响用户、影响资产
|
|
4127
|
+
*/
|
|
4128
|
+
export interface VulTrend {
|
|
4129
|
+
/**
|
|
4130
|
+
* 影响的资产数
|
|
4131
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4132
|
+
*/
|
|
4133
|
+
AffectAssetCount?: number
|
|
4134
|
+
/**
|
|
4135
|
+
* 影响的用户数
|
|
4136
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4137
|
+
*/
|
|
4138
|
+
AffectUserCount?: number
|
|
4139
|
+
/**
|
|
4140
|
+
* 攻击数
|
|
4141
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4142
|
+
*/
|
|
4143
|
+
AttackCount?: number
|
|
4144
|
+
/**
|
|
4145
|
+
* 时间
|
|
4146
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4147
|
+
*/
|
|
4148
|
+
Date?: string
|
|
4149
|
+
}
|
|
4150
|
+
|
|
3993
4151
|
/**
|
|
3994
4152
|
* ModifyOrganizationAccountStatus返回参数结构体
|
|
3995
4153
|
*/
|
|
@@ -5024,27 +5182,141 @@ export interface RelatedEvent {
|
|
|
5024
5182
|
}
|
|
5025
5183
|
|
|
5026
5184
|
/**
|
|
5027
|
-
*
|
|
5185
|
+
* 漏洞视角的漏洞风险对象
|
|
5028
5186
|
*/
|
|
5029
|
-
export interface
|
|
5187
|
+
export interface VULViewVULRiskData {
|
|
5030
5188
|
/**
|
|
5031
|
-
*
|
|
5189
|
+
* 端口
|
|
5190
|
+
*/
|
|
5191
|
+
Port?: string
|
|
5192
|
+
/**
|
|
5193
|
+
* 影响资产
|
|
5194
|
+
*/
|
|
5195
|
+
NoHandleCount?: number
|
|
5196
|
+
/**
|
|
5197
|
+
* 风险等级,low-低危,high-高危,middle-中危,info-提示,extreme-严重。
|
|
5198
|
+
*/
|
|
5199
|
+
Level?: string
|
|
5200
|
+
/**
|
|
5201
|
+
* 组件
|
|
5202
|
+
*/
|
|
5203
|
+
Component?: string
|
|
5204
|
+
/**
|
|
5205
|
+
* 最近识别时间
|
|
5206
|
+
*/
|
|
5207
|
+
RecentTime?: string
|
|
5208
|
+
/**
|
|
5209
|
+
* 首次识别时间
|
|
5210
|
+
*/
|
|
5211
|
+
FirstTime?: string
|
|
5212
|
+
/**
|
|
5213
|
+
* 影响资产数量
|
|
5214
|
+
*/
|
|
5215
|
+
AffectAssetCount?: number
|
|
5216
|
+
/**
|
|
5217
|
+
* 风险ID
|
|
5218
|
+
*/
|
|
5219
|
+
RiskId?: string
|
|
5220
|
+
/**
|
|
5221
|
+
* 扫描来源,具体看接口返回枚举类型
|
|
5222
|
+
*/
|
|
5223
|
+
From?: string
|
|
5224
|
+
/**
|
|
5225
|
+
* 前端索引
|
|
5226
|
+
*/
|
|
5227
|
+
Index?: string
|
|
5228
|
+
/**
|
|
5229
|
+
* 漏洞类型
|
|
5230
|
+
*/
|
|
5231
|
+
VULType?: string
|
|
5232
|
+
/**
|
|
5233
|
+
* 漏洞名
|
|
5234
|
+
*/
|
|
5235
|
+
VULName?: string
|
|
5236
|
+
/**
|
|
5237
|
+
* cve
|
|
5238
|
+
*/
|
|
5239
|
+
CVE?: string
|
|
5240
|
+
/**
|
|
5241
|
+
* 漏洞payload
|
|
5242
|
+
*/
|
|
5243
|
+
Payload?: string
|
|
5244
|
+
/**
|
|
5245
|
+
* 漏洞影响组件
|
|
5246
|
+
*/
|
|
5247
|
+
AppName?: string
|
|
5248
|
+
/**
|
|
5249
|
+
* 漏洞影响版本
|
|
5250
|
+
*/
|
|
5251
|
+
AppVersion?: string
|
|
5252
|
+
/**
|
|
5253
|
+
* 风险点
|
|
5254
|
+
*/
|
|
5255
|
+
VULURL?: string
|
|
5256
|
+
/**
|
|
5257
|
+
* 用户昵称
|
|
5032
5258
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5033
5259
|
*/
|
|
5034
|
-
|
|
5260
|
+
Nick?: string
|
|
5035
5261
|
/**
|
|
5036
|
-
*
|
|
5262
|
+
* 用户appid
|
|
5263
|
+
*/
|
|
5264
|
+
AppId?: string
|
|
5265
|
+
/**
|
|
5266
|
+
* 用户uin
|
|
5037
5267
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5038
5268
|
*/
|
|
5039
|
-
|
|
5269
|
+
Uin?: string
|
|
5040
5270
|
/**
|
|
5041
|
-
*
|
|
5042
|
-
1等于 2大于 3小于 4大于等于 5小于等于 6不等于 9模糊匹配 13非模糊匹配 14按位与
|
|
5043
|
-
精确匹配填 7 模糊匹配填9
|
|
5044
|
-
|
|
5271
|
+
* 应急漏洞类型,1-应急漏洞,0-非应急漏洞
|
|
5045
5272
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5046
5273
|
*/
|
|
5047
|
-
|
|
5274
|
+
EMGCVulType?: number
|
|
5275
|
+
/**
|
|
5276
|
+
* CVSS评分
|
|
5277
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5278
|
+
*/
|
|
5279
|
+
CVSS?: number
|
|
5280
|
+
/**
|
|
5281
|
+
* PCMGRId
|
|
5282
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5283
|
+
*/
|
|
5284
|
+
PCMGRId?: string
|
|
5285
|
+
/**
|
|
5286
|
+
* 漏洞标签。搜索时应急 必修传参VulTag=SuggestRepair/EMGCVul
|
|
5287
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5288
|
+
*/
|
|
5289
|
+
VulTag?: Array<string>
|
|
5290
|
+
/**
|
|
5291
|
+
* 漏洞披露时间
|
|
5292
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5293
|
+
*/
|
|
5294
|
+
DisclosureTime?: string
|
|
5295
|
+
/**
|
|
5296
|
+
* 攻击热度
|
|
5297
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5298
|
+
*/
|
|
5299
|
+
AttackHeat?: number
|
|
5300
|
+
/**
|
|
5301
|
+
* 是否必修漏洞1是,0不是
|
|
5302
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5303
|
+
*/
|
|
5304
|
+
IsSuggest?: number
|
|
5305
|
+
/**
|
|
5306
|
+
* 处置任务id
|
|
5307
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5308
|
+
*/
|
|
5309
|
+
HandleTaskId?: string
|
|
5310
|
+
/**
|
|
5311
|
+
* 引擎来源
|
|
5312
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5313
|
+
*/
|
|
5314
|
+
EngineSource?: string
|
|
5315
|
+
/**
|
|
5316
|
+
* 新的漏洞风险id
|
|
5317
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
5318
|
+
*/
|
|
5319
|
+
VulRiskId?: string
|
|
5048
5320
|
}
|
|
5049
5321
|
|
|
5050
5322
|
/**
|
|
@@ -6206,6 +6478,42 @@ export interface DescribeGatewayAssetsRequest {
|
|
|
6206
6478
|
Filter?: Filter
|
|
6207
6479
|
}
|
|
6208
6480
|
|
|
6481
|
+
/**
|
|
6482
|
+
* DescribeVulViewVulRiskList返回参数结构体
|
|
6483
|
+
*/
|
|
6484
|
+
export interface DescribeVulViewVulRiskListResponse {
|
|
6485
|
+
/**
|
|
6486
|
+
* 总条数
|
|
6487
|
+
*/
|
|
6488
|
+
TotalCount?: number
|
|
6489
|
+
/**
|
|
6490
|
+
* 漏洞产视角的漏洞风险列表
|
|
6491
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6492
|
+
*/
|
|
6493
|
+
Data?: Array<VULViewVULRiskData>
|
|
6494
|
+
/**
|
|
6495
|
+
* 危险等级列表
|
|
6496
|
+
*/
|
|
6497
|
+
LevelLists?: Array<FilterDataObject>
|
|
6498
|
+
/**
|
|
6499
|
+
* 来源列表
|
|
6500
|
+
*/
|
|
6501
|
+
FromLists?: Array<FilterDataObject>
|
|
6502
|
+
/**
|
|
6503
|
+
* 漏洞类型列表
|
|
6504
|
+
*/
|
|
6505
|
+
VULTypeLists?: Array<FilterDataObject>
|
|
6506
|
+
/**
|
|
6507
|
+
* tag枚举
|
|
6508
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6509
|
+
*/
|
|
6510
|
+
Tags?: Array<FilterDataObject>
|
|
6511
|
+
/**
|
|
6512
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
6513
|
+
*/
|
|
6514
|
+
RequestId?: string
|
|
6515
|
+
}
|
|
6516
|
+
|
|
6209
6517
|
/**
|
|
6210
6518
|
* CreateDomainAndIp返回参数结构体
|
|
6211
6519
|
*/
|
|
@@ -1271,8 +1271,8 @@ p.s.
|
|
|
1271
1271
|
|
|
1272
1272
|
**注意**
|
|
1273
1273
|
1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
1274
|
-
2. 该接口返回的签署链接适用于APP集成的场景,支持APP
|
|
1275
|
-
|
|
1274
|
+
2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
1275
|
+
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1276
1276
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1277
1277
|
*/
|
|
1278
1278
|
async CreateFlowSignUrl(
|
|
@@ -5768,7 +5768,7 @@ export interface CreateFlowSignUrlRequest {
|
|
|
5768
5768
|
* 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
|
|
5769
5769
|
|
|
5770
5770
|
注:
|
|
5771
|
-
`1.
|
|
5771
|
+
`1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
5772
5772
|
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
5773
5773
|
*/
|
|
5774
5774
|
FlowApproverInfos?: Array<FlowCreateApprover>
|
|
@@ -5778,7 +5778,8 @@ export interface CreateFlowSignUrlRequest {
|
|
|
5778
5778
|
*/
|
|
5779
5779
|
Organization?: OrganizationInfo
|
|
5780
5780
|
/**
|
|
5781
|
-
* 签署完之后的H5
|
|
5781
|
+
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
5782
|
+
|
|
5782
5783
|
*/
|
|
5783
5784
|
JumpUrl?: string
|
|
5784
5785
|
/**
|
|
@@ -396,6 +396,10 @@ export class Client extends AbstractClient {
|
|
|
396
396
|
`3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)`
|
|
397
397
|
|
|
398
398
|
`4. 静默(自动)签署不支持合同签署方存在填写功能`
|
|
399
|
+
|
|
400
|
+
<font color="red">相关视频指引</font> <br>
|
|
401
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
|
|
402
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a><br>
|
|
399
403
|
*/
|
|
400
404
|
async ChannelCreateFlowByFiles(
|
|
401
405
|
req: ChannelCreateFlowByFilesRequest,
|
|
@@ -1157,8 +1161,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
1157
1161
|
|
|
1158
1162
|
**注意**
|
|
1159
1163
|
1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
1160
|
-
2. 该接口返回的签署链接适用于APP集成的场景,支持APP
|
|
1161
|
-
|
|
1164
|
+
2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
|
|
1165
|
+
如需跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
1162
1166
|
3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
1163
1167
|
*/
|
|
1164
1168
|
async ChannelCreateFlowSignUrl(
|
|
@@ -8053,7 +8053,7 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
8053
8053
|
* 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId,其他可不传。
|
|
8054
8054
|
|
|
8055
8055
|
注:
|
|
8056
|
-
`1.
|
|
8056
|
+
`1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
8057
8057
|
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
8058
8058
|
*/
|
|
8059
8059
|
FlowApproverInfos?: Array<FlowApproverInfo>
|
|
@@ -8068,7 +8068,8 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
8068
8068
|
*/
|
|
8069
8069
|
Organization?: OrganizationInfo
|
|
8070
8070
|
/**
|
|
8071
|
-
* 签署完之后的H5
|
|
8071
|
+
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
8072
|
+
|
|
8072
8073
|
*/
|
|
8073
8074
|
JumpUrl?: string
|
|
8074
8075
|
/**
|
|
@@ -4866,6 +4866,16 @@ export interface DomainRuleSet {
|
|
|
4866
4866
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4867
4867
|
*/
|
|
4868
4868
|
IsDefaultServer?: boolean
|
|
4869
|
+
/**
|
|
4870
|
+
* TLS套件包
|
|
4871
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4872
|
+
*/
|
|
4873
|
+
TLSCiphers?: string
|
|
4874
|
+
/**
|
|
4875
|
+
* TLS版本
|
|
4876
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4877
|
+
*/
|
|
4878
|
+
TLSSupportVersion?: Array<string>
|
|
4869
4879
|
}
|
|
4870
4880
|
|
|
4871
4881
|
/**
|
|
@@ -6286,14 +6286,17 @@ Quality,图片质量分数,请求 Config.Quality 时返回(取值范围:
|
|
|
6286
6286
|
BorderCodeValue,身份证边框不完整告警阈值分数,请求 Config.BorderCheckWarn时返回(取值范围:0 ~ 100,分数越低边框遮挡可能性越低,建议阈值≤50);
|
|
6287
6287
|
|
|
6288
6288
|
WarnInfos,告警信息,Code 告警码列表和释义:
|
|
6289
|
-
-9100
|
|
6290
|
-
-9101
|
|
6291
|
-
|
|
6292
|
-
-
|
|
6293
|
-
-
|
|
6294
|
-
|
|
6295
|
-
-
|
|
6296
|
-
-
|
|
6289
|
+
-9100 身份证有效日期不合法告警,
|
|
6290
|
+
-9101 身份证边框不完整告警,
|
|
6291
|
+
|
|
6292
|
+
-9102 身份证复印件告警(黑白及彩色复印件),
|
|
6293
|
+
-9108 身份证复印件告警(仅黑白复印件),
|
|
6294
|
+
|
|
6295
|
+
-9103 身份证翻拍告警,
|
|
6296
|
+
-9105 身份证框内遮挡告警,
|
|
6297
|
+
-9104 临时身份证告警,
|
|
6298
|
+
-9106 身份证疑似存在PS痕迹告警,
|
|
6299
|
+
-9107 身份证反光告警。
|
|
6297
6300
|
*/
|
|
6298
6301
|
AdvancedInfo?: string
|
|
6299
6302
|
/**
|
|
@@ -7363,14 +7366,17 @@ Quality,图片质量分数,请求 Config.Quality 时返回(取值范围:
|
|
|
7363
7366
|
BorderCodeValue,身份证边框不完整告警阈值分数,请求 Config.BorderCheckWarn时返回(取值范围:0 ~ 100,分数越低边框遮挡可能性越低,建议阈值≤50);
|
|
7364
7367
|
|
|
7365
7368
|
WarnInfos,告警信息,Code 告警码列表和释义:
|
|
7366
|
-
-9100
|
|
7367
|
-
-9101
|
|
7368
|
-
|
|
7369
|
-
-
|
|
7370
|
-
-
|
|
7371
|
-
|
|
7372
|
-
-
|
|
7373
|
-
-
|
|
7369
|
+
-9100 身份证有效日期不合法告警,
|
|
7370
|
+
-9101 身份证边框不完整告警,
|
|
7371
|
+
|
|
7372
|
+
-9102 身份证复印件告警(黑白及彩色复印件),
|
|
7373
|
+
-9108 身份证复印件告警(仅黑白复印件),
|
|
7374
|
+
|
|
7375
|
+
-9103 身份证翻拍告警,
|
|
7376
|
+
-9105 身份证框内遮挡告警,
|
|
7377
|
+
-9104 临时身份证告警,
|
|
7378
|
+
-9106 身份证疑似存在PS痕迹告警,
|
|
7379
|
+
-9107 身份证反光告警。
|
|
7374
7380
|
*/
|
|
7375
7381
|
AdvancedInfo?: string
|
|
7376
7382
|
/**
|
|
@@ -1095,7 +1095,7 @@ export class Client extends AbstractClient {
|
|
|
1095
1095
|
}
|
|
1096
1096
|
|
|
1097
1097
|
/**
|
|
1098
|
-
*
|
|
1098
|
+
* 本接口(InquiryPriceRenewInstance)用于查询包年包月计费实例的续费价格。
|
|
1099
1099
|
*/
|
|
1100
1100
|
async InquiryPriceRenewInstance(
|
|
1101
1101
|
req: InquiryPriceRenewInstanceRequest,
|
|
@@ -1265,7 +1265,7 @@ export class Client extends AbstractClient {
|
|
|
1265
1265
|
}
|
|
1266
1266
|
|
|
1267
1267
|
/**
|
|
1268
|
-
*
|
|
1268
|
+
* 本接口(DescribeMaintenanceWindow)用于查询实例维护时间窗。在实例需要进行版本升级或者架构升级的时候,会在维护时间窗时间内进行切换
|
|
1269
1269
|
*/
|
|
1270
1270
|
async DescribeMaintenanceWindow(
|
|
1271
1271
|
req: DescribeMaintenanceWindowRequest,
|