tencentcloud-sdk-nodejs 4.0.814 → 4.0.816

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 (46) hide show
  1. package/CHANGELOG.md +229 -0
  2. package/SERVICE_CHANGELOG.md +332 -131
  3. package/package.json +1 -1
  4. package/products.md +192 -192
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cfs/v20190719/cfs_models.ts +3 -4
  7. package/src/services/cls/v20201016/cls_models.ts +1 -1
  8. package/src/services/ess/v20201111/ess_client.ts +21 -5
  9. package/src/services/ess/v20201111/ess_models.ts +103 -32
  10. package/src/services/essbasic/v20210526/essbasic_client.ts +26 -5
  11. package/src/services/essbasic/v20210526/essbasic_models.ts +97 -20
  12. package/src/services/live/v20180801/live_models.ts +4 -0
  13. package/src/services/monitor/v20180724/monitor_client.ts +45 -8
  14. package/src/services/monitor/v20180724/monitor_models.ts +346 -228
  15. package/src/services/tat/v20201028/tat_models.ts +9 -7
  16. package/src/services/teo/v20220901/teo_models.ts +3 -2
  17. package/src/services/tke/v20180525/tke_models.ts +8 -3
  18. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  19. package/src/services/vpc/v20170312/vpc_models.ts +11 -11
  20. package/src/services/waf/v20180125/waf_client.ts +4 -4
  21. package/src/services/waf/v20180125/waf_models.ts +83 -30
  22. package/tencentcloud/common/sdk_version.d.ts +1 -1
  23. package/tencentcloud/common/sdk_version.js +1 -1
  24. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +3 -4
  25. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  26. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +12 -5
  27. package/tencentcloud/services/ess/v20201111/ess_client.js +13 -4
  28. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +100 -32
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +17 -5
  30. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -4
  31. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +94 -20
  32. package/tencentcloud/services/live/v20180801/live_models.d.ts +4 -0
  33. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +13 -1
  34. package/tencentcloud/services/monitor/v20180724/monitor_client.js +18 -0
  35. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +338 -227
  36. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +9 -7
  37. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +3 -2
  38. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +8 -3
  39. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  40. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +11 -11
  41. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +4 -4
  42. package/tencentcloud/services/waf/v20180125/waf_client.js +4 -4
  43. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +83 -30
  44. package/test/ess.v20201111.test.js +10 -0
  45. package/test/essbasic.v20210526.test.js +10 -0
  46. package/test/monitor.v20180724.test.js +30 -0
@@ -267,7 +267,8 @@ export interface Invocation {
267
267
  /**
268
268
  * 执行任务状态。取值范围:
269
269
 
270
- <ul> <li>PENDING:等待下发</li> <li>RUNNING:命令运行中</li> <li>SUCCESS:命令成功</li> <li>FAILED:命令失败</li> <li>TIMEOUT:命令超时</li> <li>PARTIAL_FAILED:命令部分失败</li> </ul>
270
+ <ul> <li>PENDING:等待下发</li> <li>RUNNING:命令运行中</li> <li>SUCCESS:命令成功</li> <li>FAILED:命令失败</li> <li>TIMEOUT:命令超时</li> <li>PARTIAL_FAILED:命令部分失败</li> <li>PARTIAL_CANCELLED:任务部分取消</li> <li>CANCELLED:任务全部取消</li> <li>CANCELLING:任务取消中</li> </ul>
271
+
271
272
  */
272
273
  InvocationStatus?: string
273
274
  /**
@@ -1145,13 +1146,14 @@ export interface DescribeInvocationsRequest {
1145
1146
  > * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。
1146
1147
  > * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。
1147
1148
  >
1148
- > 以[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口的`Filter`为例。若我们需要查询可用区(`zone`)为广州一区 ***并且*** 实例计费模式(`instance-charge-type`)为包年包月 ***或者*** 按量计费的实例时,可如下实现:
1149
+ > 以[DescribeCommands](https://cloud.tencent.com/document/api/1340/52681)接口的`Filters`为例。若我们需要查询命令名称(`command-name`)为 “打印工作目录” ***并且*** 命令类型(`command-type`)为 “POWERSHELL” ***或者*** “BAT” 时,可如下实现:
1149
1150
  ```
1150
- Filters.0.Name=zone
1151
- &Filters.0.Values.0=ap-guangzhou-1
1152
- &Filters.1.Name=instance-charge-type
1153
- &Filters.1.Values.0=PREPAID
1154
- &Filters.1.Values.1=POSTPAID_BY_HOUR
1151
+ Filters.0.Name=command-name
1152
+ &Filters.0.Values.0=打印工作目录
1153
+
1154
+ &Filters.1.Name=command-type
1155
+ &Filters.1.Values.0=POWERSHELL
1156
+ &Filters.1.Values.1=BAT
1155
1157
  ```
1156
1158
  */
1157
1159
  export interface Filter {
@@ -461,7 +461,8 @@ export interface DescribeAliasDomainsRequest {
461
461
  Limit?: number
462
462
  /**
463
463
  * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:
464
- <li>target-name<br>   按照【<strong>目标域名名称</strong>】进行过滤。<br>   类型:String<br>   必选:否</li><li>alias-name<br>   按照【<strong>别称域名名称</strong>】进行过滤。<br>   类型:String<br>   必选:否</li>模糊查询时仅支持过滤字段名为alias-name。
464
+ <li>target-name:目标域名名称进行过滤;</li>
465
+ <li>alias-name:按照别称域名名称进行过滤。</li>模糊查询时仅支持过滤字段名为 alias-name。
465
466
  */
466
467
  Filters?: Array<AdvancedFilter>
467
468
  }
@@ -6973,7 +6974,7 @@ export interface DescribeHostsSettingRequest {
6973
6974
  Limit?: number
6974
6975
  /**
6975
6976
  * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:
6976
- <li>host<br>   按照【<strong>域名</strong>】进行过滤。<br>   类型:string<br>   必选:否</li>
6977
+ <li>host:按照域名进行过滤。</li>
6977
6978
  */
6978
6979
  Filters?: Array<Filter>
6979
6980
  }
@@ -1247,17 +1247,22 @@ export interface PodLimitsByType {
1247
1247
  * TKE共享网卡非固定IP模式可支持的Pod数量
1248
1248
  注意:此字段可能返回 null,表示取不到有效值。
1249
1249
  */
1250
- TKERouteENINonStaticIP: number
1250
+ TKERouteENINonStaticIP?: number
1251
1251
  /**
1252
1252
  * TKE共享网卡固定IP模式可支持的Pod数量
1253
1253
  注意:此字段可能返回 null,表示取不到有效值。
1254
1254
  */
1255
- TKERouteENIStaticIP: number
1255
+ TKERouteENIStaticIP?: number
1256
1256
  /**
1257
1257
  * TKE独立网卡模式可支持的Pod数量
1258
1258
  注意:此字段可能返回 null,表示取不到有效值。
1259
1259
  */
1260
- TKEDirectENI: number
1260
+ TKEDirectENI?: number
1261
+ /**
1262
+ * TKE中继网卡模式可支持的Pod数量
1263
+ 注意:此字段可能返回 null,表示取不到有效值。
1264
+ */
1265
+ TKESubENI?: number
1261
1266
  }
1262
1267
 
1263
1268
  /**
@@ -2124,7 +2124,7 @@ export interface TencentVod {
2124
2124
  */
2125
2125
  MediaType?: number
2126
2126
  /**
2127
- * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserId_u_分开。
2127
+ * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。
2128
2128
  */
2129
2129
  UserDefineRecordId?: string
2130
2130
  }
@@ -3672,7 +3672,7 @@ export interface CreateTrafficPackagesResponse {
3672
3672
  /**
3673
3673
  * 创建的流量包ID列表。
3674
3674
  */
3675
- TrafficPackageSet: Array<string>
3675
+ TrafficPackageSet?: Array<string>
3676
3676
  /**
3677
3677
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3678
3678
  */
@@ -5213,45 +5213,45 @@ export interface TrafficPackage {
5213
5213
  /**
5214
5214
  * 流量包唯一ID
5215
5215
  */
5216
- TrafficPackageId: string
5216
+ TrafficPackageId?: string
5217
5217
  /**
5218
5218
  * 流量包名称
5219
5219
  注意:此字段可能返回 null,表示取不到有效值。
5220
5220
  */
5221
- TrafficPackageName: string
5221
+ TrafficPackageName?: string
5222
5222
  /**
5223
5223
  * 流量包总量,单位GB
5224
5224
  */
5225
- TotalAmount: number
5225
+ TotalAmount?: number
5226
5226
  /**
5227
5227
  * 流量包剩余量,单位GB
5228
5228
  */
5229
- RemainingAmount: number
5229
+ RemainingAmount?: number
5230
5230
  /**
5231
5231
  * 流量包状态,可能的值有: AVAILABLE-可用状态, EXPIRED-已过期, EXHAUSTED-已用完, REFUNDED-已退还, DELETED-已删除
5232
5232
  */
5233
- Status: string
5233
+ Status?: string
5234
5234
  /**
5235
5235
  * 流量包创建时间
5236
5236
  */
5237
- CreatedTime: string
5237
+ CreatedTime?: string
5238
5238
  /**
5239
5239
  * 流量包截止时间
5240
5240
  */
5241
- Deadline: string
5241
+ Deadline?: string
5242
5242
  /**
5243
5243
  * 已使用的流量,单位GB
5244
5244
  */
5245
- UsedAmount: number
5245
+ UsedAmount?: number
5246
5246
  /**
5247
5247
  * 流量包标签
5248
5248
  注意:此字段可能返回 null,表示取不到有效值。
5249
5249
  */
5250
- TagSet: Array<Tag>
5250
+ TagSet?: Array<Tag>
5251
5251
  /**
5252
5252
  * 区分闲时流量包与全时流量包
5253
5253
  */
5254
- DeductType: string
5254
+ DeductType?: string
5255
5255
  }
5256
5256
 
5257
5257
  /**
@@ -721,7 +721,7 @@ export class Client extends AbstractClient {
721
721
  }
722
722
 
723
723
  /**
724
- * Waf 斯巴达版本更新cc自动封堵状态
724
+ * 编辑SAAS型接入的紧急CC防护状态
725
725
  */
726
726
  async UpsertCCAutoStatus(
727
727
  req: UpsertCCAutoStatusRequest,
@@ -1062,7 +1062,7 @@ export class Client extends AbstractClient {
1062
1062
  }
1063
1063
 
1064
1064
  /**
1065
- * waf斯巴达-waf开关
1065
+ * 获取基础安全防护(WAF开关)状态
1066
1066
  */
1067
1067
  async ModifyProtectionStatus(
1068
1068
  req: ModifyProtectionStatusRequest,
@@ -1276,7 +1276,7 @@ export class Client extends AbstractClient {
1276
1276
  }
1277
1277
 
1278
1278
  /**
1279
- * Waf 多域名ip黑白名单查询
1279
+ * Waf 批量防护IP黑白名单查询
1280
1280
  */
1281
1281
  async DescribeBatchIpAccessControl(
1282
1282
  req: DescribeBatchIpAccessControlRequest,
@@ -1656,7 +1656,7 @@ export class Client extends AbstractClient {
1656
1656
  }
1657
1657
 
1658
1658
  /**
1659
- * Waf 斯巴达版本查询cc自动封堵状态
1659
+ * 获取SAAS型接入的紧急CC防护状态
1660
1660
  */
1661
1661
  async DescribeCCAutoStatus(
1662
1662
  req: DescribeCCAutoStatusRequest,
@@ -1955,7 +1955,11 @@ export interface ModifySpartaProtectionRequest {
1955
1955
  /**
1956
1956
  * 必填项。域名唯一ID
1957
1957
  */
1958
- DomainId?: string
1958
+ DomainId: string
1959
+ /**
1960
+ * 必填项。域名所属实例id
1961
+ */
1962
+ InstanceID: string
1959
1963
  /**
1960
1964
  * 必填项。证书类型。
1961
1965
  0:仅配置HTTP监听端口,没有证书
@@ -2050,10 +2054,6 @@ https:使用https协议回源
2050
2054
  1: 长连接
2051
2055
  */
2052
2056
  IsKeepAlive?: string
2053
- /**
2054
- * 必填项。域名所属实例id
2055
- */
2056
- InstanceID?: string
2057
2057
  /**
2058
2058
  * 必填项,待废弃。目前填0即可。anycast IP类型开关: 0 普通IP 1 Anycast IP
2059
2059
  */
@@ -2122,6 +2122,10 @@ https:使用https协议回源
2122
2122
  * 自定义回源Host。默认为空字符串,表示使用防护域名作为回源Host。
2123
2123
  */
2124
2124
  UpstreamHost?: string
2125
+ /**
2126
+ * 是否开启缓存 0-关闭 1-开启
2127
+ */
2128
+ ProxyBuffer?: number
2125
2129
  }
2126
2130
 
2127
2131
  /**
@@ -2641,7 +2645,7 @@ cdc-clb-waf:CDC环境下负载均衡型WAF实例
2641
2645
  "日本": "jp"
2642
2646
  "弗吉尼亚": "use"
2643
2647
  "北京": "bj"
2644
- "香港": "hk"
2648
+ "中国香港": "hk"
2645
2649
  "杭州": "hzec"
2646
2650
  "北京金融": "bjjr"
2647
2651
  "上海金融": "shjr"
@@ -2820,6 +2824,11 @@ public:公有云域名
2820
2824
  注意:此字段可能返回 null,表示取不到有效值。
2821
2825
  */
2822
2826
  SgID?: string
2827
+ /**
2828
+ * clbwaf接入状态
2829
+ 注意:此字段可能返回 null,表示取不到有效值。
2830
+ */
2831
+ AccessStatus?: number
2823
2832
  }
2824
2833
 
2825
2834
  /**
@@ -3792,7 +3801,7 @@ export interface DeleteIpAccessControlResponse {
3792
3801
  }
3793
3802
 
3794
3803
  /**
3795
- * 多域名黑白名单列表Ip
3804
+ * 批量多域名黑白名单列表Ip
3796
3805
  */
3797
3806
  export interface BatchIpAccessControlItem {
3798
3807
  /**
@@ -3828,6 +3837,16 @@ export interface BatchIpAccessControlItem {
3828
3837
  * 域名列表
3829
3838
  */
3830
3839
  Hosts?: Array<string>
3840
+ /**
3841
+ * 55101145
3842
+ 注意:此字段可能返回 null,表示取不到有效值。
3843
+ */
3844
+ RuleId?: number
3845
+ /**
3846
+ * IP列表
3847
+ 注意:此字段可能返回 null,表示取不到有效值。
3848
+ */
3849
+ IpList?: Array<string>
3831
3850
  }
3832
3851
 
3833
3852
  /**
@@ -4099,7 +4118,7 @@ export interface DescribeIpAccessControlRequest {
4099
4118
  */
4100
4119
  Sort?: string
4101
4120
  /**
4102
- * ip
4121
+ * IP
4103
4122
  */
4104
4123
  Ip?: string
4105
4124
  /**
@@ -4114,6 +4133,10 @@ export interface DescribeIpAccessControlRequest {
4114
4133
  * 最大有效时间的时间戳
4115
4134
  */
4116
4135
  ValidTimeStampMax?: string
4136
+ /**
4137
+ * 规则ID
4138
+ */
4139
+ RuleId?: number
4117
4140
  }
4118
4141
 
4119
4142
  /**
@@ -4819,6 +4842,11 @@ export interface DescribeIpAccessControlResponse {
4819
4842
  注意:此字段可能返回 null,表示取不到有效值。
4820
4843
  */
4821
4844
  Data?: IpAccessControlData
4845
+ /**
4846
+ * 已经使用的IP黑白名单的IP总数
4847
+ 注意:此字段可能返回 null,表示取不到有效值。
4848
+ */
4849
+ UsedTotal?: number
4822
4850
  /**
4823
4851
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4824
4852
  */
@@ -4930,6 +4958,16 @@ export interface IpAccessControlItem {
4930
4958
  注意:此字段可能返回 null,表示取不到有效值。
4931
4959
  */
4932
4960
  ValidStatus?: number
4961
+ /**
4962
+ * 55000001
4963
+ 注意:此字段可能返回 null,表示取不到有效值。
4964
+ */
4965
+ RuleId?: number
4966
+ /**
4967
+ * IP列表
4968
+ 注意:此字段可能返回 null,表示取不到有效值。
4969
+ */
4970
+ IpList?: Array<string>
4933
4971
  }
4934
4972
 
4935
4973
  /**
@@ -5555,6 +5593,11 @@ export interface DescribeAttackOverviewResponse {
5555
5593
  注意:此字段可能返回 null,表示取不到有效值。
5556
5594
  */
5557
5595
  LeakCount?: number
5596
+ /**
5597
+ * API风险事件周环比
5598
+ 注意:此字段可能返回 null,表示取不到有效值。
5599
+ */
5600
+ ApiRiskEventCircleCount?: number
5558
5601
  /**
5559
5602
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5560
5603
  */
@@ -6191,7 +6234,7 @@ export interface DescribeBatchIpAccessControlResponse {
6191
6234
  * 输出
6192
6235
  注意:此字段可能返回 null,表示取不到有效值。
6193
6236
  */
6194
- Data: BatchIpAccessControlData
6237
+ Data?: BatchIpAccessControlData
6195
6238
  /**
6196
6239
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6197
6240
  */
@@ -7937,6 +7980,11 @@ https:使用https协议回源
7937
7980
  注意:此字段可能返回 null,表示取不到有效值。
7938
7981
  */
7939
7982
  Level?: string
7983
+ /**
7984
+ * 是否开启缓存 0-关闭 1-开启
7985
+ 注意:此字段可能返回 null,表示取不到有效值。
7986
+ */
7987
+ ProxyBuffer?: number
7940
7988
  }
7941
7989
 
7942
7990
  /**
@@ -8035,6 +8083,25 @@ export interface AddSpartaProtectionRequest {
8035
8083
  2:加权轮询
8036
8084
  */
8037
8085
  LoadBalance: string
8086
+ /**
8087
+ * 服务端口列表配置。
8088
+ NginxServerId:新增域名时填'0'
8089
+ Port:监听端口号
8090
+ Protocol:端口协议
8091
+ UpstreamPort:与Port相同
8092
+ UpstreamProtocol:与Protocol相同
8093
+ */
8094
+ Ports: Array<PortItem>
8095
+ /**
8096
+ * 必填项,是否开启长连接。
8097
+ 0: 短连接
8098
+ 1: 长连接
8099
+ */
8100
+ IsKeepAlive: string
8101
+ /**
8102
+ * 必填项,域名所属实例id
8103
+ */
8104
+ InstanceID: string
8038
8105
  /**
8039
8106
  * CertType为1时,需要填充此参数,表示自有证书的证书链
8040
8107
  */
@@ -8093,15 +8160,6 @@ https:使用https协议回源
8093
8160
  1:开启
8094
8161
  */
8095
8162
  IsHttp2?: number
8096
- /**
8097
- * 服务端口列表配置。
8098
- NginxServerId:新增域名时填'0'
8099
- Port:监听端口号
8100
- Protocol:端口协议
8101
- UpstreamPort:与Port相同
8102
- UpstreamProtocol:与Protocol相同
8103
- */
8104
- Ports?: Array<PortItem>
8105
8163
  /**
8106
8164
  * 待废弃,可不填。WAF实例类型。
8107
8165
  sparta-waf:SAAS型WAF
@@ -8109,16 +8167,6 @@ clb-waf:负载均衡型WAF
8109
8167
  cdn-waf:CDN上的Web防护能力
8110
8168
  */
8111
8169
  Edition?: string
8112
- /**
8113
- * 必填项,是否开启长连接。
8114
- 0: 短连接
8115
- 1: 长连接
8116
- */
8117
- IsKeepAlive?: string
8118
- /**
8119
- * 必填项,域名所属实例id
8120
- */
8121
- InstanceID?: string
8122
8170
  /**
8123
8171
  * 待废弃,目前填0即可。anycast IP类型开关: 0 普通IP 1 Anycast IP
8124
8172
  */
@@ -8183,6 +8231,10 @@ cdn-waf:CDN上的Web防护能力
8183
8231
  * 自定义回源Host。默认为空字符串,表示使用防护域名作为回源Host。
8184
8232
  */
8185
8233
  UpstreamHost?: string
8234
+ /**
8235
+ * 是否开启缓存 0-关闭 1-开启
8236
+ */
8237
+ ProxyBuffer?: number
8186
8238
  }
8187
8239
 
8188
8240
  /**
@@ -8222,7 +8274,7 @@ export interface AttackLogInfo {
8222
8274
  */
8223
8275
  export interface DescribeCCAutoStatusResponse {
8224
8276
  /**
8225
- * 配置状态
8277
+ * 配置状态,0表示关闭,1表示开启
8226
8278
  */
8227
8279
  AutoCCSwitch?: number
8228
8280
  /**
@@ -8443,8 +8495,9 @@ export interface ModifyAccessPeriodRequest {
8443
8495
  Period: number
8444
8496
  /**
8445
8497
  * 日志主题,新版本不需要再传
8498
+ * @deprecated
8446
8499
  */
8447
- TopicId: string
8500
+ TopicId?: string
8448
8501
  }
8449
8502
 
8450
8503
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.814";
1
+ export declare const sdkVersion = "4.0.816";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.814";
4
+ exports.sdkVersion = "4.0.816";
@@ -1395,17 +1395,16 @@ export interface DescribeCfsFileSystemClientsRequest {
1395
1395
  }
1396
1396
  /**
1397
1397
  * 版本控制-协议详情
1398
-
1399
1398
  */
1400
1399
  export interface AvailableProtoStatus {
1401
1400
  /**
1402
1401
  * 售卖状态。可选值有 sale_out 售罄、saling可售、no_saling不可销售
1403
1402
  */
1404
- SaleStatus: string;
1403
+ SaleStatus?: string;
1405
1404
  /**
1406
- * 协议类型。可选值有 NFS、CIFS
1405
+ * 协议类型。可选值有 NFS、CIFS、TURBO
1407
1406
  */
1408
- Protocol: string;
1407
+ Protocol?: string;
1409
1408
  }
1410
1409
  /**
1411
1410
  * DescribeCfsFileSystems请求参数结构体
@@ -427,7 +427,7 @@ export interface SearchCosRechargeInfoRequest {
427
427
  */
428
428
  export interface KafkaRechargeInfo {
429
429
  /**
430
- * 主键ID
430
+ * Kafka数据订阅配置的ID
431
431
  注意:此字段可能返回 null,表示取不到有效值。
432
432
  */
433
433
  Id?: string;
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, ModifyExtendedServiceRequest, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DescribeSignFaceVideoRequest, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ModifyFlowDeadlineResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, RenewAutoSignLicenseRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, ModifyExtendedServiceResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, DescribeSignFaceVideoResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, ModifyIntegrationRoleResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, RenewAutoSignLicenseResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { DescribePersonCertificateResponse, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, ModifyExtendedServiceRequest, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DescribeSignFaceVideoRequest, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ModifyFlowDeadlineResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, RenewAutoSignLicenseRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, CreateEmbedWebUrlResponse, ModifyExtendedServiceResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, DescribeSignFaceVideoResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, ModifyIntegrationRoleResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, RenewAutoSignLicenseResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -39,7 +39,7 @@ export declare class Client extends AbstractClient {
39
39
  ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
40
40
 
41
41
  注:
42
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
42
+ 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
43
43
 
44
44
  2.<font color="red">静默(自动)签署不支持合同签署方存在填写</font>功能
45
45
 
@@ -58,7 +58,7 @@ export declare class Client extends AbstractClient {
58
58
  2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
59
59
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
60
60
 
61
- 3. <font color='red'>撤销合同会返还合同额度</font>
61
+ 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
62
62
 
63
63
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
64
64
  */
@@ -179,13 +179,16 @@ export declare class Client extends AbstractClient {
179
179
  - **可撤回合同状态**:未全部签署完成
180
180
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
181
181
 
182
+ 批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
183
+
184
+
182
185
  注:
183
186
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
184
187
 
185
188
  2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
186
189
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
187
190
 
188
- 3. <font color='red'>撤销合同会返还合同额度</font>
191
+ 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
189
192
  */
190
193
  CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
191
194
  /**
@@ -377,6 +380,10 @@ export declare class Client extends AbstractClient {
377
380
  2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
378
381
  */
379
382
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
383
+ /**
384
+ * 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
385
+ */
386
+ DescribeCancelFlowsTask(req: DescribeCancelFlowsTaskRequest, cb?: (error: string, rep: DescribeCancelFlowsTaskResponse) => void): Promise<DescribeCancelFlowsTaskResponse>;
380
387
  /**
381
388
  * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
382
389
  解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
@@ -529,7 +536,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
529
536
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
530
537
 
531
538
  注:
532
- - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
539
+ - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
533
540
  - **静默(自动)签署不支持合同签署方存在填写**功能
534
541
  */
535
542
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
@@ -65,7 +65,7 @@ class Client extends abstract_client_1.AbstractClient {
65
65
  ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
66
66
 
67
67
  注:
68
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
68
+ 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
69
69
 
70
70
  2.<font color="red">静默(自动)签署不支持合同签署方存在填写</font>功能
71
71
 
@@ -86,7 +86,7 @@ class Client extends abstract_client_1.AbstractClient {
86
86
  2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
87
87
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
88
88
 
89
- 3. <font color='red'>撤销合同会返还合同额度</font>
89
+ 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
90
90
 
91
91
  4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
92
92
  */
@@ -231,13 +231,16 @@ class Client extends abstract_client_1.AbstractClient {
231
231
  - **可撤回合同状态**:未全部签署完成
232
232
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
233
233
 
234
+ 批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
235
+
236
+
234
237
  注:
235
238
  1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
236
239
 
237
240
  2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
238
241
  ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
239
242
 
240
- 3. <font color='red'>撤销合同会返还合同额度</font>
243
+ 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
241
244
  */
242
245
  async CreateBatchCancelFlowUrl(req, cb) {
243
246
  return this.request("CreateBatchCancelFlowUrl", req, cb);
@@ -455,6 +458,12 @@ class Client extends abstract_client_1.AbstractClient {
455
458
  async CreateFlow(req, cb) {
456
459
  return this.request("CreateFlow", req, cb);
457
460
  }
461
+ /**
462
+ * 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
463
+ */
464
+ async DescribeCancelFlowsTask(req, cb) {
465
+ return this.request("DescribeCancelFlowsTask", req, cb);
466
+ }
458
467
  /**
459
468
  * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
460
469
  解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
@@ -623,7 +632,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
623
632
  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
624
633
 
625
634
  注:
626
- - 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
635
+ - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
627
636
  - **静默(自动)签署不支持合同签署方存在填写**功能
628
637
  */
629
638
  async CreateFlowByFiles(req, cb) {