tencentcloud-sdk-nodejs-clb 4.1.34 → 4.1.38

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.34",
3
+ "version": "4.1.38",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -55,7 +55,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
55
55
  AssociateTargetGroups(req: AssociateTargetGroupsRequest, cb?: (error: string, rep: AssociateTargetGroupsResponse) => void): Promise<AssociateTargetGroupsResponse>;
56
56
  /**
57
57
  * 从目标组中解绑服务器。
58
- 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
58
+ 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
59
59
  */
60
60
  DeregisterTargetGroupInstances(req: DeregisterTargetGroupInstancesRequest, cb?: (error: string, rep: DeregisterTargetGroupInstancesResponse) => void): Promise<DeregisterTargetGroupInstancesResponse>;
61
61
  /**
@@ -85,7 +85,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
85
85
  DeregisterTargets(req: DeregisterTargetsRequest, cb?: (error: string, rep: DeregisterTargetsResponse) => void): Promise<DeregisterTargetsResponse>;
86
86
  /**
87
87
  * 修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
88
- 注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。
88
+ 注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。修改网络计费模式请到控制台操作。
89
89
  本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
90
90
  */
91
91
  ModifyLoadBalancerAttributes(req: ModifyLoadBalancerAttributesRequest, cb?: (error: string, rep: ModifyLoadBalancerAttributesResponse) => void): Promise<ModifyLoadBalancerAttributesResponse>;
@@ -133,7 +133,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
133
133
  RegisterTargetGroupInstances(req: RegisterTargetGroupInstancesRequest, cb?: (error: string, rep: RegisterTargetGroupInstancesResponse) => void): Promise<RegisterTargetGroupInstancesResponse>;
134
134
  /**
135
135
  * 启停负载均衡实例或者监听器。
136
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
136
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
137
137
  该功能正在内测中,如需使用,请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。
138
138
  */
139
139
  SetLoadBalancerStartStatus(req: SetLoadBalancerStartStatusRequest, cb?: (error: string, rep: SetLoadBalancerStartStatusResponse) => void): Promise<SetLoadBalancerStartStatusResponse>;
@@ -216,10 +216,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
216
216
  */
217
217
  DeregisterFunctionTargets(req: DeregisterFunctionTargetsRequest, cb?: (error: string, rep: DeregisterFunctionTargetsResponse) => void): Promise<DeregisterFunctionTargetsResponse>;
218
218
  /**
219
- * 本接口(ModifyLoadBalancerSla)用于将按量计费模式的共享型实例升级为性能容量型实例。<br/>
219
+ * 本接口(ModifyLoadBalancerSla)用于调整按量计费模式实例的性能容量型规格,如共享型升级性能容量型,性能容量型实例规格调整。<br/>
220
220
  限制条件:
221
- - 本接口只支持升级按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行升级。
222
- - 升级为性能容量型实例后,不支持再回退到共享型实例。
221
+ - 本接口只支持调整按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行调整。
222
+ - 共享型升级为性能容量型实例后,不支持再回退到共享型实例。
223
223
  - 传统型负载均衡实例不支持升级为性能容量型实例。
224
224
  */
225
225
  ModifyLoadBalancerSla(req: ModifyLoadBalancerSlaRequest, cb?: (error: string, rep: ModifyLoadBalancerSlaResponse) => void): Promise<ModifyLoadBalancerSlaResponse>;
@@ -404,7 +404,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
404
404
  DescribeClsLogSet(req?: DescribeClsLogSetRequest, cb?: (error: string, rep: DescribeClsLogSetResponse) => void): Promise<DescribeClsLogSetResponse>;
405
405
  /**
406
406
  * ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。
407
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
407
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
408
408
  */
409
409
  ModifyTargetWeight(req: ModifyTargetWeightRequest, cb?: (error: string, rep: ModifyTargetWeightResponse) => void): Promise<ModifyTargetWeightResponse>;
410
410
  /**
@@ -97,7 +97,7 @@ class Client extends TencentCloudCommon.AbstractClient {
97
97
  }
98
98
  /**
99
99
  * 从目标组中解绑服务器。
100
- 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
100
+ 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
101
101
  */
102
102
  async DeregisterTargetGroupInstances(req, cb) {
103
103
  return this.request("DeregisterTargetGroupInstances", req, cb);
@@ -141,7 +141,7 @@ class Client extends TencentCloudCommon.AbstractClient {
141
141
  }
142
142
  /**
143
143
  * 修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
144
- 注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。
144
+ 注意:非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。修改网络计费模式请到控制台操作。
145
145
  本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
146
146
  */
147
147
  async ModifyLoadBalancerAttributes(req, cb) {
@@ -209,7 +209,7 @@ class Client extends TencentCloudCommon.AbstractClient {
209
209
  }
210
210
  /**
211
211
  * 启停负载均衡实例或者监听器。
212
- 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。
212
+ 本接口为异步接口,接口返回成功后,需以得到的 RequestID 为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
213
213
  该功能正在内测中,如需使用,请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。
214
214
  */
215
215
  async SetLoadBalancerStartStatus(req, cb) {
@@ -320,10 +320,10 @@ class Client extends TencentCloudCommon.AbstractClient {
320
320
  return this.request("DeregisterFunctionTargets", req, cb);
321
321
  }
322
322
  /**
323
- * 本接口(ModifyLoadBalancerSla)用于将按量计费模式的共享型实例升级为性能容量型实例。<br/>
323
+ * 本接口(ModifyLoadBalancerSla)用于调整按量计费模式实例的性能容量型规格,如共享型升级性能容量型,性能容量型实例规格调整。<br/>
324
324
  限制条件:
325
- - 本接口只支持升级按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行升级。
326
- - 升级为性能容量型实例后,不支持再回退到共享型实例。
325
+ - 本接口只支持调整按量计费的CLB实例,包年包月的CLB实例升级请通过控制台进行调整。
326
+ - 共享型升级为性能容量型实例后,不支持再回退到共享型实例。
327
327
  - 传统型负载均衡实例不支持升级为性能容量型实例。
328
328
  */
329
329
  async ModifyLoadBalancerSla(req, cb) {
@@ -590,7 +590,7 @@ class Client extends TencentCloudCommon.AbstractClient {
590
590
  }
591
591
  /**
592
592
  * ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。
593
- 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
593
+ 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
594
594
  */
595
595
  async ModifyTargetWeight(req, cb) {
596
596
  return this.request("ModifyTargetWeight", req, cb);
@@ -266,7 +266,7 @@ export interface CreateLoadBalancerRequest {
266
266
  Number?: number;
267
267
  /**
268
268
  * 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID, 可用区 ID 和名称均支持,例如 100001 或 ap-guangzhou-1
269
- 注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 [DescribeResources](https://cloud.tencent.com/document/api/214/70213) 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category)】
269
+ 注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。
270
270
  */
271
271
  MasterZoneId?: string;
272
272
  /**
@@ -395,15 +395,15 @@ export interface DeleteRuleRequest {
395
395
  */
396
396
  ListenerId: string;
397
397
  /**
398
- * 要删除的转发规则的ID组成的数组,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
398
+ * 要删除的转发规则的ID组成的数组,可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。
399
399
  */
400
400
  LocationIds?: Array<string>;
401
401
  /**
402
- * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
402
+ * 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个,可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。
403
403
  */
404
404
  Domain?: string;
405
405
  /**
406
- * 要删除的转发规则的转发路径,可以通过 [DescribeListeners](https://cloud.tencent.com/document/product/214/30686) 接口查询。
406
+ * 要删除的转发规则的转发路径,可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/api/214/46916) 接口查询。
407
407
  */
408
408
  Url?: string;
409
409
  /**
@@ -2433,6 +2433,7 @@ export interface ModifyListenerRequest {
2433
2433
  /**
2434
2434
  * 解绑后端目标时,是否发RST给客户端,此参数仅适用于TCP监听器。
2435
2435
  True表示发送 RST 给客户端,False表示不发送 RST 给客户端。
2436
+ 不传则表示不修改。
2436
2437
  */
2437
2438
  DeregisterTargetRst?: boolean;
2438
2439
  /**
@@ -2461,6 +2462,7 @@ export interface ModifyListenerRequest {
2461
2462
  IdleConnectTimeout?: number;
2462
2463
  /**
2463
2464
  * 是否开启SNAT, True 表示开启 SNAT,False 表示不开启 SNAT。
2465
+ 不传则表示不修改。
2464
2466
  */
2465
2467
  SnatEnable?: boolean;
2466
2468
  /**
@@ -2598,7 +2600,7 @@ export interface ClassicalHealth {
2598
2600
  */
2599
2601
  export interface DescribeCustomizedConfigAssociateListRequest {
2600
2602
  /**
2601
- * 配置ID
2603
+ * 配置ID,可以通过 [DescribeCustomizedConfigList](https://cloud.tencent.com/document/product/214/60009) 接口获取。
2602
2604
  */
2603
2605
  UconfigId?: string;
2604
2606
  /**
@@ -2610,7 +2612,7 @@ export interface DescribeCustomizedConfigAssociateListRequest {
2610
2612
  */
2611
2613
  Limit?: number;
2612
2614
  /**
2613
- * 搜索域名
2615
+ * 搜索域名,可以通过 [DescribeLoadBalancersDetail](https://cloud.tencent.com/document/product/214/46916) 接口返回值的 `Domain` 字段查询。
2614
2616
  */
2615
2617
  Domain?: string;
2616
2618
  }
@@ -3125,7 +3127,7 @@ export interface AddCustomizedConfigResponse {
3125
3127
  */
3126
3128
  export interface DeleteLoadBalancerRequest {
3127
3129
  /**
3128
- * 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取数组大小最大支持20。
3130
+ * 要删除的负载均衡实例 ID 数组,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取,数组大小最大支持20。
3129
3131
  */
3130
3132
  LoadBalancerIds: Array<string>;
3131
3133
  /**
@@ -3569,7 +3571,7 @@ export interface DeregisterTargetGroupInstancesRequest {
3569
3571
  TargetGroupId: string;
3570
3572
  /**
3571
3573
  * 待解绑的服务器信息,支持批量解除绑定,单次批量解除数量最多为20个。
3572
-
3574
+ 在这个接口 Port 参数为必填项。
3573
3575
  */
3574
3576
  TargetGroupInstances: Array<TargetGroupInstance>;
3575
3577
  }
@@ -3599,7 +3601,7 @@ export interface ManualRewriteRequest {
3599
3601
  */
3600
3602
  export interface InquiryPriceRefundLoadBalancerRequest {
3601
3603
  /**
3602
- * 负载均衡实例ID
3604
+ * 负载均衡实例ID。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
3603
3605
  */
3604
3606
  LoadBalancerId: string;
3605
3607
  }
@@ -3845,7 +3847,8 @@ export interface CreateListenerRequest {
3845
3847
  */
3846
3848
  IdleConnectTimeout?: number;
3847
3849
  /**
3848
- * 是否开启SNAT,True(开启)、False(关闭)
3850
+ * 是否开启SNAT,True(开启)、False(关闭)。
3851
+ 默认为关闭。
3849
3852
  */
3850
3853
  SnatEnable?: boolean;
3851
3854
  /**
@@ -3853,11 +3856,13 @@ export interface CreateListenerRequest {
3853
3856
  */
3854
3857
  FullEndPorts?: Array<number | bigint>;
3855
3858
  /**
3856
- * 内网http监听器开启h2c开关,True(开启)、False(关闭)
3859
+ * 内网http监听器开启h2c开关,True(开启)、False(关闭)。
3860
+ 默认为关闭。
3857
3861
  */
3858
3862
  H2cSwitch?: boolean;
3859
3863
  /**
3860
- * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启)
3864
+ * TCP_SSL监听器支持关闭SSL后仍然支持混绑,此参数为关闭开关。True(关闭)、False(开启).
3865
+ 默认为关闭。
3861
3866
  */
3862
3867
  SslCloseSwitch?: boolean;
3863
3868
  /**
@@ -4201,6 +4206,10 @@ export interface ModifyTargetWeightRequest {
4201
4206
  * 负载均衡监听器ID。
4202
4207
  */
4203
4208
  ListenerId: string;
4209
+ /**
4210
+ * 要修改权重的后端服务列表。
4211
+ */
4212
+ Targets: Array<Target>;
4204
4213
  /**
4205
4214
  * 转发规则的ID,当绑定机器到七层转发规则时,必须提供此参数或Domain+Url两者之一。
4206
4215
  */
@@ -4213,10 +4222,6 @@ export interface ModifyTargetWeightRequest {
4213
4222
  * 目标规则的URL,提供LocationId参数时本参数不生效。
4214
4223
  */
4215
4224
  Url?: string;
4216
- /**
4217
- * 要修改权重的后端服务列表。
4218
- */
4219
- Targets?: Array<Target>;
4220
4225
  /**
4221
4226
  * 后端服务新的转发权重,取值范围:0~100,默认值10。如果设置了 Targets.Weight 参数,则此参数不生效。
4222
4227
  */
@@ -5319,7 +5324,7 @@ export interface DescribeIdleLoadBalancersRequest {
5319
5324
  */
5320
5325
  Limit?: number;
5321
5326
  /**
5322
- * 负载均衡所在地域。
5327
+ * 负载均衡所在地域,可以通过 [DescribeRegions](https://cloud.tencent.com/document/product/1596/77930) 接口返回值 `RegionSet.Region` 字段获取。
5323
5328
  */
5324
5329
  LoadBalancerRegion?: string;
5325
5330
  }
@@ -5619,7 +5624,7 @@ export interface CertificateOutput {
5619
5624
  */
5620
5625
  export interface DeleteTargetGroupsRequest {
5621
5626
  /**
5622
- * 目标组的ID数组。
5627
+ * 目标组的ID数组,单次最多支持删除20个。
5623
5628
  */
5624
5629
  TargetGroupIds: Array<string>;
5625
5630
  }
@@ -5657,7 +5662,7 @@ export interface SetLoadBalancerStartStatusRequest {
5657
5662
  */
5658
5663
  OperationType: string;
5659
5664
  /**
5660
- * 负载均衡实例ID
5665
+ * 负载均衡实例ID,可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459) 接口查询。
5661
5666
  */
5662
5667
  LoadBalancerId: string;
5663
5668
  /**