tencentcloud-sdk-nodejs-clb 4.1.31 → 4.1.33

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.
@@ -212,7 +212,7 @@ export interface BatchModifyTargetWeightResponse {
212
212
  */
213
213
  export interface SetSecurityGroupForLoadbalancersRequest {
214
214
  /**
215
- * 安全组ID,如 sg-12345678
215
+ * 安全组ID,如 sg-12345678。可以通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口获取。
216
216
  */
217
217
  SecurityGroup: string;
218
218
  /**
@@ -221,7 +221,8 @@ export interface SetSecurityGroupForLoadbalancersRequest {
221
221
  */
222
222
  OperationType: string;
223
223
  /**
224
- * 负载均衡实例ID数组
224
+ * 负载均衡实例ID数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
225
+ 列表支持的最大长度为20。
225
226
  */
226
227
  LoadBalancerIds: Array<string>;
227
228
  }
@@ -252,7 +253,7 @@ export interface CreateLoadBalancerRequest {
252
253
  */
253
254
  SubnetId?: string;
254
255
  /**
255
- * 负载均衡实例所属的项目 ID,可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
256
+ * 负载均衡实例所属的项目 ID,默认项目 ID 为0。可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
256
257
  */
257
258
  ProjectId?: number;
258
259
  /**
@@ -260,16 +261,16 @@ export interface CreateLoadBalancerRequest {
260
261
  */
261
262
  AddressIPVersion?: string;
262
263
  /**
263
- * 创建负载均衡的个数,默认值 1。
264
+ * 创建负载均衡的个数,默认值 1。创建个数不能超过帐号所能创建的最大值,默认创建最大值为20
264
265
  */
265
266
  Number?: number;
266
267
  /**
267
- * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
268
+ * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID 可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
268
269
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
269
270
  */
270
271
  MasterZoneId?: string;
271
272
  /**
272
- * 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
273
+ * 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。
273
274
  */
274
275
  ZoneId?: string;
275
276
  /**
@@ -290,7 +291,7 @@ export interface CreateLoadBalancerRequest {
290
291
  */
291
292
  Vip?: string;
292
293
  /**
293
- * 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
294
+ * 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
294
295
  */
295
296
  BandwidthPackageId?: string;
296
297
  /**
@@ -323,12 +324,12 @@ export interface CreateLoadBalancerRequest {
323
324
  */
324
325
  ClusterTag?: string;
325
326
  /**
326
- * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
327
+ * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
327
328
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
328
329
  */
329
330
  SlaveZoneId?: string;
330
331
  /**
331
- * EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。
332
+ * EIP 的唯一 ID,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP。
332
333
  */
333
334
  EipAddressId?: string;
334
335
  /**
@@ -386,27 +387,27 @@ export interface DescribeLoadBalancerOverviewResponse {
386
387
  */
387
388
  export interface DeleteRuleRequest {
388
389
  /**
389
- * 负载均衡实例ID
390
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
390
391
  */
391
392
  LoadBalancerId: string;
392
393
  /**
393
- * 负载均衡监听器ID
394
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
394
395
  */
395
396
  ListenerId: string;
396
397
  /**
397
- * 要删除的转发规则的ID组成的数组。
398
+ * 要删除的转发规则的ID组成的数组,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
398
399
  */
399
400
  LocationIds?: Array<string>;
400
401
  /**
401
- * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个。
402
+ * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
402
403
  */
403
404
  Domain?: string;
404
405
  /**
405
- * 要删除的转发规则的转发路径。
406
+ * 要删除的转发规则的转发路径,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
406
407
  */
407
408
  Url?: string;
408
409
  /**
409
- * 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。
410
+ * 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
410
411
  */
411
412
  NewDefaultServerDomain?: string;
412
413
  }
@@ -415,7 +416,7 @@ export interface DeleteRuleRequest {
415
416
  */
416
417
  export interface CloneLoadBalancerRequest {
417
418
  /**
418
- * 负载均衡ID
419
+ * 负载均衡ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
419
420
  */
420
421
  LoadBalancerId: string;
421
422
  /**
@@ -424,21 +425,21 @@ export interface CloneLoadBalancerRequest {
424
425
  */
425
426
  LoadBalancerName?: string;
426
427
  /**
427
- * 负载均衡实例所属的项目 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
428
+ * 负载均衡实例所属的项目 ID,默认项目 ID 为0,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
428
429
  */
429
430
  ProjectId?: number;
430
431
  /**
431
- * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
432
+ * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
432
433
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。
433
434
  */
434
435
  MasterZoneId?: string;
435
436
  /**
436
- * 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
437
+ * 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
437
438
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。
438
439
  */
439
440
  SlaveZoneId?: string;
440
441
  /**
441
- * 仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询。
442
+ * 仅适用于公网负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 接口查询。
442
443
  */
443
444
  ZoneId?: string;
444
445
  /**
@@ -462,7 +463,7 @@ export interface CloneLoadBalancerRequest {
462
463
  */
463
464
  ExclusiveCluster?: ExclusiveCluster;
464
465
  /**
465
- * 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
466
+ * 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
466
467
  */
467
468
  BandwidthPackageId?: string;
468
469
  /**
@@ -474,7 +475,7 @@ export interface CloneLoadBalancerRequest {
474
475
  */
475
476
  SnatIps?: Array<SnatIp>;
476
477
  /**
477
- * 公网独占集群ID或者CDCId
478
+ * 公网独占集群ID或者CDCId,可以通过 [DescribeExclusiveClusters](https://cloud.tencent.com/document/product/214/49278) 接口获取。
478
479
  */
479
480
  ClusterIds?: Array<string>;
480
481
  /**
@@ -490,7 +491,7 @@ export interface CloneLoadBalancerRequest {
490
491
  */
491
492
  Zones?: Array<string>;
492
493
  /**
493
- * EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP
494
+ * EIP 的唯一 ID,形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。
494
495
  */
495
496
  EipAddressId?: string;
496
497
  }
@@ -597,15 +598,15 @@ export interface RsTagRule {
597
598
  */
598
599
  export interface ModifyRuleRequest {
599
600
  /**
600
- * 负载均衡实例 ID
601
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
601
602
  */
602
603
  LoadBalancerId: string;
603
604
  /**
604
- * 负载均衡监听器 ID
605
+ * 负载均衡监听器 ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
605
606
  */
606
607
  ListenerId: string;
607
608
  /**
608
- * 要修改的转发规则的 ID
609
+ * 要修改的转发规则的 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
609
610
  */
610
611
  LocationId: string;
611
612
  /**
@@ -623,6 +624,7 @@ export interface ModifyRuleRequest {
623
624
  Scheduler?: string;
624
625
  /**
625
626
  * 会话保持时间。取值范围0或30-86400(单位:秒)。
627
+ 默认为0。
626
628
  */
627
629
  SessionExpireTime?: number;
628
630
  /**
@@ -716,7 +718,7 @@ export interface ModifyLoadBalancerAttributesResponse {
716
718
  */
717
719
  export interface DescribeTargetGroupInstancesRequest {
718
720
  /**
719
- * 过滤条件,当前仅支持TargetGroupId,BindIP,InstanceId过滤。
721
+ * 过滤条件,当前支持按照 TargetGroupId,BindIP,InstanceId 多个条件组合过滤。
720
722
  */
721
723
  Filters: Array<Filter>;
722
724
  /**
@@ -1068,7 +1070,7 @@ export interface DeregisterTargetsFromClassicalLBRequest {
1068
1070
  */
1069
1071
  export interface InquiryPriceModifyLoadBalancerRequest {
1070
1072
  /**
1071
- * 负载均衡实例ID
1073
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
1072
1074
  */
1073
1075
  LoadBalancerId: string;
1074
1076
  /**
@@ -1106,7 +1108,7 @@ export interface BasicTargetGroupInfo {
1106
1108
  */
1107
1109
  TargetGroupName?: string;
1108
1110
  /**
1109
- * 权重
1111
+ * 目标组权重
1110
1112
  */
1111
1113
  Weight?: number;
1112
1114
  }
@@ -1166,7 +1168,9 @@ export interface ZoneResource {
1166
1168
  */
1167
1169
  export interface AssociateTargetGroupsRequest {
1168
1170
  /**
1169
- * 绑定的关系数组。一次请求最多支持20个。
1171
+ * 绑定的关系数组,目标组类型需要一致。
1172
+ 一次请求最多支持20个。
1173
+
1170
1174
  */
1171
1175
  Associations: Array<TargetGroupAssociation>;
1172
1176
  }
@@ -1198,8 +1202,8 @@ export interface TargetGroupInstance {
1198
1202
  Port?: number;
1199
1203
  /**
1200
1204
  * 目标组实例的权重
1201
-
1202
1205
  v2目标组需要配置权重,调用CreateTargetGroup接口创建目标组时该参数与创建接口中的Weight参数必填其一。
1206
+ 取值范围:0-100
1203
1207
  */
1204
1208
  Weight?: number;
1205
1209
  /**
@@ -1227,7 +1231,7 @@ export interface CreateRuleResponse {
1227
1231
  /**
1228
1232
  * 创建的转发规则的唯一标识数组。
1229
1233
  */
1230
- LocationIds: Array<string>;
1234
+ LocationIds?: Array<string>;
1231
1235
  /**
1232
1236
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1233
1237
  */
@@ -1315,15 +1319,15 @@ export interface DescribeExclusiveClustersResponse {
1315
1319
  */
1316
1320
  export interface ModifyDomainRequest {
1317
1321
  /**
1318
- * 负载均衡实例 ID
1322
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
1319
1323
  */
1320
1324
  LoadBalancerId: string;
1321
1325
  /**
1322
- * 负载均衡监听器 ID
1326
+ * 负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
1323
1327
  */
1324
1328
  ListenerId: string;
1325
1329
  /**
1326
- * 监听器下的某个旧域名。
1330
+ * 监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
1327
1331
  */
1328
1332
  Domain: string;
1329
1333
  /**
@@ -1532,11 +1536,11 @@ export interface ModifyFunctionTargetsResponse {
1532
1536
  */
1533
1537
  export interface DeleteLoadBalancerListenersRequest {
1534
1538
  /**
1535
- * 负载均衡实例ID
1539
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
1536
1540
  */
1537
1541
  LoadBalancerId: string;
1538
1542
  /**
1539
- * 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器。
1543
+ * 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
1540
1544
  */
1541
1545
  ListenerIds?: Array<string>;
1542
1546
  }
@@ -1606,11 +1610,11 @@ export interface DescribeCustomizedConfigListRequest {
1606
1610
  */
1607
1611
  ConfigType: string;
1608
1612
  /**
1609
- * 拉取页偏移,默认值0
1613
+ * 拉取页偏移,默认值0
1610
1614
  */
1611
1615
  Offset?: number;
1612
1616
  /**
1613
- * 拉取数目,默认值20
1617
+ * 拉取数目,默认值20
1614
1618
  */
1615
1619
  Limit?: number;
1616
1620
  /**
@@ -1618,13 +1622,21 @@ export interface DescribeCustomizedConfigListRequest {
1618
1622
  */
1619
1623
  ConfigName?: string;
1620
1624
  /**
1621
- * 配置ID
1625
+ * 配置ID,可以通过 [DescribeCustomizedConfigList](https://cloud.tencent.com/document/api/214/60009) 接口查询。
1622
1626
  */
1623
1627
  UconfigIds?: Array<string>;
1624
1628
  /**
1625
1629
  * 过滤条件如下:
1626
- <li> loadbalancer-id - String - 是否必填:否 - (过滤条件)按照 负载均衡ID 过滤,如:"lb-12345678"。</li>
1627
- <li> vip - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip 过滤,如:"1.1.1.1","2204::22:3"。</li>
1630
+ - loadbalancer-id
1631
+ 按照【负载均衡 ID】进行过滤。实例计费模式例如:lb-9vxezxza。
1632
+ 类型:String
1633
+ 必选:否
1634
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
1635
+ - vip
1636
+ 按照【负载均衡VIP】进行过滤。网络计费模式例如:"1.1.1.1","2204::22:3"。
1637
+ 类型:String
1638
+ 必选:否
1639
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
1628
1640
  */
1629
1641
  Filters?: Array<Filter>;
1630
1642
  }
@@ -1746,7 +1758,7 @@ export interface DescribeLoadBalancerListByCertIdResponse {
1746
1758
  /**
1747
1759
  * 证书ID,以及与该证书ID关联的负载均衡实例列表
1748
1760
  */
1749
- CertSet: Array<CertIdRelatedWithLoadBalancers>;
1761
+ CertSet?: Array<CertIdRelatedWithLoadBalancers>;
1750
1762
  /**
1751
1763
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1752
1764
  */
@@ -1778,7 +1790,7 @@ export interface DescribeTargetGroupsRequest {
1778
1790
  */
1779
1791
  Offset?: number;
1780
1792
  /**
1781
- * 过滤条件数组,与TargetGroupIds互斥,支持TargetGroupVpcIdTargetGroupName
1793
+ * 过滤条件数组,与TargetGroupIds互斥,支持 TargetGroupVpcId(私有网络 ID)和 TargetGroupName(目标组名称)以及 Tag(标签)。
1782
1794
  */
1783
1795
  Filters?: Array<Filter>;
1784
1796
  }
@@ -1827,11 +1839,11 @@ export interface BatchRegisterTargetsResponse {
1827
1839
  */
1828
1840
  export interface ModifyLoadBalancerAttributesRequest {
1829
1841
  /**
1830
- * 负载均衡的唯一ID
1842
+ * 负载均衡的唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
1831
1843
  */
1832
1844
  LoadBalancerId: string;
1833
1845
  /**
1834
- * 负载均衡实例名称
1846
+ * 负载均衡实例名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
1835
1847
  */
1836
1848
  LoadBalancerName?: string;
1837
1849
  /**
@@ -1843,19 +1855,22 @@ export interface ModifyLoadBalancerAttributesRequest {
1843
1855
  */
1844
1856
  InternetChargeInfo?: InternetAccessible;
1845
1857
  /**
1846
- * Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。
1858
+ * Target是否放通来自CLB的流量。
1859
+ 开启放通(true):只验证CLB上的安全组;
1860
+ 不开启放通(false):需同时验证CLB和后端实例上的安全组。
1861
+ 不填则不修改。
1847
1862
  */
1848
1863
  LoadBalancerPassToTarget?: boolean;
1849
1864
  /**
1850
- * 是否开启跨地域绑定2.0功能
1865
+ * 是否开启跨地域绑定2.0功能。不填则不修改。
1851
1866
  */
1852
1867
  SnatPro?: boolean;
1853
1868
  /**
1854
- * 是否开启删除保护
1869
+ * 是否开启删除保护,不填则不修改。
1855
1870
  */
1856
1871
  DeleteProtect?: boolean;
1857
1872
  /**
1858
- * 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换。修改后mycloud.com域名将失效。
1873
+ * 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换,修改后mycloud.com域名将失效。不填则不修改。
1859
1874
  */
1860
1875
  ModifyClassicDomain?: boolean;
1861
1876
  }
@@ -1886,7 +1901,8 @@ export interface DescribeLBListenersRequest {
1886
1901
  */
1887
1902
  export interface SlaUpdateParam {
1888
1903
  /**
1889
- * lb的字符串ID
1904
+ * 负载均衡实例 ID
1905
+ 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
1890
1906
  */
1891
1907
  LoadBalancerId: string;
1892
1908
  /**
@@ -2053,11 +2069,11 @@ export interface Listener {
2053
2069
  */
2054
2070
  ListenerId?: string;
2055
2071
  /**
2056
- * 监听器协议
2072
+ * 监听器协议,可选值:TCP、UDP、HTTP、HTTPS、TCP_SSL、QUIC
2057
2073
  */
2058
2074
  Protocol?: string;
2059
2075
  /**
2060
- * 监听器端口
2076
+ * 监听器端口,端口范围:1-65535
2061
2077
  */
2062
2078
  Port?: number;
2063
2079
  /**
@@ -2076,7 +2092,7 @@ export interface Listener {
2076
2092
  */
2077
2093
  Scheduler?: string;
2078
2094
  /**
2079
- * 会话保持时间
2095
+ * 会话保持时间,单位:秒。可选值:30~3600,默认 0,默认不开启。此参数仅适用于TCP/UDP监听器。
2080
2096
  注意:此字段可能返回 null,表示取不到有效值。
2081
2097
  */
2082
2098
  SessionExpireTime?: number;
@@ -2098,11 +2114,11 @@ export interface Listener {
2098
2114
  */
2099
2115
  CreateTime?: string;
2100
2116
  /**
2101
- * 端口段结束端口
2117
+ * 端口段结束端口,端口范围:2-65535
2102
2118
  */
2103
2119
  EndPort?: number;
2104
2120
  /**
2105
- * 后端服务器类型
2121
+ * 后端服务器类型,可选值:NODE、POLARIS、TARGETGROUP、TARGETGROUP-V2
2106
2122
  注意:此字段可能返回 null,表示取不到有效值。
2107
2123
  */
2108
2124
  TargetType?: string;
@@ -2213,7 +2229,7 @@ export interface ConfigListItem {
2213
2229
  */
2214
2230
  UconfigId?: string;
2215
2231
  /**
2216
- * 配置类型
2232
+ * 配置类型, 可选值:CLB(实例维度配置), SERVER(服务维度配置),LOCATION(规则维度配置)
2217
2233
  */
2218
2234
  ConfigType?: string;
2219
2235
  /**
@@ -2225,11 +2241,13 @@ export interface ConfigListItem {
2225
2241
  */
2226
2242
  ConfigContent?: string;
2227
2243
  /**
2228
- * 增加配置时间
2244
+ * 配置的创建时间。
2245
+ 格式:YYYY-MM-DD HH:mm:ss
2229
2246
  */
2230
2247
  CreateTimestamp?: string;
2231
2248
  /**
2232
- * 修改配置时间
2249
+ * 配置的修改时间。
2250
+ 格式:YYYY-MM-DD HH:mm:ss
2233
2251
  */
2234
2252
  UpdateTimestamp?: string;
2235
2253
  }
@@ -2369,15 +2387,15 @@ export interface DescribeTargetsResponse {
2369
2387
  */
2370
2388
  export interface ModifyListenerRequest {
2371
2389
  /**
2372
- * 负载均衡实例ID
2390
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2373
2391
  */
2374
2392
  LoadBalancerId: string;
2375
2393
  /**
2376
- * 负载均衡监听器ID
2394
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2377
2395
  */
2378
2396
  ListenerId: string;
2379
2397
  /**
2380
- * 新的监听器名称。
2398
+ * 新的监听器名称,最大长度255。
2381
2399
  */
2382
2400
  ListenerName?: string;
2383
2401
  /**
@@ -2393,7 +2411,7 @@ export interface ModifyListenerRequest {
2393
2411
  */
2394
2412
  Certificate?: CertificateInput;
2395
2413
  /**
2396
- * 监听器转发的方式。可选值:WRRLEAST_CONN
2414
+ * 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
2397
2415
  分别表示按权重轮询、最小连接数, 默认为 WRR。
2398
2416
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
2399
2417
  */
@@ -2409,15 +2427,18 @@ export interface ModifyListenerRequest {
2409
2427
  /**
2410
2428
  * 是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。
2411
2429
  默认值0表示不开启,1表示开启。
2430
+ 若后端服务对连接数上限有限制,则建议谨慎开启。此功能目前处于内测中,如需使用,请提交 [内测申请](https://cloud.tencent.com/apply/p/tsodp6qm21)。
2412
2431
  */
2413
2432
  KeepaliveEnable?: number;
2414
2433
  /**
2415
2434
  * 解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
2435
+ True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
2416
2436
  */
2417
2437
  DeregisterTargetRst?: boolean;
2418
2438
  /**
2419
2439
  * 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
2420
2440
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。
2441
+ 默认为 NORMAL。
2421
2442
  */
2422
2443
  SessionType?: string;
2423
2444
  /**
@@ -2426,20 +2447,26 @@ export interface ModifyListenerRequest {
2426
2447
  MultiCertInfo?: MultiCertInfo;
2427
2448
  /**
2428
2449
  * 监听器粒度并发连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格并发连接上限,其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
2450
+ 默认为 -1,表示不限速。
2429
2451
  */
2430
2452
  MaxConn?: number;
2431
2453
  /**
2432
2454
  * 监听器粒度新建连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格新建连接上限,其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
2455
+ 默认为 -1 表示不限速。
2433
2456
  */
2434
2457
  MaxCps?: number;
2435
2458
  /**
2436
- * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
2459
+ * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~1980。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
2437
2460
  */
2438
2461
  IdleConnectTimeout?: number;
2439
2462
  /**
2440
- * 是否开启SNAT。
2463
+ * 是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT
2441
2464
  */
2442
2465
  SnatEnable?: boolean;
2466
+ /**
2467
+ * 数据压缩模式
2468
+ */
2469
+ DataCompressMode?: string;
2443
2470
  }
2444
2471
  /**
2445
2472
  * DeregisterTargetGroupInstances返回参数结构体
@@ -2467,7 +2494,7 @@ export interface RegisterTargetsRequest {
2467
2494
  */
2468
2495
  Targets: Array<Target>;
2469
2496
  /**
2470
- * 转发规则的ID,当绑定后端服务到七层转发规则时,必须提供此参数或Domain+Url两者之一。
2497
+ * 转发规则的ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取,当绑定后端服务到七层转发规则时,必须提供此参数或Domain+Url两者之一。
2471
2498
  */
2472
2499
  LocationId?: string;
2473
2500
  /**
@@ -2518,7 +2545,7 @@ export interface CreateTopicRequest {
2518
2545
  */
2519
2546
  TopicType?: string;
2520
2547
  /**
2521
- * 存储时间,单位天
2548
+ * 存储时间,单位天,默认为 30。
2522
2549
  - 日志接入标准存储时,支持1至3600天,值为3640时代表永久保存。
2523
2550
  - 日志接入低频存储时,支持7至3600天,值为3640时代表永久保存。
2524
2551
  */
@@ -2533,11 +2560,11 @@ export interface CreateTopicRequest {
2533
2560
  */
2534
2561
  export interface DeleteListenerRequest {
2535
2562
  /**
2536
- * 负载均衡实例ID
2563
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2537
2564
  */
2538
2565
  LoadBalancerId: string;
2539
2566
  /**
2540
- * 要删除的监听器ID
2567
+ * 要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2541
2568
  */
2542
2569
  ListenerId: string;
2543
2570
  }
@@ -2631,16 +2658,53 @@ export interface DescribeLoadBalancersDetailRequest {
2631
2658
  TargetType?: string;
2632
2659
  /**
2633
2660
  * 查询负载均衡详细信息列表条件,详细的过滤条件如下:
2634
- <li> loadbalancer-id - String - 是否必填:否 - (过滤条件)按照 负载均衡ID 过滤,如:"lb-12345678"。</li>
2635
- <li> project-id - String - 是否必填:否 - (过滤条件)按照 项目ID 过滤,如:"0","123"。</li>
2636
- <li> network - String - 是否必填:否 - (过滤条件)按照 负载均衡网络类型 过滤,如:"Public","Private"。</li>
2637
- <li> vip - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip 过滤,如:"1.1.1.1","2204::22:3"。</li>
2638
- <li> target-ip - String - 是否必填:否 - (过滤条件)按照 后端目标内网Ip 过滤,如:"1.1.1.1","2203::214:4"。</li>
2639
- <li> vpcid - String - 是否必填:否 - (过滤条件)按照 负载均衡所属vpcId 过滤,如:"vpc-12345678"。</li>
2640
- <li> zone - String - 是否必填:否 - (过滤条件)按照 负载均衡所属的可用区 过滤,如:"ap-guangzhou-1"。</li>
2641
- <li> tag-key - String - 是否必填:否 - (过滤条件)按照 负载均衡标签的标签键 过滤,如:"name"。</li>
2642
- <li> tag:* - String - 是否必填:否 - (过滤条件)按照 负载均衡的标签 过滤,':' 后面跟的是标签键。如:过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。</li>
2643
- <li> fuzzy-search - String - 是否必填:否 - (过滤条件)按照 负载均衡Vip,负载均衡名称 模糊搜索,如:"1.1"。</li>
2661
+ - loadbalancer-id
2662
+ 按照【负载均衡ID】进行过滤。例如:lb-rbw5skde。
2663
+ 类型:String
2664
+ 必选:否
2665
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
2666
+ - project-id
2667
+ 按照【项目ID】进行过滤。例如: "0"、"123"。
2668
+ 类型:String
2669
+ 必选:否
2670
+ 获取方式:[DescribeProject](https://cloud.tencent.com/document/api/651/78725)
2671
+ - network
2672
+ 按照【负载均衡网络类型】进行过滤。例如:Public。
2673
+ 类型:String
2674
+ 必选:否
2675
+ 可选值:Private(内网)、Public(公网)
2676
+ - vip
2677
+ 按照【负载均衡 VIP】进行过滤。例如:"1.1.1.1","2204::22:3"。
2678
+ 类型:String
2679
+ 必选:否
2680
+ - vpcid
2681
+ 按照【负载均衡所属 VPCID】进行过滤。例如:"vpc-12345678"。
2682
+ 类型:String
2683
+ 必选:否
2684
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
2685
+ - target-ip
2686
+ 按照【后端目标内网 IP】进行过滤。例如:"1.1.1.1","2203::214:4"。
2687
+ 类型:String
2688
+ 必选:否
2689
+ - zone
2690
+ 按照【负载均衡所属的可用区】进行过滤。例如:"ap-guangzhou-1"。
2691
+ 类型:String
2692
+ 必选:否
2693
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
2694
+ - tag-key
2695
+ 按照【负载均衡标签的标签键】进行过滤,例如:"name"。
2696
+ 类型:String
2697
+ 必选:否
2698
+ 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
2699
+ - tag:*
2700
+ 按照【负载均衡的标签】进行过滤,':' 后面跟的是标签键。如过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。
2701
+ 类型:String
2702
+ 必选:否
2703
+ 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
2704
+ - fuzzy-search
2705
+ 按照【负载均衡VIP,负载均衡名称】模糊搜索,例如:"1.1"。
2706
+ 类型:String
2707
+ 必选:否
2644
2708
  */
2645
2709
  Filters?: Array<Filter>;
2646
2710
  }
@@ -2784,7 +2848,7 @@ export interface ModifyTargetGroupInstancesWeightRequest {
2784
2848
  */
2785
2849
  TargetGroupId: string;
2786
2850
  /**
2787
- * 待修改权重的服务器数组。
2851
+ * 待修改权重的服务器数组,在这个接口 Port 为必填项。
2788
2852
  */
2789
2853
  TargetGroupInstances: Array<TargetGroupInstance>;
2790
2854
  }
@@ -2888,15 +2952,15 @@ export interface DescribeClusterResourcesRequest {
2888
2952
  */
2889
2953
  export interface ModifyDomainAttributesRequest {
2890
2954
  /**
2891
- * 负载均衡实例ID
2955
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2892
2956
  */
2893
2957
  LoadBalancerId: string;
2894
2958
  /**
2895
- * 负载均衡监听器ID
2959
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2896
2960
  */
2897
2961
  ListenerId: string;
2898
2962
  /**
2899
- * 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个。
2963
+ * 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个,可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2900
2964
  */
2901
2965
  Domain: string;
2902
2966
  /**
@@ -2908,15 +2972,18 @@ export interface ModifyDomainAttributesRequest {
2908
2972
  */
2909
2973
  Certificate?: CertificateInput;
2910
2974
  /**
2911
- * 是否开启Http2,注意,只有HTTPS域名才能开启Http2
2975
+ * 是否开启HTTP2,注意,只有HTTPS域名才能开启HTTP2
2976
+ True: 开启HTTP2,Fasle: 不开启HTTP2。
2912
2977
  */
2913
2978
  Http2?: boolean;
2914
2979
  /**
2915
2980
  * 是否设为默认域名,注意,一个监听器下只能设置一个默认域名。
2981
+ True: 设为默认域名,Fasle: 不设置为默认域名。
2916
2982
  */
2917
2983
  DefaultServer?: boolean;
2918
2984
  /**
2919
- * 是否开启Quic,注意,只有HTTPS域名才能开启Quic
2985
+ * 是否开启 QUIC,注意,只有 HTTPS 域名才能开启 QUIC。
2986
+ True: 开启 QUIC,False: 不开启QUIC。
2920
2987
  */
2921
2988
  Quic?: boolean;
2922
2989
  /**
@@ -2950,11 +3017,11 @@ export interface DescribeClassicalLBHealthStatusRequest {
2950
3017
  */
2951
3018
  export interface DescribeListenersRequest {
2952
3019
  /**
2953
- * 负载均衡实例 ID
3020
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。
2954
3021
  */
2955
3022
  LoadBalancerId: string;
2956
3023
  /**
2957
- * 要查询的负载均衡监听器 ID 数组,最大为100个。
3024
+ * 要查询的负载均衡监听器 ID 数组,最大为100个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。
2958
3025
  */
2959
3026
  ListenerIds?: Array<string>;
2960
3027
  /**
@@ -2962,7 +3029,7 @@ export interface DescribeListenersRequest {
2962
3029
  */
2963
3030
  Protocol?: string;
2964
3031
  /**
2965
- * 要查询的监听器的端口。
3032
+ * 要查询的监听器的端口,端口范围:1-65535
2966
3033
  */
2967
3034
  Port?: number;
2968
3035
  }
@@ -3058,11 +3125,12 @@ export interface AddCustomizedConfigResponse {
3058
3125
  */
3059
3126
  export interface DeleteLoadBalancerRequest {
3060
3127
  /**
3061
- * 要删除的负载均衡实例 ID数组,数组大小最大支持20。
3128
+ * 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
3062
3129
  */
3063
3130
  LoadBalancerIds: Array<string>;
3064
3131
  /**
3065
- * 是否强制删除clb。为true表示强制删除,为false表示不是强制删除,需要做拦截校验。
3132
+ * 是否强制删除clb。True表示强制删除,False表示不是强制删除,需要做拦截校验。
3133
+ 默认为 False
3066
3134
  */
3067
3135
  ForceDelete?: boolean;
3068
3136
  }
@@ -3071,7 +3139,8 @@ export interface DeleteLoadBalancerRequest {
3071
3139
  */
3072
3140
  export interface ModifyLoadBalancersProjectRequest {
3073
3141
  /**
3074
- * 一个或多个待操作的负载均衡实例ID
3142
+ * 一个或多个待操作的负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
3143
+ 列表支持最大长度为20。
3075
3144
  */
3076
3145
  LoadBalancerIds: Array<string>;
3077
3146
  /**
@@ -3097,7 +3166,8 @@ export interface AssociateCustomizedConfigRequest {
3097
3166
  */
3098
3167
  export interface CertificateInput {
3099
3168
  /**
3100
- * 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
3169
+ * 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证。
3170
+ 默认为 UNIDIRECTIONAL。
3101
3171
  */
3102
3172
  SSLMode?: string;
3103
3173
  /**
@@ -3105,7 +3175,7 @@ export interface CertificateInput {
3105
3175
  */
3106
3176
  SSLVerifyClient?: string;
3107
3177
  /**
3108
- * 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContentCertKeyCertName
3178
+ * 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent(服务端证书内容),CertKey(服务端证书密钥),CertName(服务端证书名称)。
3109
3179
  */
3110
3180
  CertId?: string;
3111
3181
  /**
@@ -3125,11 +3195,11 @@ export interface CertificateInput {
3125
3195
  */
3126
3196
  CertContent?: string;
3127
3197
  /**
3128
- * 上传客户端 CA 证书的名称,如果 SSLMode=mutual,如果没有 CertCaId,则此项必传。
3198
+ * 上传客户端 CA 证书的名称,如果 SSLMode=MUTUAL,如果没有 CertCaId,则此项必传。
3129
3199
  */
3130
3200
  CertCaName?: string;
3131
3201
  /**
3132
- * 上传客户端证书的内容,如果 SSLMode=mutual,如果没有 CertCaId,则此项必传。
3202
+ * 上传客户端证书的内容,如果 SSLMode=MUTUAL,如果没有 CertCaId,则此项必传。
3133
3203
  */
3134
3204
  CertCaContent?: string;
3135
3205
  }
@@ -3151,11 +3221,12 @@ export interface ResourceAvailability {
3151
3221
  */
3152
3222
  export interface SetLoadBalancerSecurityGroupsRequest {
3153
3223
  /**
3154
- * 负载均衡实例 ID
3224
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
3155
3225
  */
3156
3226
  LoadBalancerId: string;
3157
3227
  /**
3158
3228
  * 安全组ID构成的数组,一个负载均衡实例最多可绑定50个安全组,如果要解绑所有安全组,可不传此参数。
3229
+ 可以通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口查询。
3159
3230
  */
3160
3231
  SecurityGroups?: Array<string>;
3161
3232
  }
@@ -3182,7 +3253,7 @@ export interface DescribeCustomizedConfigAssociateListResponse {
3182
3253
  export interface SetCustomizedConfigForLoadBalancerRequest {
3183
3254
  /**
3184
3255
  * 操作类型。
3185
- - ADD:添加
3256
+ - ADD:创建
3186
3257
  - DELETE:删除
3187
3258
  - UPDATE:修改
3188
3259
  - BIND:绑定
@@ -3194,15 +3265,17 @@ export interface SetCustomizedConfigForLoadBalancerRequest {
3194
3265
  */
3195
3266
  UconfigId?: string;
3196
3267
  /**
3197
- * 个性化配置内容。创建个性化配置或修改个性化配置的内容时,必传此字段
3268
+ * 个性化配置内容。创建个性化配置或修改个性化配置的内容时,必传此字段。
3269
+ 具体限制查看 [七层个性化配置](https://cloud.tencent.com/document/product/214/15171)
3198
3270
  */
3199
3271
  ConfigContent?: string;
3200
3272
  /**
3201
- * 个性化配置名称。创建个性化配置或修改个性化配置的名字时,必传此字段
3273
+ * 个性化配置名称。创建个性化配置或修改个性化配置的名字时,必传此字段。
3202
3274
  */
3203
3275
  ConfigName?: string;
3204
3276
  /**
3205
- * 负载均衡实例ID。绑定解绑时,必传此字段
3277
+ * 负载均衡实例ID。绑定解绑时,必传此字段。
3278
+ 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
3206
3279
  */
3207
3280
  LoadBalancerIds?: Array<string>;
3208
3281
  }
@@ -3412,11 +3485,11 @@ export interface CreateTopicResponse {
3412
3485
  */
3413
3486
  export interface CreateRuleRequest {
3414
3487
  /**
3415
- * 负载均衡实例 ID
3488
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取
3416
3489
  */
3417
3490
  LoadBalancerId: string;
3418
3491
  /**
3419
- * 监听器 ID
3492
+ * 监听器 ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取
3420
3493
  */
3421
3494
  ListenerId: string;
3422
3495
  /**
@@ -3439,10 +3512,12 @@ export interface ModifyTargetGroupInstancesPortResponse {
3439
3512
  export interface LbRsItem {
3440
3513
  /**
3441
3514
  * vpc的字符串id,只支持字符串id。
3515
+ 可以通过 [DescribeVpcs](https://cloud.tencent.com/document/api/215/15778) 接口查询。
3442
3516
  */
3443
3517
  VpcId: string;
3444
3518
  /**
3445
- * 需要查询后端的内网ip,可以是cvm和弹性网卡。
3519
+ * 需要查询后端的内网 IP,可以是 CVM 和弹性网卡。
3520
+ 可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。
3446
3521
  */
3447
3522
  PrivateIp: string;
3448
3523
  }
@@ -3493,7 +3568,8 @@ export interface DeregisterTargetGroupInstancesRequest {
3493
3568
  */
3494
3569
  TargetGroupId: string;
3495
3570
  /**
3496
- * 待解绑的服务器信息。
3571
+ * 待解绑的服务器信息,支持批量解除绑定,单次批量解除数量最多为20个。
3572
+
3497
3573
  */
3498
3574
  TargetGroupInstances: Array<TargetGroupInstance>;
3499
3575
  }
@@ -3609,13 +3685,21 @@ export interface CreateTargetGroupRequest {
3609
3685
  <li>取值范围[0, 100]</li>
3610
3686
  <li>设置该值后,添加后端服务到目标组时, 若后端服务不单独设置权重, 则使用这里的默认权重。 </li>
3611
3687
  </ul>
3612
-
3688
+ v1 目标组类型不支持设置 Weight 参数。
3613
3689
  */
3614
3690
  Weight?: number;
3615
3691
  /**
3616
3692
  * 全监听目标组标识,为true表示是全监听目标组,false表示不是全监听目标组。
3617
3693
  */
3618
3694
  FullListenSwitch?: boolean;
3695
+ /**
3696
+ * 是否开启长连接,此参数仅适用于HTTP/HTTPS目标组,0:关闭;1:开启, 默认关闭。
3697
+ */
3698
+ KeepaliveEnable?: boolean;
3699
+ /**
3700
+ * 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。TCP/UDP目标组不支持该参数。
3701
+ */
3702
+ SessionExpireTime?: number;
3619
3703
  }
3620
3704
  /**
3621
3705
  * 独占集群信息
@@ -3682,11 +3766,12 @@ export interface BindDetailItem {
3682
3766
  */
3683
3767
  export interface CreateListenerRequest {
3684
3768
  /**
3685
- * 负载均衡实例 ID
3769
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
3686
3770
  */
3687
3771
  LoadBalancerId: string;
3688
3772
  /**
3689
3773
  * 要将监听器创建到哪些端口,每个端口对应一个新的监听器。
3774
+ 端口范围:1~65535
3690
3775
  */
3691
3776
  Ports: Array<number | bigint>;
3692
3777
  /**
@@ -3708,12 +3793,12 @@ export interface CreateListenerRequest {
3708
3793
  */
3709
3794
  Certificate?: CertificateInput;
3710
3795
  /**
3711
- * 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
3796
+ * 会话保持时间,单位:秒。可选值:30~3600,默认为0,默认不开启。此参数仅适用于TCP/UDP监听器。
3712
3797
  */
3713
3798
  SessionExpireTime?: number;
3714
3799
  /**
3715
- * 监听器转发的方式。可选值:WRRLEAST_CONN
3716
- 分别表示按权重轮询、最小连接数, 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3800
+ * 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
3801
+ 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3717
3802
  */
3718
3803
  Scheduler?: string;
3719
3804
  /**
@@ -3756,27 +3841,27 @@ export interface CreateListenerRequest {
3756
3841
  */
3757
3842
  MaxCps?: number;
3758
3843
  /**
3759
- * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-2000。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3844
+ * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-1980。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3760
3845
  */
3761
3846
  IdleConnectTimeout?: number;
3762
3847
  /**
3763
- * 是否开启SNAT
3848
+ * 是否开启SNAT,True(开启)、False(关闭)
3764
3849
  */
3765
3850
  SnatEnable?: boolean;
3766
3851
  /**
3767
- * 全端口段监听器的结束端口
3852
+ * 全端口段监听器的结束端口,端口范围:2 - 65535
3768
3853
  */
3769
3854
  FullEndPorts?: Array<number | bigint>;
3770
3855
  /**
3771
- * 内网http监听器开启h2c开关
3856
+ * 内网http监听器开启h2c开关,True(开启)、False(关闭)
3772
3857
  */
3773
3858
  H2cSwitch?: boolean;
3774
3859
  /**
3775
- * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关
3860
+ * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
3776
3861
  */
3777
3862
  SslCloseSwitch?: boolean;
3778
3863
  /**
3779
- * 数据压缩模式
3864
+ * 数据压缩模式。可选值:transparent(透传模式)、compatibility(兼容模式)
3780
3865
  */
3781
3866
  DataCompressMode?: string;
3782
3867
  }
@@ -3816,7 +3901,7 @@ export interface TypeInfo {
3816
3901
  */
3817
3902
  export interface DisassociateTargetGroupsRequest {
3818
3903
  /**
3819
- * 待解绑的规则关系数组。
3904
+ * 待解绑的规则关系数组,支持批量解绑多个监听器,单次批量解除最多20个。
3820
3905
  */
3821
3906
  Associations: Array<TargetGroupAssociation>;
3822
3907
  }
@@ -4501,7 +4586,8 @@ export interface BatchTarget {
4501
4586
  */
4502
4587
  export interface DescribeLoadBalancerListByCertIdRequest {
4503
4588
  /**
4504
- * 服务端证书的ID,或客户端证书的ID
4589
+ * 服务端证书的ID,或客户端证书的ID。可以通过 [DescribeCertificate](https://cloud.tencent.com/document/api/400/41674) 接口查询。
4590
+ 数组最大长度为20。
4505
4591
  */
4506
4592
  CertIds: Array<string>;
4507
4593
  }
@@ -4609,8 +4695,17 @@ export interface ModifyTargetGroupAttributeRequest {
4609
4695
  <li>取值范围[0, 100]</li>
4610
4696
  <li>设置该值后,添加后端服务到目标组时, 若后端服务不单独设置权重, 则使用这里的默认权重。 </li>
4611
4697
  </ul>
4698
+ v1目标组类型不支持设置Weight参数。
4612
4699
  */
4613
4700
  Weight?: number;
4701
+ /**
4702
+ * 是否开启长连接,此参数仅适用于HTTP/HTTPS目标组,true:关闭;false:开启, 默认关闭。
4703
+ */
4704
+ KeepaliveEnable?: boolean;
4705
+ /**
4706
+ * 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。TCP/UDP目标组不支持该参数。
4707
+ */
4708
+ SessionExpireTime?: number;
4614
4709
  }
4615
4710
  /**
4616
4711
  * 独占集群
@@ -4688,11 +4783,11 @@ export interface InquiryPriceCreateLoadBalancerResponse {
4688
4783
  */
4689
4784
  export interface CreateLoadBalancerSnatIpsRequest {
4690
4785
  /**
4691
- * 负载均衡唯一性ID,例如:lb-12345678。
4786
+ * 负载均衡唯一性ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。例如:lb-12345678。
4692
4787
  */
4693
4788
  LoadBalancerId: string;
4694
4789
  /**
4695
- * 添加的SnatIp信息,可指定IP申请,或者指定子网自动申请。单个CLB实例可申请的默认上限为10个。
4790
+ * 添加的SnatIp信息,可指定IP申请,或者指定子网自动申请。可以通过 [DescribeSubnets](https://cloud.tencent.com/document/api/215/15784) 查询获取,单个CLB实例可申请的默认上限为10个。
4696
4791
  */
4697
4792
  SnatIps: Array<SnatIp>;
4698
4793
  /**
@@ -4771,7 +4866,7 @@ export interface ModifyTargetGroupInstancesPortRequest {
4771
4866
  */
4772
4867
  TargetGroupId: string;
4773
4868
  /**
4774
- * 待修改端口的服务器数组。
4869
+ * 待修改端口的服务器数组,在这个接口 NewPort 和 Port 为必填项。
4775
4870
  */
4776
4871
  TargetGroupInstances: Array<TargetGroupInstance>;
4777
4872
  }
@@ -4836,7 +4931,7 @@ export interface RuleInput {
4836
4931
  */
4837
4932
  Scheduler?: string;
4838
4933
  /**
4839
- * 负载均衡与后端服务之间的转发协议,目前支持 HTTP/HTTPS/GRPC/TRPC,TRPC暂未对外开放,默认HTTP。
4934
+ * 负载均衡与后端服务之间的转发协议,目前支持 HTTP/HTTPS/GRPC/GRPCS/TRPC,TRPC暂未对外开放,默认HTTP。
4840
4935
  */
4841
4936
  ForwardType?: string;
4842
4937
  /**
@@ -4904,6 +4999,7 @@ export interface SnatIp {
4904
4999
  export interface ModifyLoadBalancerMixIpTargetRequest {
4905
5000
  /**
4906
5001
  * 负载均衡实例ID数组,默认支持20个负载均衡实例ID。
5002
+ 可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
4907
5003
  */
4908
5004
  LoadBalancerIds: Array<string>;
4909
5005
  /**
@@ -4938,8 +5034,20 @@ export interface DescribeResourcesRequest {
4938
5034
  Offset?: number;
4939
5035
  /**
4940
5036
  * 查询可用区资源列表条件,详细的过滤条件如下:
4941
- <li>master-zone -- String - 是否必填:否 - (过滤条件)按照 地区 类型过滤,如:"ap-guangzhou-2"。</li><li>ip-version -- String - 是否必填:否 - (过滤条件)按照 IP 类型过滤,可选值:"IPv4"、"IPv6"、"IPv6_Nat"。</li>
4942
- <li> isp -- String - 是否必填:否 - (过滤条件)按照 Isp 类型过滤,如:"BGP","CMCC","CUCC","CTCC"。</li>
5037
+ - master-zone
5038
+ 按照【地域可用区】进行过滤,例如:ap-guangzhou-2。
5039
+ 类型:String
5040
+ 必选:否
5041
+ - ip-version
5042
+ 按照【IP 类型】进行过滤,例如:IPv4。
5043
+ 类型:String
5044
+ 必选:否
5045
+ 可选项:IPv4、IPv6、IPv6_Nat
5046
+ - isp
5047
+ 按照【ISP 类型】进行过滤,例如:BGP。
5048
+ 类型:String
5049
+ 必选:否
5050
+ 可选项:BGP、CMCC(中国移动)、CUCC(中国联通)、CTCC(中国电信)、BGP_PRO、INTERNAL(内网)
4943
5051
  */
4944
5052
  Filters?: Array<Filter>;
4945
5053
  }
@@ -5067,7 +5175,7 @@ export interface ModifyFunctionTargetsRequest {
5067
5175
  */
5068
5176
  ListenerId: string;
5069
5177
  /**
5070
- * 要修改的后端云函数服务列表。
5178
+ * 要修改的后端云函数服务列表,仅支持 Event 函数类型。
5071
5179
  */
5072
5180
  FunctionTargets: Array<FunctionTarget>;
5073
5181
  /**
@@ -5107,8 +5215,9 @@ export interface Quota {
5107
5215
  <li> TOTAL_LISTENER_QUOTA:一个CLB下的监听器配额 </li>
5108
5216
  <li> TOTAL_LISTENER_RULE_QUOTA:一个监听器下的转发规则配额 </li>
5109
5217
  <li> TOTAL_TARGET_BIND_QUOTA:一条转发规则下可绑定设备的配额 </li>
5110
- <li> TOTAL_SNAP_IP_QUOTA: 一个CLB实例下跨地域2.0的SNAT IP配额 </li>
5218
+ <li> TOTAL_SNAT_IP_QUOTA: 一个CLB实例下跨地域2.0的SNAT IP配额 </li>
5111
5219
  <li>TOTAL_ISP_CLB_QUOTA:用户当前地域下的三网CLB配额 </li>
5220
+ <li>TOTAL_FULL_PORT_RANGE_LISTENER_QUOTA:一个CLB实例下的单个协议全端口段监听器配额</li>
5112
5221
  */
5113
5222
  QuotaId?: string;
5114
5223
  /**
@@ -5126,7 +5235,7 @@ export interface Quota {
5126
5235
  */
5127
5236
  export interface SetLoadBalancerClsLogRequest {
5128
5237
  /**
5129
- * 负载均衡实例 ID
5238
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
5130
5239
  */
5131
5240
  LoadBalancerId: string;
5132
5241
  /**
@@ -5219,11 +5328,11 @@ export interface DescribeIdleLoadBalancersRequest {
5219
5328
  */
5220
5329
  export interface DeleteLoadBalancerSnatIpsRequest {
5221
5330
  /**
5222
- * 负载均衡唯一ID,例如:lb-12345678。
5331
+ * 负载均衡唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。例如:lb-12345678。
5223
5332
  */
5224
5333
  LoadBalancerId: string;
5225
5334
  /**
5226
- * 删除SnatIp地址数组。
5335
+ * 删除SnatIp地址数组,最大支持删除数量为20个。
5227
5336
  */
5228
5337
  Ips: Array<string>;
5229
5338
  }
@@ -5263,11 +5372,14 @@ export interface OAuth {
5263
5372
  * 开启或关闭鉴权。
5264
5373
  True: 开启;
5265
5374
  False: 关闭
5375
+ 默认为关闭。
5266
5376
  */
5267
5377
  OAuthEnable?: boolean;
5268
5378
  /**
5269
- * IAP全部故障后,拒绝请求还是放行。BYPASS:通过,
5379
+ * IAP全部故障后,拒绝请求还是放行。
5380
+ BYPASS: 通过
5270
5381
  REJECT: 拒绝
5382
+ 默认为 BYPASS
5271
5383
  */
5272
5384
  OAuthFailureStatus?: string;
5273
5385
  }
@@ -5469,7 +5581,7 @@ export interface DeleteLoadBalancerSnatIpsResponse {
5469
5581
  */
5470
5582
  export interface InquiryPriceRenewLoadBalancerRequest {
5471
5583
  /**
5472
- * 负载均衡实例ID
5584
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
5473
5585
  */
5474
5586
  LoadBalancerId: string;
5475
5587
  /**
@@ -5681,7 +5793,7 @@ export interface RegisterTargetGroupInstancesRequest {
5681
5793
  */
5682
5794
  TargetGroupId: string;
5683
5795
  /**
5684
- * 服务器实例数组
5796
+ * 服务器实例数组,服务器和目标组的 VPC 需相同。
5685
5797
  */
5686
5798
  TargetGroupInstances: Array<TargetGroupInstance>;
5687
5799
  }
@@ -5742,11 +5854,11 @@ export interface LoadBalancer {
5742
5854
  */
5743
5855
  OpenBgp?: number;
5744
5856
  /**
5745
- * 2016 年 12 月份之前的传统型内网负载均衡都是开启了 snat 的。
5857
+ * 是否开启 SNAT,在 2016 年 12 月份之前的传统型内网负载均衡都是开启了 SNAT 的。
5746
5858
  */
5747
5859
  Snat?: boolean;
5748
5860
  /**
5749
- * 0:表示未被隔离,1:表示被隔离。
5861
+ * 是否被隔离,0:表示未被隔离,1:表示被隔离。
5750
5862
  */
5751
5863
  Isolation?: number;
5752
5864
  /**