tencentcloud-sdk-nodejs-clb 4.1.30 → 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
@@ -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 为入参,调用
|
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 为入参,调用
|
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 为入参,调用
|
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 为入参,调用
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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-
|
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
|
/**
|
@@ -831,7 +832,7 @@ export interface DescribeLoadBalancersRequest {
|
|
831
832
|
*/
|
832
833
|
SearchKey?: string;
|
833
834
|
/**
|
834
|
-
* 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)
|
835
|
+
* 负载均衡实例所属的项目 ID,可以通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)接口获取,不传默认所有项目。
|
835
836
|
*/
|
836
837
|
ProjectId?: number;
|
837
838
|
/**
|
@@ -839,12 +840,12 @@ export interface DescribeLoadBalancersRequest {
|
|
839
840
|
*/
|
840
841
|
WithRs?: number;
|
841
842
|
/**
|
842
|
-
* 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx
|
843
|
+
* 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx,可以通过[DescribeVpcs](https://cloud.tencent.com/document/api/215/15778)接口获取。
|
843
844
|
查找基础网络类型的负载均衡可传入'0'。
|
844
845
|
*/
|
845
846
|
VpcId?: string;
|
846
847
|
/**
|
847
|
-
* 安全组ID,如 sg-m1cc
|
848
|
+
* 安全组ID,如 sg-m1cc****,可以通过接口[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)获取。
|
848
849
|
*/
|
849
850
|
SecurityGroup?: string;
|
850
851
|
/**
|
@@ -872,10 +873,12 @@ export interface DescribeLoadBalancersRequest {
|
|
872
873
|
按照【CLB 标签的键】进行过滤,例如:tag-key。
|
873
874
|
类型:String
|
874
875
|
必选:否
|
876
|
+
获取方式:[DescribeTags](https://cloud.tencent.com/document/api/651/35316)
|
875
877
|
- tag:tag-key
|
876
878
|
按照【CLB标签键值】进行过滤,例如:tag-test。
|
877
879
|
类型:String
|
878
880
|
必选:否
|
881
|
+
获取方式:[DescribeTagKeys](https://cloud.tencent.com/document/api/651/35318)
|
879
882
|
- function-name
|
880
883
|
按照【后端绑定SCF云函数的函数名称】进行过滤,例如:helloworld-1744958255。
|
881
884
|
类型:String
|
@@ -1104,7 +1107,7 @@ export interface BasicTargetGroupInfo {
|
|
1104
1107
|
*/
|
1105
1108
|
TargetGroupName?: string;
|
1106
1109
|
/**
|
1107
|
-
*
|
1110
|
+
* 目标组权重
|
1108
1111
|
*/
|
1109
1112
|
Weight?: number;
|
1110
1113
|
}
|
@@ -1313,15 +1316,15 @@ export interface DescribeExclusiveClustersResponse {
|
|
1313
1316
|
*/
|
1314
1317
|
export interface ModifyDomainRequest {
|
1315
1318
|
/**
|
1316
|
-
* 负载均衡实例 ID
|
1319
|
+
* 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
|
1317
1320
|
*/
|
1318
1321
|
LoadBalancerId: string;
|
1319
1322
|
/**
|
1320
|
-
* 负载均衡监听器 ID
|
1323
|
+
* 负载均衡监听器 ID, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
1321
1324
|
*/
|
1322
1325
|
ListenerId: string;
|
1323
1326
|
/**
|
1324
|
-
*
|
1327
|
+
* 监听器下的某个旧域名, 可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 查询。
|
1325
1328
|
*/
|
1326
1329
|
Domain: string;
|
1327
1330
|
/**
|
@@ -1530,11 +1533,11 @@ export interface ModifyFunctionTargetsResponse {
|
|
1530
1533
|
*/
|
1531
1534
|
export interface DeleteLoadBalancerListenersRequest {
|
1532
1535
|
/**
|
1533
|
-
* 负载均衡实例ID
|
1536
|
+
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
|
1534
1537
|
*/
|
1535
1538
|
LoadBalancerId: string;
|
1536
1539
|
/**
|
1537
|
-
* 指定删除的监听器ID数组,最大为20
|
1540
|
+
* 指定删除的监听器ID数组,最大为20个。若不填则删除负载均衡的所有监听器,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
1538
1541
|
*/
|
1539
1542
|
ListenerIds?: Array<string>;
|
1540
1543
|
}
|
@@ -1825,11 +1828,11 @@ export interface BatchRegisterTargetsResponse {
|
|
1825
1828
|
*/
|
1826
1829
|
export interface ModifyLoadBalancerAttributesRequest {
|
1827
1830
|
/**
|
1828
|
-
* 负载均衡的唯一ID
|
1831
|
+
* 负载均衡的唯一ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
|
1829
1832
|
*/
|
1830
1833
|
LoadBalancerId: string;
|
1831
1834
|
/**
|
1832
|
-
*
|
1835
|
+
* 负载均衡实例名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
|
1833
1836
|
*/
|
1834
1837
|
LoadBalancerName?: string;
|
1835
1838
|
/**
|
@@ -1841,19 +1844,22 @@ export interface ModifyLoadBalancerAttributesRequest {
|
|
1841
1844
|
*/
|
1842
1845
|
InternetChargeInfo?: InternetAccessible;
|
1843
1846
|
/**
|
1844
|
-
* Target是否放通来自CLB
|
1847
|
+
* Target是否放通来自CLB的流量。
|
1848
|
+
开启放通(true):只验证CLB上的安全组;
|
1849
|
+
不开启放通(false):需同时验证CLB和后端实例上的安全组。
|
1850
|
+
不填则不修改。
|
1845
1851
|
*/
|
1846
1852
|
LoadBalancerPassToTarget?: boolean;
|
1847
1853
|
/**
|
1848
|
-
* 是否开启跨地域绑定2.0
|
1854
|
+
* 是否开启跨地域绑定2.0功能。不填则不修改。
|
1849
1855
|
*/
|
1850
1856
|
SnatPro?: boolean;
|
1851
1857
|
/**
|
1852
|
-
*
|
1858
|
+
* 是否开启删除保护,不填则不修改。
|
1853
1859
|
*/
|
1854
1860
|
DeleteProtect?: boolean;
|
1855
1861
|
/**
|
1856
|
-
* 将负载均衡二级域名由mycloud.com改为tencentclb.com
|
1862
|
+
* 将负载均衡二级域名由mycloud.com改为tencentclb.com,子域名也会变换,修改后mycloud.com域名将失效。不填则不修改。
|
1857
1863
|
*/
|
1858
1864
|
ModifyClassicDomain?: boolean;
|
1859
1865
|
}
|
@@ -2051,11 +2057,11 @@ export interface Listener {
|
|
2051
2057
|
*/
|
2052
2058
|
ListenerId?: string;
|
2053
2059
|
/**
|
2054
|
-
*
|
2060
|
+
* 监听器协议,可选值:TCP、UDP、HTTP、HTTPS、TCP_SSL、QUIC
|
2055
2061
|
*/
|
2056
2062
|
Protocol?: string;
|
2057
2063
|
/**
|
2058
|
-
*
|
2064
|
+
* 监听器端口,端口范围:1-65535
|
2059
2065
|
*/
|
2060
2066
|
Port?: number;
|
2061
2067
|
/**
|
@@ -2074,7 +2080,7 @@ export interface Listener {
|
|
2074
2080
|
*/
|
2075
2081
|
Scheduler?: string;
|
2076
2082
|
/**
|
2077
|
-
*
|
2083
|
+
* 会话保持时间,单位:秒。可选值:30~3600,默认 0,默认不开启。此参数仅适用于TCP/UDP监听器。
|
2078
2084
|
注意:此字段可能返回 null,表示取不到有效值。
|
2079
2085
|
*/
|
2080
2086
|
SessionExpireTime?: number;
|
@@ -2096,11 +2102,11 @@ export interface Listener {
|
|
2096
2102
|
*/
|
2097
2103
|
CreateTime?: string;
|
2098
2104
|
/**
|
2099
|
-
*
|
2105
|
+
* 端口段结束端口,端口范围:2-65535
|
2100
2106
|
*/
|
2101
2107
|
EndPort?: number;
|
2102
2108
|
/**
|
2103
|
-
*
|
2109
|
+
* 后端服务器类型,可选值:NODE、POLARIS、TARGETGROUP、TARGETGROUP-V2
|
2104
2110
|
注意:此字段可能返回 null,表示取不到有效值。
|
2105
2111
|
*/
|
2106
2112
|
TargetType?: string;
|
@@ -2251,6 +2257,7 @@ export interface RegisterTargetsWithClassicalLBRequest {
|
|
2251
2257
|
export interface HealthCheck {
|
2252
2258
|
/**
|
2253
2259
|
* 是否开启健康检查:1(开启)、0(关闭)。
|
2260
|
+
默认为开启。
|
2254
2261
|
*/
|
2255
2262
|
HealthSwitch?: number;
|
2256
2263
|
/**
|
@@ -2366,15 +2373,15 @@ export interface DescribeTargetsResponse {
|
|
2366
2373
|
*/
|
2367
2374
|
export interface ModifyListenerRequest {
|
2368
2375
|
/**
|
2369
|
-
* 负载均衡实例ID
|
2376
|
+
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
|
2370
2377
|
*/
|
2371
2378
|
LoadBalancerId: string;
|
2372
2379
|
/**
|
2373
|
-
* 负载均衡监听器ID
|
2380
|
+
* 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
2374
2381
|
*/
|
2375
2382
|
ListenerId: string;
|
2376
2383
|
/**
|
2377
|
-
*
|
2384
|
+
* 新的监听器名称,最大长度255。
|
2378
2385
|
*/
|
2379
2386
|
ListenerName?: string;
|
2380
2387
|
/**
|
@@ -2390,7 +2397,7 @@ export interface ModifyListenerRequest {
|
|
2390
2397
|
*/
|
2391
2398
|
Certificate?: CertificateInput;
|
2392
2399
|
/**
|
2393
|
-
* 监听器转发的方式。可选值:WRR
|
2400
|
+
* 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
|
2394
2401
|
分别表示按权重轮询、最小连接数, 默认为 WRR。
|
2395
2402
|
使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。七层监听器的均衡方式应在转发规则中修改。
|
2396
2403
|
*/
|
@@ -2406,15 +2413,18 @@ export interface ModifyListenerRequest {
|
|
2406
2413
|
/**
|
2407
2414
|
* 是否开启长连接,此参数仅适用于HTTP/HTTPS监听器。
|
2408
2415
|
默认值0表示不开启,1表示开启。
|
2416
|
+
若后端服务对连接数上限有限制,则建议谨慎开启。此功能目前处于内测中,如需使用,请提交 [内测申请](https://cloud.tencent.com/apply/p/tsodp6qm21)。
|
2409
2417
|
*/
|
2410
2418
|
KeepaliveEnable?: number;
|
2411
2419
|
/**
|
2412
2420
|
* 解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
|
2421
|
+
True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
|
2413
2422
|
*/
|
2414
2423
|
DeregisterTargetRst?: boolean;
|
2415
2424
|
/**
|
2416
2425
|
* 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
|
2417
2426
|
使用场景:适用于TCP/UDP/TCP_SSL/QUIC监听器。
|
2427
|
+
默认为 NORMAL。
|
2418
2428
|
*/
|
2419
2429
|
SessionType?: string;
|
2420
2430
|
/**
|
@@ -2423,20 +2433,26 @@ export interface ModifyListenerRequest {
|
|
2423
2433
|
MultiCertInfo?: MultiCertInfo;
|
2424
2434
|
/**
|
2425
2435
|
* 监听器粒度并发连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格并发连接上限,其中-1表示关闭监听器粒度并发连接数限速。基础网络实例不支持该参数。
|
2436
|
+
默认为 -1,表示不限速。
|
2426
2437
|
*/
|
2427
2438
|
MaxConn?: number;
|
2428
2439
|
/**
|
2429
2440
|
* 监听器粒度新建连接数上限,当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持。取值范围:1-实例规格新建连接上限,其中-1表示关闭监听器粒度新建连接数限速。基础网络实例不支持该参数。
|
2441
|
+
默认为 -1 表示不限速。
|
2430
2442
|
*/
|
2431
2443
|
MaxCps?: number;
|
2432
2444
|
/**
|
2433
|
-
* 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~
|
2445
|
+
* 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~1980。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
|
2434
2446
|
*/
|
2435
2447
|
IdleConnectTimeout?: number;
|
2436
2448
|
/**
|
2437
|
-
* 是否开启SNAT。
|
2449
|
+
* 是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT。
|
2438
2450
|
*/
|
2439
2451
|
SnatEnable?: boolean;
|
2452
|
+
/**
|
2453
|
+
* 数据压缩模式
|
2454
|
+
*/
|
2455
|
+
DataCompressMode?: string;
|
2440
2456
|
}
|
2441
2457
|
/**
|
2442
2458
|
* DeregisterTargetGroupInstances返回参数结构体
|
@@ -2530,11 +2546,11 @@ export interface CreateTopicRequest {
|
|
2530
2546
|
*/
|
2531
2547
|
export interface DeleteListenerRequest {
|
2532
2548
|
/**
|
2533
|
-
* 负载均衡实例ID
|
2549
|
+
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
|
2534
2550
|
*/
|
2535
2551
|
LoadBalancerId: string;
|
2536
2552
|
/**
|
2537
|
-
* 要删除的监听器ID
|
2553
|
+
* 要删除的监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
2538
2554
|
*/
|
2539
2555
|
ListenerId: string;
|
2540
2556
|
}
|
@@ -2628,16 +2644,53 @@ export interface DescribeLoadBalancersDetailRequest {
|
|
2628
2644
|
TargetType?: string;
|
2629
2645
|
/**
|
2630
2646
|
* 查询负载均衡详细信息列表条件,详细的过滤条件如下:
|
2631
|
-
|
2632
|
-
|
2633
|
-
|
2634
|
-
|
2635
|
-
|
2636
|
-
|
2637
|
-
|
2638
|
-
|
2639
|
-
|
2640
|
-
|
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
|
+
必选:否
|
2641
2694
|
*/
|
2642
2695
|
Filters?: Array<Filter>;
|
2643
2696
|
}
|
@@ -2885,15 +2938,15 @@ export interface DescribeClusterResourcesRequest {
|
|
2885
2938
|
*/
|
2886
2939
|
export interface ModifyDomainAttributesRequest {
|
2887
2940
|
/**
|
2888
|
-
* 负载均衡实例ID
|
2941
|
+
* 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口查询。
|
2889
2942
|
*/
|
2890
2943
|
LoadBalancerId: string;
|
2891
2944
|
/**
|
2892
|
-
* 负载均衡监听器ID
|
2945
|
+
* 负载均衡监听器ID,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
2893
2946
|
*/
|
2894
2947
|
ListenerId: string;
|
2895
2948
|
/**
|
2896
|
-
*
|
2949
|
+
* 域名(必须是已经创建的转发规则下的域名),如果是多域名,可以指定多域名列表中的任意一个,可以通过[DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
|
2897
2950
|
*/
|
2898
2951
|
Domain: string;
|
2899
2952
|
/**
|
@@ -2905,15 +2958,18 @@ export interface ModifyDomainAttributesRequest {
|
|
2905
2958
|
*/
|
2906
2959
|
Certificate?: CertificateInput;
|
2907
2960
|
/**
|
2908
|
-
* 是否开启
|
2961
|
+
* 是否开启HTTP2,注意,只有HTTPS域名才能开启HTTP2。
|
2962
|
+
True: 开启HTTP2,Fasle: 不开启HTTP2。
|
2909
2963
|
*/
|
2910
2964
|
Http2?: boolean;
|
2911
2965
|
/**
|
2912
2966
|
* 是否设为默认域名,注意,一个监听器下只能设置一个默认域名。
|
2967
|
+
True: 设为默认域名,Fasle: 不设置为默认域名。
|
2913
2968
|
*/
|
2914
2969
|
DefaultServer?: boolean;
|
2915
2970
|
/**
|
2916
|
-
* 是否开启
|
2971
|
+
* 是否开启 QUIC,注意,只有 HTTPS 域名才能开启 QUIC。
|
2972
|
+
True: 开启 QUIC,False: 不开启QUIC。
|
2917
2973
|
*/
|
2918
2974
|
Quic?: boolean;
|
2919
2975
|
/**
|
@@ -2947,11 +3003,11 @@ export interface DescribeClassicalLBHealthStatusRequest {
|
|
2947
3003
|
*/
|
2948
3004
|
export interface DescribeListenersRequest {
|
2949
3005
|
/**
|
2950
|
-
* 负载均衡实例 ID
|
3006
|
+
* 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685) 接口获取。
|
2951
3007
|
*/
|
2952
3008
|
LoadBalancerId: string;
|
2953
3009
|
/**
|
2954
|
-
* 要查询的负载均衡监听器 ID 数组,最大为100
|
3010
|
+
* 要查询的负载均衡监听器 ID 数组,最大为100个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/api/214/30686) 接口获取。
|
2955
3011
|
*/
|
2956
3012
|
ListenerIds?: Array<string>;
|
2957
3013
|
/**
|
@@ -2959,7 +3015,7 @@ export interface DescribeListenersRequest {
|
|
2959
3015
|
*/
|
2960
3016
|
Protocol?: string;
|
2961
3017
|
/**
|
2962
|
-
*
|
3018
|
+
* 要查询的监听器的端口,端口范围:1-65535
|
2963
3019
|
*/
|
2964
3020
|
Port?: number;
|
2965
3021
|
}
|
@@ -3055,11 +3111,12 @@ export interface AddCustomizedConfigResponse {
|
|
3055
3111
|
*/
|
3056
3112
|
export interface DeleteLoadBalancerRequest {
|
3057
3113
|
/**
|
3058
|
-
* 要删除的负载均衡实例 ID
|
3114
|
+
* 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
|
3059
3115
|
*/
|
3060
3116
|
LoadBalancerIds: Array<string>;
|
3061
3117
|
/**
|
3062
|
-
* 是否强制删除clb
|
3118
|
+
* 是否强制删除clb。True表示强制删除,False表示不是强制删除,需要做拦截校验。
|
3119
|
+
默认为 False
|
3063
3120
|
*/
|
3064
3121
|
ForceDelete?: boolean;
|
3065
3122
|
}
|
@@ -3094,7 +3151,8 @@ export interface AssociateCustomizedConfigRequest {
|
|
3094
3151
|
*/
|
3095
3152
|
export interface CertificateInput {
|
3096
3153
|
/**
|
3097
|
-
* 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL
|
3154
|
+
* 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证。
|
3155
|
+
默认为 UNIDIRECTIONAL。
|
3098
3156
|
*/
|
3099
3157
|
SSLMode?: string;
|
3100
3158
|
/**
|
@@ -3102,7 +3160,7 @@ export interface CertificateInput {
|
|
3102
3160
|
*/
|
3103
3161
|
SSLVerifyClient?: string;
|
3104
3162
|
/**
|
3105
|
-
* 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent
|
3163
|
+
* 服务端证书的 ID,如果不填写此项则必须上传证书,包括 CertContent(服务端证书内容),CertKey(服务端证书密钥),CertName(服务端证书名称)。
|
3106
3164
|
*/
|
3107
3165
|
CertId?: string;
|
3108
3166
|
/**
|
@@ -3679,11 +3737,12 @@ export interface BindDetailItem {
|
|
3679
3737
|
*/
|
3680
3738
|
export interface CreateListenerRequest {
|
3681
3739
|
/**
|
3682
|
-
* 负载均衡实例 ID
|
3740
|
+
* 负载均衡实例 ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
|
3683
3741
|
*/
|
3684
3742
|
LoadBalancerId: string;
|
3685
3743
|
/**
|
3686
3744
|
* 要将监听器创建到哪些端口,每个端口对应一个新的监听器。
|
3745
|
+
端口范围:1~65535
|
3687
3746
|
*/
|
3688
3747
|
Ports: Array<number | bigint>;
|
3689
3748
|
/**
|
@@ -3705,12 +3764,12 @@ export interface CreateListenerRequest {
|
|
3705
3764
|
*/
|
3706
3765
|
Certificate?: CertificateInput;
|
3707
3766
|
/**
|
3708
|
-
* 会话保持时间,单位:秒。可选值:30~3600
|
3767
|
+
* 会话保持时间,单位:秒。可选值:30~3600,默认为0,默认不开启。此参数仅适用于TCP/UDP监听器。
|
3709
3768
|
*/
|
3710
3769
|
SessionExpireTime?: number;
|
3711
3770
|
/**
|
3712
|
-
* 监听器转发的方式。可选值:WRR
|
3713
|
-
|
3771
|
+
* 监听器转发的方式。可选值:WRR(按权重轮询)、LEAST_CONN(按最小连接数)、IP_HASH(按 IP 地址哈希)
|
3772
|
+
默认为 WRR。此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
|
3714
3773
|
*/
|
3715
3774
|
Scheduler?: string;
|
3716
3775
|
/**
|
@@ -3753,27 +3812,27 @@ export interface CreateListenerRequest {
|
|
3753
3812
|
*/
|
3754
3813
|
MaxCps?: number;
|
3755
3814
|
/**
|
3756
|
-
* 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-
|
3815
|
+
* 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。取值范围:共享型实例和独占型实例支持:300-900,性能容量型实例支持:300-1980。如需设置请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)。
|
3757
3816
|
*/
|
3758
3817
|
IdleConnectTimeout?: number;
|
3759
3818
|
/**
|
3760
|
-
* 是否开启SNAT
|
3819
|
+
* 是否开启SNAT,True(开启)、False(关闭)
|
3761
3820
|
*/
|
3762
3821
|
SnatEnable?: boolean;
|
3763
3822
|
/**
|
3764
|
-
*
|
3823
|
+
* 全端口段监听器的结束端口,端口范围:2 - 65535
|
3765
3824
|
*/
|
3766
3825
|
FullEndPorts?: Array<number | bigint>;
|
3767
3826
|
/**
|
3768
|
-
* 内网http监听器开启h2c
|
3827
|
+
* 内网http监听器开启h2c开关,True(开启)、False(关闭)
|
3769
3828
|
*/
|
3770
3829
|
H2cSwitch?: boolean;
|
3771
3830
|
/**
|
3772
|
-
* TCP_SSL监听器支持关闭SSL
|
3831
|
+
* TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
|
3773
3832
|
*/
|
3774
3833
|
SslCloseSwitch?: boolean;
|
3775
3834
|
/**
|
3776
|
-
*
|
3835
|
+
* 数据压缩模式。可选值:transparent(透传模式)、compatibility(兼容模式)
|
3777
3836
|
*/
|
3778
3837
|
DataCompressMode?: string;
|
3779
3838
|
}
|
@@ -5240,7 +5299,14 @@ export interface InternetAccessible {
|
|
5240
5299
|
*/
|
5241
5300
|
InternetMaxBandwidthOut?: number;
|
5242
5301
|
/**
|
5243
|
-
* 带宽包的类型,如
|
5302
|
+
* 带宽包的类型,如 BGP(多线)。
|
5303
|
+
类型如下:
|
5304
|
+
SINGLEISP: 单线
|
5305
|
+
BGP: 多线
|
5306
|
+
HIGH_QUALITY_BGP: 精品BGP共享带宽包
|
5307
|
+
SINGLEISP_CMCC: 中国移动共享带宽包
|
5308
|
+
SINGLEISP_CTCC: 中国电信共享带宽包
|
5309
|
+
SINGLEISP_CUCC: 中国联通共享带宽包
|
5244
5310
|
注意:此字段可能返回 null,表示取不到有效值。
|
5245
5311
|
*/
|
5246
5312
|
BandwidthpkgSubType?: string;
|
@@ -5253,11 +5319,14 @@ export interface OAuth {
|
|
5253
5319
|
* 开启或关闭鉴权。
|
5254
5320
|
True: 开启;
|
5255
5321
|
False: 关闭
|
5322
|
+
默认为关闭。
|
5256
5323
|
*/
|
5257
5324
|
OAuthEnable?: boolean;
|
5258
5325
|
/**
|
5259
|
-
* IAP全部故障后,拒绝请求还是放行。
|
5326
|
+
* IAP全部故障后,拒绝请求还是放行。
|
5327
|
+
BYPASS: 通过
|
5260
5328
|
REJECT: 拒绝
|
5329
|
+
默认为 BYPASS
|
5261
5330
|
*/
|
5262
5331
|
OAuthFailureStatus?: string;
|
5263
5332
|
}
|
@@ -5770,7 +5839,7 @@ export interface LoadBalancer {
|
|
5770
5839
|
*/
|
5771
5840
|
AddressIPVersion?: string;
|
5772
5841
|
/**
|
5773
|
-
* 数值形式的私有网络 ID
|
5842
|
+
* 数值形式的私有网络 ID,可以通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。
|
5774
5843
|
*/
|
5775
5844
|
NumericalVpcId?: number;
|
5776
5845
|
/**
|