tencentcloud-sdk-nodejs-clb 4.1.31 → 4.1.32

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-clb",
3
- "version": "4.1.31",
3
+ "version": "4.1.32",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -82,7 +82,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
82
82
  /**
83
83
  * 修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
84
84
  注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。
85
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
85
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
86
86
  */
87
87
  ModifyLoadBalancerAttributes(req: ModifyLoadBalancerAttributesRequest, cb?: (error: string, rep: ModifyLoadBalancerAttributesResponse) => void): Promise<ModifyLoadBalancerAttributesResponse>;
88
88
  /**
@@ -115,7 +115,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
115
115
  InquiryPriceRefundLoadBalancer(req: InquiryPriceRefundLoadBalancerRequest, cb?: (error: string, rep: InquiryPriceRefundLoadBalancerResponse) => void): Promise<InquiryPriceRefundLoadBalancerResponse>;
116
116
  /**
117
117
  * 本接口用来删除负载均衡实例下的监听器(四层和七层)。
118
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
118
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
119
119
  */
120
120
  DeleteListener(req: DeleteListenerRequest, cb?: (error: string, rep: DeleteListenerResponse) => void): Promise<DeleteListenerResponse>;
121
121
  /**
@@ -135,7 +135,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
135
135
  SetLoadBalancerStartStatus(req: SetLoadBalancerStartStatusRequest, cb?: (error: string, rep: SetLoadBalancerStartStatusResponse) => void): Promise<SetLoadBalancerStartStatusResponse>;
136
136
  /**
137
137
  * ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
138
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
138
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
139
139
  */
140
140
  ModifyListener(req: ModifyListenerRequest, cb?: (error: string, rep: ModifyListenerResponse) => void): Promise<ModifyListenerResponse>;
141
141
  /**
@@ -174,7 +174,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
174
174
  DescribeCustomizedConfigList(req: DescribeCustomizedConfigListRequest, cb?: (error: string, rep: DescribeCustomizedConfigListResponse) => void): Promise<DescribeCustomizedConfigListResponse>;
175
175
  /**
176
176
  * ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。
177
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
177
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
178
178
  */
179
179
  ModifyRule(req: ModifyRuleRequest, cb?: (error: string, rep: ModifyRuleResponse) => void): Promise<ModifyRuleResponse>;
180
180
  /**
@@ -271,7 +271,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
271
271
  AddCustomizedConfig(req: AddCustomizedConfigRequest, cb?: (error: string, rep: AddCustomizedConfigResponse) => void): Promise<AddCustomizedConfigResponse>;
272
272
  /**
273
273
  * ModifyDomain接口用来修改负载均衡七层监听器下的域名。
274
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
274
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
275
275
  */
276
276
  ModifyDomain(req: ModifyDomainRequest, cb?: (error: string, rep: ModifyDomainResponse) => void): Promise<ModifyDomainResponse>;
277
277
  /**
@@ -284,7 +284,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
284
284
  DescribeLoadBalancerOverview(req?: DescribeLoadBalancerOverviewRequest, cb?: (error: string, rep: DescribeLoadBalancerOverviewResponse) => void): Promise<DescribeLoadBalancerOverviewResponse>;
285
285
  /**
286
286
  * DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后,会把负载均衡实例下的监听器、转发规则一起删除,并把后端服务解绑。
287
- 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
287
+ 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
288
288
  */
289
289
  DeleteLoadBalancer(req: DeleteLoadBalancerRequest, cb?: (error: string, rep: DeleteLoadBalancerResponse) => void): Promise<DeleteLoadBalancerResponse>;
290
290
  /**
@@ -293,7 +293,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
293
293
  InquiryPriceCreateLoadBalancer(req: InquiryPriceCreateLoadBalancerRequest, cb?: (error: string, rep: InquiryPriceCreateLoadBalancerResponse) => void): Promise<InquiryPriceCreateLoadBalancerResponse>;
294
294
  /**
295
295
  * DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
296
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
296
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
297
297
  */
298
298
  DeleteRule(req: DeleteRuleRequest, cb?: (error: string, rep: DeleteRuleResponse) => void): Promise<DeleteRuleResponse>;
299
299
  /**
@@ -327,7 +327,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
327
327
  /**
328
328
  * 本接口(CreateLoadBalancer)用来创建负载均衡实例。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
329
329
  注意:(1)可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域是否支持创建IPv6实例;(2)一个账号在每个地域的默认购买配额为:公网100个,内网100个。
330
- 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
330
+ 本接口为异步接口,接口成功返回后,可使用 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
331
331
  */
332
332
  CreateLoadBalancer(req: CreateLoadBalancerRequest, cb?: (error: string, rep: CreateLoadBalancerResponse) => void): Promise<CreateLoadBalancerResponse>;
333
333
  /**
@@ -352,7 +352,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
352
352
  ReplaceCertForLoadBalancers(req: ReplaceCertForLoadBalancersRequest, cb?: (error: string, rep: ReplaceCertForLoadBalancersResponse) => void): Promise<ReplaceCertForLoadBalancersResponse>;
353
353
  /**
354
354
  * 该接口支持删除负载均衡的多个监听器。
355
- 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
355
+ 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
356
356
  */
357
357
  DeleteLoadBalancerListeners(req: DeleteLoadBalancerListenersRequest, cb?: (error: string, rep: DeleteLoadBalancerListenersResponse) => void): Promise<DeleteLoadBalancerListenersResponse>;
358
358
  /**
@@ -364,8 +364,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
364
364
  */
365
365
  DescribeLoadBalancerListByCertId(req: DescribeLoadBalancerListByCertIdRequest, cb?: (error: string, rep: DescribeLoadBalancerListByCertIdResponse) => void): Promise<DescribeLoadBalancerListByCertIdResponse>;
366
366
  /**
367
- * ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。
368
- 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
367
+ * ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书
368
+ 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
369
369
  */
370
370
  ModifyDomainAttributes(req: ModifyDomainAttributesRequest, cb?: (error: string, rep: ModifyDomainAttributesResponse) => void): Promise<ModifyDomainAttributesResponse>;
371
371
  /**
@@ -387,7 +387,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
387
387
  DescribeClassicalLBTargets(req: DescribeClassicalLBTargetsRequest, cb?: (error: string, rep: DescribeClassicalLBTargetsResponse) => void): Promise<DescribeClassicalLBTargetsResponse>;
388
388
  /**
389
389
  * 在一个负载均衡实例下创建监听器。
390
- 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
390
+ 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
391
391
  */
392
392
  CreateListener(req: CreateListenerRequest, cb?: (error: string, rep: CreateListenerResponse) => void): Promise<CreateListenerResponse>;
393
393
  /**
@@ -432,8 +432,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
432
432
 
433
433
  限制说明
434
434
  实例属性维度限制:
435
- - 支持克隆网络计费模式为按量计费与包年包月的实例,包年包月实例克隆后的新实例网络计费模式会转换为按小时带宽计费,其带宽、规格与原实例设置保持一致。
436
- - 不支持克隆未关联实例计费项的 CLB
435
+ - 支持克隆实例计费模式为按量计费与包年包月的实例,包年包月实例克隆后的新实例网络计费模式会转换为按小时带宽计费,其带宽、规格与原实例设置保持一致。
436
+ - 不支持克隆未关联实例计费项的 CLB(历史免费活动创建)。
437
437
  - 不支持克隆传统型负载均衡实例和高防 CLB。
438
438
  - 不支持克隆基础网络类型的实例。
439
439
  - 不支持克隆 Anycast 类型的实例。
@@ -138,7 +138,7 @@ class Client extends TencentCloudCommon.AbstractClient {
138
138
  /**
139
139
  * 修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
140
140
  注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。
141
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
141
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
142
142
  */
143
143
  async ModifyLoadBalancerAttributes(req, cb) {
144
144
  return this.request("ModifyLoadBalancerAttributes", req, cb);
@@ -185,7 +185,7 @@ class Client extends TencentCloudCommon.AbstractClient {
185
185
  }
186
186
  /**
187
187
  * 本接口用来删除负载均衡实例下的监听器(四层和七层)。
188
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
188
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
189
189
  */
190
190
  async DeleteListener(req, cb) {
191
191
  return this.request("DeleteListener", req, cb);
@@ -213,7 +213,7 @@ class Client extends TencentCloudCommon.AbstractClient {
213
213
  }
214
214
  /**
215
215
  * ModifyListener接口用来修改负载均衡监听器的属性,包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
216
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
216
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
217
217
  */
218
218
  async ModifyListener(req, cb) {
219
219
  return this.request("ModifyListener", req, cb);
@@ -266,7 +266,7 @@ class Client extends TencentCloudCommon.AbstractClient {
266
266
  }
267
267
  /**
268
268
  * ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性,包括转发路径、健康检查属性、转发策略等。
269
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
269
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
270
270
  */
271
271
  async ModifyRule(req, cb) {
272
272
  return this.request("ModifyRule", req, cb);
@@ -401,7 +401,7 @@ class Client extends TencentCloudCommon.AbstractClient {
401
401
  }
402
402
  /**
403
403
  * ModifyDomain接口用来修改负载均衡七层监听器下的域名。
404
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
404
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
405
405
  */
406
406
  async ModifyDomain(req, cb) {
407
407
  return this.request("ModifyDomain", req, cb);
@@ -420,7 +420,7 @@ class Client extends TencentCloudCommon.AbstractClient {
420
420
  }
421
421
  /**
422
422
  * DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后,会把负载均衡实例下的监听器、转发规则一起删除,并把后端服务解绑。
423
- 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
423
+ 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
424
424
  */
425
425
  async DeleteLoadBalancer(req, cb) {
426
426
  return this.request("DeleteLoadBalancer", req, cb);
@@ -433,7 +433,7 @@ class Client extends TencentCloudCommon.AbstractClient {
433
433
  }
434
434
  /**
435
435
  * DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
436
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
436
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
437
437
  */
438
438
  async DeleteRule(req, cb) {
439
439
  return this.request("DeleteRule", req, cb);
@@ -483,7 +483,7 @@ class Client extends TencentCloudCommon.AbstractClient {
483
483
  /**
484
484
  * 本接口(CreateLoadBalancer)用来创建负载均衡实例。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
485
485
  注意:(1)可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域是否支持创建IPv6实例;(2)一个账号在每个地域的默认购买配额为:公网100个,内网100个。
486
- 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
486
+ 本接口为异步接口,接口成功返回后,可使用 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
487
487
  */
488
488
  async CreateLoadBalancer(req, cb) {
489
489
  return this.request("CreateLoadBalancer", req, cb);
@@ -518,7 +518,7 @@ class Client extends TencentCloudCommon.AbstractClient {
518
518
  }
519
519
  /**
520
520
  * 该接口支持删除负载均衡的多个监听器。
521
- 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
521
+ 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
522
522
  */
523
523
  async DeleteLoadBalancerListeners(req, cb) {
524
524
  return this.request("DeleteLoadBalancerListeners", req, cb);
@@ -536,8 +536,8 @@ class Client extends TencentCloudCommon.AbstractClient {
536
536
  return this.request("DescribeLoadBalancerListByCertId", req, cb);
537
537
  }
538
538
  /**
539
- * ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。
540
- 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
539
+ * ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性,如修改域名、修改DefaultServer、开启/关闭Http2、修改证书
540
+ 本接口为异步接口,本接口返回成功后,需以返回的RequestId为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
541
541
  */
542
542
  async ModifyDomainAttributes(req, cb) {
543
543
  return this.request("ModifyDomainAttributes", req, cb);
@@ -569,7 +569,7 @@ class Client extends TencentCloudCommon.AbstractClient {
569
569
  }
570
570
  /**
571
571
  * 在一个负载均衡实例下创建监听器。
572
- 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
572
+ 本接口为异步接口,接口返回成功后,需以返回的 RequestId 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
573
573
  */
574
574
  async CreateListener(req, cb) {
575
575
  return this.request("CreateListener", req, cb);
@@ -632,8 +632,8 @@ class Client extends TencentCloudCommon.AbstractClient {
632
632
 
633
633
  限制说明
634
634
  实例属性维度限制:
635
- - 支持克隆网络计费模式为按量计费与包年包月的实例,包年包月实例克隆后的新实例网络计费模式会转换为按小时带宽计费,其带宽、规格与原实例设置保持一致。
636
- - 不支持克隆未关联实例计费项的 CLB
635
+ - 支持克隆实例计费模式为按量计费与包年包月的实例,包年包月实例克隆后的新实例网络计费模式会转换为按小时带宽计费,其带宽、规格与原实例设置保持一致。
636
+ - 不支持克隆未关联实例计费项的 CLB(历史免费活动创建)。
637
637
  - 不支持克隆传统型负载均衡实例和高防 CLB。
638
638
  - 不支持克隆基础网络类型的实例。
639
639
  - 不支持克隆 Anycast 类型的实例。
@@ -252,7 +252,7 @@ export interface CreateLoadBalancerRequest {
252
252
  */
253
253
  SubnetId?: string;
254
254
  /**
255
- * 负载均衡实例所属的项目 ID,可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
255
+ * 负载均衡实例所属的项目 ID,默认项目 ID 为0。可以通过 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 接口获取。不填此参数则视为默认项目。
256
256
  */
257
257
  ProjectId?: number;
258
258
  /**
@@ -260,16 +260,16 @@ export interface CreateLoadBalancerRequest {
260
260
  */
261
261
  AddressIPVersion?: string;
262
262
  /**
263
- * 创建负载均衡的个数,默认值 1。
263
+ * 创建负载均衡的个数,默认值 1。创建个数不能超过帐号所能创建的最大值,默认创建最大值为20
264
264
  */
265
265
  Number?: number;
266
266
  /**
267
- * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
267
+ * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID 可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
268
268
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
269
269
  */
270
270
  MasterZoneId?: string;
271
271
  /**
272
- * 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
272
+ * 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。
273
273
  */
274
274
  ZoneId?: string;
275
275
  /**
@@ -290,7 +290,7 @@ export interface CreateLoadBalancerRequest {
290
290
  */
291
291
  Vip?: string;
292
292
  /**
293
- * 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
293
+ * 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
294
294
  */
295
295
  BandwidthPackageId?: string;
296
296
  /**
@@ -323,12 +323,12 @@ export interface CreateLoadBalancerRequest {
323
323
  */
324
324
  ClusterTag?: string;
325
325
  /**
326
- * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
326
+ * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
327
327
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
328
328
  */
329
329
  SlaveZoneId?: string;
330
330
  /**
331
- * EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。
331
+ * EIP 的唯一 ID,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP。
332
332
  */
333
333
  EipAddressId?: string;
334
334
  /**
@@ -386,27 +386,27 @@ export interface DescribeLoadBalancerOverviewResponse {
386
386
  */
387
387
  export interface DeleteRuleRequest {
388
388
  /**
389
- * 负载均衡实例ID
389
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
390
390
  */
391
391
  LoadBalancerId: string;
392
392
  /**
393
- * 负载均衡监听器ID
393
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
394
394
  */
395
395
  ListenerId: string;
396
396
  /**
397
- * 要删除的转发规则的ID组成的数组。
397
+ * 要删除的转发规则的ID组成的数组,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
398
398
  */
399
399
  LocationIds?: Array<string>;
400
400
  /**
401
- * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个。
401
+ * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
402
402
  */
403
403
  Domain?: string;
404
404
  /**
405
- * 要删除的转发规则的转发路径。
405
+ * 要删除的转发规则的转发路径,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
406
406
  */
407
407
  Url?: string;
408
408
  /**
409
- * 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。
409
+ * 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
410
410
  */
411
411
  NewDefaultServerDomain?: string;
412
412
  }
@@ -415,7 +415,7 @@ export interface DeleteRuleRequest {
415
415
  */
416
416
  export interface CloneLoadBalancerRequest {
417
417
  /**
418
- * 负载均衡ID
418
+ * 负载均衡ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
419
419
  */
420
420
  LoadBalancerId: string;
421
421
  /**
@@ -424,21 +424,21 @@ export interface CloneLoadBalancerRequest {
424
424
  */
425
425
  LoadBalancerName?: string;
426
426
  /**
427
- * 负载均衡实例所属的项目 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
427
+ * 负载均衡实例所属的项目 ID,默认项目 ID 为0,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。不传此参数则视为默认项目。
428
428
  */
429
429
  ProjectId?: number;
430
430
  /**
431
- * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
431
+ * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
432
432
  注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。
433
433
  */
434
434
  MasterZoneId?: string;
435
435
  /**
436
- * 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
436
+ * 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
437
437
  注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主/备可用区的列表。
438
438
  */
439
439
  SlaveZoneId?: string;
440
440
  /**
441
- * 仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口查询。
441
+ * 仅适用于公网负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区,可调用查询可用区列表 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 接口查询。
442
442
  */
443
443
  ZoneId?: string;
444
444
  /**
@@ -462,7 +462,7 @@ export interface CloneLoadBalancerRequest {
462
462
  */
463
463
  ExclusiveCluster?: ExclusiveCluster;
464
464
  /**
465
- * 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
465
+ * 带宽包ID,可以通过 [DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209) 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
466
466
  */
467
467
  BandwidthPackageId?: string;
468
468
  /**
@@ -474,7 +474,7 @@ export interface CloneLoadBalancerRequest {
474
474
  */
475
475
  SnatIps?: Array<SnatIp>;
476
476
  /**
477
- * 公网独占集群ID或者CDCId
477
+ * 公网独占集群ID或者CDCId,可以通过 [DescribeExclusiveClusters](https://cloud.tencent.com/document/product/214/49278) 接口获取。
478
478
  */
479
479
  ClusterIds?: Array<string>;
480
480
  /**
@@ -490,7 +490,7 @@ export interface CloneLoadBalancerRequest {
490
490
  */
491
491
  Zones?: Array<string>;
492
492
  /**
493
- * EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP
493
+ * EIP 的唯一 ID,形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP,可以通过 [DescribeAddresses](https://cloud.tencent.com/document/product/215/16702) 接口查询。
494
494
  */
495
495
  EipAddressId?: string;
496
496
  }
@@ -597,15 +597,15 @@ export interface RsTagRule {
597
597
  */
598
598
  export interface ModifyRuleRequest {
599
599
  /**
600
- * 负载均衡实例 ID
600
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
601
601
  */
602
602
  LoadBalancerId: string;
603
603
  /**
604
- * 负载均衡监听器 ID
604
+ * 负载均衡监听器 ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
605
605
  */
606
606
  ListenerId: string;
607
607
  /**
608
- * 要修改的转发规则的 ID
608
+ * 要修改的转发规则的 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口获取。
609
609
  */
610
610
  LocationId: string;
611
611
  /**
@@ -623,6 +623,7 @@ export interface ModifyRuleRequest {
623
623
  Scheduler?: string;
624
624
  /**
625
625
  * 会话保持时间。取值范围0或30-86400(单位:秒)。
626
+ 默认为0。
626
627
  */
627
628
  SessionExpireTime?: number;
628
629
  /**
@@ -1106,7 +1107,7 @@ export interface BasicTargetGroupInfo {
1106
1107
  */
1107
1108
  TargetGroupName?: string;
1108
1109
  /**
1109
- * 权重
1110
+ * 目标组权重
1110
1111
  */
1111
1112
  Weight?: number;
1112
1113
  }
@@ -1315,15 +1316,15 @@ export interface DescribeExclusiveClustersResponse {
1315
1316
  */
1316
1317
  export interface ModifyDomainRequest {
1317
1318
  /**
1318
- * 负载均衡实例 ID
1319
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
1319
1320
  */
1320
1321
  LoadBalancerId: string;
1321
1322
  /**
1322
- * 负载均衡监听器 ID
1323
+ * 负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
1323
1324
  */
1324
1325
  ListenerId: string;
1325
1326
  /**
1326
- * 监听器下的某个旧域名。
1327
+ * 监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
1327
1328
  */
1328
1329
  Domain: string;
1329
1330
  /**
@@ -1532,11 +1533,11 @@ export interface ModifyFunctionTargetsResponse {
1532
1533
  */
1533
1534
  export interface DeleteLoadBalancerListenersRequest {
1534
1535
  /**
1535
- * 负载均衡实例ID
1536
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
1536
1537
  */
1537
1538
  LoadBalancerId: string;
1538
1539
  /**
1539
- * 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器。
1540
+ * 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
1540
1541
  */
1541
1542
  ListenerIds?: Array<string>;
1542
1543
  }
@@ -1827,11 +1828,11 @@ export interface BatchRegisterTargetsResponse {
1827
1828
  */
1828
1829
  export interface ModifyLoadBalancerAttributesRequest {
1829
1830
  /**
1830
- * 负载均衡的唯一ID
1831
+ * 负载均衡的唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
1831
1832
  */
1832
1833
  LoadBalancerId: string;
1833
1834
  /**
1834
- * 负载均衡实例名称
1835
+ * 负载均衡实例名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
1835
1836
  */
1836
1837
  LoadBalancerName?: string;
1837
1838
  /**
@@ -1843,19 +1844,22 @@ export interface ModifyLoadBalancerAttributesRequest {
1843
1844
  */
1844
1845
  InternetChargeInfo?: InternetAccessible;
1845
1846
  /**
1846
- * Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。
1847
+ * Target是否放通来自CLB的流量。
1848
+ 开启放通(true):只验证CLB上的安全组;
1849
+ 不开启放通(false):需同时验证CLB和后端实例上的安全组。
1850
+ 不填则不修改。
1847
1851
  */
1848
1852
  LoadBalancerPassToTarget?: boolean;
1849
1853
  /**
1850
- * 是否开启跨地域绑定2.0功能
1854
+ * 是否开启跨地域绑定2.0功能。不填则不修改。
1851
1855
  */
1852
1856
  SnatPro?: boolean;
1853
1857
  /**
1854
- * 是否开启删除保护
1858
+ * 是否开启删除保护,不填则不修改。
1855
1859
  */
1856
1860
  DeleteProtect?: boolean;
1857
1861
  /**
1858
- * 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换。修改后mycloud.com域名将失效。
1862
+ * 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换,修改后mycloud.com域名将失效。不填则不修改。
1859
1863
  */
1860
1864
  ModifyClassicDomain?: boolean;
1861
1865
  }
@@ -2053,11 +2057,11 @@ export interface Listener {
2053
2057
  */
2054
2058
  ListenerId?: string;
2055
2059
  /**
2056
- * 监听器协议
2060
+ * 监听器协议,可选值:TCP、UDP、HTTP、HTTPS、TCP_SSL、QUIC
2057
2061
  */
2058
2062
  Protocol?: string;
2059
2063
  /**
2060
- * 监听器端口
2064
+ * 监听器端口,端口范围:1-65535
2061
2065
  */
2062
2066
  Port?: number;
2063
2067
  /**
@@ -2076,7 +2080,7 @@ export interface Listener {
2076
2080
  */
2077
2081
  Scheduler?: string;
2078
2082
  /**
2079
- * 会话保持时间
2083
+ * 会话保持时间,单位:秒。可选值:30~3600,默认 0,默认不开启。此参数仅适用于TCP/UDP监听器。
2080
2084
  注意:此字段可能返回 null,表示取不到有效值。
2081
2085
  */
2082
2086
  SessionExpireTime?: number;
@@ -2098,11 +2102,11 @@ export interface Listener {
2098
2102
  */
2099
2103
  CreateTime?: string;
2100
2104
  /**
2101
- * 端口段结束端口
2105
+ * 端口段结束端口,端口范围:2-65535
2102
2106
  */
2103
2107
  EndPort?: number;
2104
2108
  /**
2105
- * 后端服务器类型
2109
+ * 后端服务器类型,可选值:NODE、POLARIS、TARGETGROUP、TARGETGROUP-V2
2106
2110
  注意:此字段可能返回 null,表示取不到有效值。
2107
2111
  */
2108
2112
  TargetType?: string;
@@ -2369,15 +2373,15 @@ export interface DescribeTargetsResponse {
2369
2373
  */
2370
2374
  export interface ModifyListenerRequest {
2371
2375
  /**
2372
- * 负载均衡实例ID
2376
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2373
2377
  */
2374
2378
  LoadBalancerId: string;
2375
2379
  /**
2376
- * 负载均衡监听器ID
2380
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2377
2381
  */
2378
2382
  ListenerId: string;
2379
2383
  /**
2380
- * 新的监听器名称。
2384
+ * 新的监听器名称,最大长度255。
2381
2385
  */
2382
2386
  ListenerName?: string;
2383
2387
  /**
@@ -2393,7 +2397,7 @@ export interface ModifyListenerRequest {
2393
2397
  */
2394
2398
  Certificate?: CertificateInput;
2395
2399
  /**
2396
- * 监听器转发的方式。可选值:WRRLEAST_CONN
2400
+ * 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
2397
2401
  分别表示按权重轮询、最小连接数, 默认为 WRR。
2398
2402
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
2399
2403
  */
@@ -2409,15 +2413,18 @@ export interface ModifyListenerRequest {
2409
2413
  /**
2410
2414
  * 是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。
2411
2415
  默认值0表示不开启,1表示开启。
2416
+ 若后端服务对连接数上限有限制,则建议谨慎开启。此功能目前处于内测中,如需使用,请提交 [内测申请](https://cloud.tencent.com/apply/p/tsodp6qm21)。
2412
2417
  */
2413
2418
  KeepaliveEnable?: number;
2414
2419
  /**
2415
2420
  * 解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
2421
+ True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
2416
2422
  */
2417
2423
  DeregisterTargetRst?: boolean;
2418
2424
  /**
2419
2425
  * 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
2420
2426
  使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。
2427
+ 默认为 NORMAL。
2421
2428
  */
2422
2429
  SessionType?: string;
2423
2430
  /**
@@ -2426,20 +2433,26 @@ export interface ModifyListenerRequest {
2426
2433
  MultiCertInfo?: MultiCertInfo;
2427
2434
  /**
2428
2435
  * 监听器粒度并发连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格并发连接上限,其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
2436
+ 默认为 -1,表示不限速。
2429
2437
  */
2430
2438
  MaxConn?: number;
2431
2439
  /**
2432
2440
  * 监听器粒度新建连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格新建连接上限,其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
2441
+ 默认为 -1 表示不限速。
2433
2442
  */
2434
2443
  MaxCps?: number;
2435
2444
  /**
2436
- * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
2445
+ * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~1980。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
2437
2446
  */
2438
2447
  IdleConnectTimeout?: number;
2439
2448
  /**
2440
- * 是否开启SNAT。
2449
+ * 是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT
2441
2450
  */
2442
2451
  SnatEnable?: boolean;
2452
+ /**
2453
+ * 数据压缩模式
2454
+ */
2455
+ DataCompressMode?: string;
2443
2456
  }
2444
2457
  /**
2445
2458
  * DeregisterTargetGroupInstances返回参数结构体
@@ -2533,11 +2546,11 @@ export interface CreateTopicRequest {
2533
2546
  */
2534
2547
  export interface DeleteListenerRequest {
2535
2548
  /**
2536
- * 负载均衡实例ID
2549
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2537
2550
  */
2538
2551
  LoadBalancerId: string;
2539
2552
  /**
2540
- * 要删除的监听器ID
2553
+ * 要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2541
2554
  */
2542
2555
  ListenerId: string;
2543
2556
  }
@@ -2631,16 +2644,53 @@ export interface DescribeLoadBalancersDetailRequest {
2631
2644
  TargetType?: string;
2632
2645
  /**
2633
2646
  * 查询负载均衡详细信息列表条件,详细的过滤条件如下:
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>
2647
+ - loadbalancer-id
2648
+ 按照【负载均衡ID】进行过滤。例如:lb-rbw5skde。
2649
+ 类型:String
2650
+ 必选:否
2651
+ 获取方式:[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)
2652
+ - project-id
2653
+ 按照【项目ID】进行过滤。例如: "0"、"123"。
2654
+ 类型:String
2655
+ 必选:否
2656
+ 获取方式:[DescribeProject](https://cloud.tencent.com/document/api/651/78725)
2657
+ - network
2658
+ 按照【负载均衡网络类型】进行过滤。例如:Public。
2659
+ 类型:String
2660
+ 必选:否
2661
+ 可选值:Private(内网)、Public(公网)
2662
+ - vip
2663
+ 按照【负载均衡 VIP】进行过滤。例如:"1.1.1.1","2204::22:3"。
2664
+ 类型:String
2665
+ 必选:否
2666
+ - vpcid
2667
+ 按照【负载均衡所属 VPCID】进行过滤。例如:"vpc-12345678"。
2668
+ 类型:String
2669
+ 必选:否
2670
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
2671
+ - target-ip
2672
+ 按照【后端目标内网 IP】进行过滤。例如:"1.1.1.1","2203::214:4"。
2673
+ 类型:String
2674
+ 必选:否
2675
+ - zone
2676
+ 按照【负载均衡所属的可用区】进行过滤。例如:"ap-guangzhou-1"。
2677
+ 类型:String
2678
+ 必选:否
2679
+ 获取方式:[DescribeZones](https://cloud.tencent.com/document/product/213/15707)
2680
+ - tag-key
2681
+ 按照【负载均衡标签的标签键】进行过滤,例如:"name"。
2682
+ 类型:String
2683
+ 必选:否
2684
+ 获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
2685
+ - tag:*
2686
+ 按照【负载均衡的标签】进行过滤,':' 后面跟的是标签键。如过滤标签键name,标签值zhangsan,lisi,{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。
2687
+ 类型:String
2688
+ 必选:否
2689
+ 获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
2690
+ - fuzzy-search
2691
+ 按照【负载均衡VIP,负载均衡名称】模糊搜索,例如:"1.1"。
2692
+ 类型:String
2693
+ 必选:否
2644
2694
  */
2645
2695
  Filters?: Array<Filter>;
2646
2696
  }
@@ -2888,15 +2938,15 @@ export interface DescribeClusterResourcesRequest {
2888
2938
  */
2889
2939
  export interface ModifyDomainAttributesRequest {
2890
2940
  /**
2891
- * 负载均衡实例ID
2941
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
2892
2942
  */
2893
2943
  LoadBalancerId: string;
2894
2944
  /**
2895
- * 负载均衡监听器ID
2945
+ * 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2896
2946
  */
2897
2947
  ListenerId: string;
2898
2948
  /**
2899
- * 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个。
2949
+ * 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个,可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
2900
2950
  */
2901
2951
  Domain: string;
2902
2952
  /**
@@ -2908,15 +2958,18 @@ export interface ModifyDomainAttributesRequest {
2908
2958
  */
2909
2959
  Certificate?: CertificateInput;
2910
2960
  /**
2911
- * 是否开启Http2,注意,只有HTTPS域名才能开启Http2
2961
+ * 是否开启HTTP2,注意,只有HTTPS域名才能开启HTTP2
2962
+ True: 开启HTTP2,Fasle: 不开启HTTP2。
2912
2963
  */
2913
2964
  Http2?: boolean;
2914
2965
  /**
2915
2966
  * 是否设为默认域名,注意,一个监听器下只能设置一个默认域名。
2967
+ True: 设为默认域名,Fasle: 不设置为默认域名。
2916
2968
  */
2917
2969
  DefaultServer?: boolean;
2918
2970
  /**
2919
- * 是否开启Quic,注意,只有HTTPS域名才能开启Quic
2971
+ * 是否开启 QUIC,注意,只有 HTTPS 域名才能开启 QUIC。
2972
+ True: 开启 QUIC,False: 不开启QUIC。
2920
2973
  */
2921
2974
  Quic?: boolean;
2922
2975
  /**
@@ -2950,11 +3003,11 @@ export interface DescribeClassicalLBHealthStatusRequest {
2950
3003
  */
2951
3004
  export interface DescribeListenersRequest {
2952
3005
  /**
2953
- * 负载均衡实例 ID
3006
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。
2954
3007
  */
2955
3008
  LoadBalancerId: string;
2956
3009
  /**
2957
- * 要查询的负载均衡监听器 ID 数组,最大为100个。
3010
+ * 要查询的负载均衡监听器 ID 数组,最大为100个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。
2958
3011
  */
2959
3012
  ListenerIds?: Array<string>;
2960
3013
  /**
@@ -2962,7 +3015,7 @@ export interface DescribeListenersRequest {
2962
3015
  */
2963
3016
  Protocol?: string;
2964
3017
  /**
2965
- * 要查询的监听器的端口。
3018
+ * 要查询的监听器的端口,端口范围:1-65535
2966
3019
  */
2967
3020
  Port?: number;
2968
3021
  }
@@ -3058,11 +3111,12 @@ export interface AddCustomizedConfigResponse {
3058
3111
  */
3059
3112
  export interface DeleteLoadBalancerRequest {
3060
3113
  /**
3061
- * 要删除的负载均衡实例 ID数组,数组大小最大支持20。
3114
+ * 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
3062
3115
  */
3063
3116
  LoadBalancerIds: Array<string>;
3064
3117
  /**
3065
- * 是否强制删除clb。为true表示强制删除,为false表示不是强制删除,需要做拦截校验。
3118
+ * 是否强制删除clb。True表示强制删除,False表示不是强制删除,需要做拦截校验。
3119
+ 默认为 False
3066
3120
  */
3067
3121
  ForceDelete?: boolean;
3068
3122
  }
@@ -3097,7 +3151,8 @@ export interface AssociateCustomizedConfigRequest {
3097
3151
  */
3098
3152
  export interface CertificateInput {
3099
3153
  /**
3100
- * 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
3154
+ * 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证。
3155
+ 默认为 UNIDIRECTIONAL。
3101
3156
  */
3102
3157
  SSLMode?: string;
3103
3158
  /**
@@ -3105,7 +3160,7 @@ export interface CertificateInput {
3105
3160
  */
3106
3161
  SSLVerifyClient?: string;
3107
3162
  /**
3108
- * 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContentCertKeyCertName
3163
+ * 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent(服务端证书内容),CertKey(服务端证书密钥),CertName(服务端证书名称)。
3109
3164
  */
3110
3165
  CertId?: string;
3111
3166
  /**
@@ -3682,11 +3737,12 @@ export interface BindDetailItem {
3682
3737
  */
3683
3738
  export interface CreateListenerRequest {
3684
3739
  /**
3685
- * 负载均衡实例 ID
3740
+ * 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
3686
3741
  */
3687
3742
  LoadBalancerId: string;
3688
3743
  /**
3689
3744
  * 要将监听器创建到哪些端口,每个端口对应一个新的监听器。
3745
+ 端口范围:1~65535
3690
3746
  */
3691
3747
  Ports: Array<number | bigint>;
3692
3748
  /**
@@ -3708,12 +3764,12 @@ export interface CreateListenerRequest {
3708
3764
  */
3709
3765
  Certificate?: CertificateInput;
3710
3766
  /**
3711
- * 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
3767
+ * 会话保持时间,单位:秒。可选值:30~3600,默认为0,默认不开启。此参数仅适用于TCP/UDP监听器。
3712
3768
  */
3713
3769
  SessionExpireTime?: number;
3714
3770
  /**
3715
- * 监听器转发的方式。可选值:WRRLEAST_CONN
3716
- 分别表示按权重轮询、最小连接数, 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3771
+ * 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
3772
+ 默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
3717
3773
  */
3718
3774
  Scheduler?: string;
3719
3775
  /**
@@ -3756,27 +3812,27 @@ export interface CreateListenerRequest {
3756
3812
  */
3757
3813
  MaxCps?: number;
3758
3814
  /**
3759
- * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-2000。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3815
+ * 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-1980。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
3760
3816
  */
3761
3817
  IdleConnectTimeout?: number;
3762
3818
  /**
3763
- * 是否开启SNAT
3819
+ * 是否开启SNAT,True(开启)、False(关闭)
3764
3820
  */
3765
3821
  SnatEnable?: boolean;
3766
3822
  /**
3767
- * 全端口段监听器的结束端口
3823
+ * 全端口段监听器的结束端口,端口范围:2 - 65535
3768
3824
  */
3769
3825
  FullEndPorts?: Array<number | bigint>;
3770
3826
  /**
3771
- * 内网http监听器开启h2c开关
3827
+ * 内网http监听器开启h2c开关,True(开启)、False(关闭)
3772
3828
  */
3773
3829
  H2cSwitch?: boolean;
3774
3830
  /**
3775
- * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关
3831
+ * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
3776
3832
  */
3777
3833
  SslCloseSwitch?: boolean;
3778
3834
  /**
3779
- * 数据压缩模式
3835
+ * 数据压缩模式。可选值:transparent(透传模式)、compatibility(兼容模式)
3780
3836
  */
3781
3837
  DataCompressMode?: string;
3782
3838
  }
@@ -5263,11 +5319,14 @@ export interface OAuth {
5263
5319
  * 开启或关闭鉴权。
5264
5320
  True: 开启;
5265
5321
  False: 关闭
5322
+ 默认为关闭。
5266
5323
  */
5267
5324
  OAuthEnable?: boolean;
5268
5325
  /**
5269
- * IAP全部故障后,拒绝请求还是放行。BYPASS:通过,
5326
+ * IAP全部故障后,拒绝请求还是放行。
5327
+ BYPASS: 通过
5270
5328
  REJECT: 拒绝
5329
+ 默认为 BYPASS
5271
5330
  */
5272
5331
  OAuthFailureStatus?: string;
5273
5332
  }