BatchModifyTargetWeight

Last updated: 2021-09-07 15:42:23

1. API Description

Domain name for API request: clb.tencentcloudapi.com.

This API is used to modify forwarding weights of real servers bound to CLB listeners in batches. Up to 500 servers can be unbound in a batch. As this API is async, you should check whether the task is successful by passing the RequestId returned to the API call DescribeTaskStatus.
This API is supported by CLB layer-4 and layer-7 listeners, but not Classis CLB counterparts.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: BatchModifyTargetWeight.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String CLB instance ID
ModifyList.N Yes Array of RsWeightRule List of weights to be modified in batches

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying real server weights in batches

This example shows you how to modify the weight of the real server ins-19404pl5 (port 110) bound to the forwarding rule loc-o8cnyw6c under the listener lbl-4b5hnc9a in the CLB instance lb-dx98lwo0 to 50, and modify the weight of the real server ins-19411tzv (port 80) bound to the forwarding rule loc-8c5pdrb8 under the listener lbl-20jjtaaw to 30.

Input Example

https://clb.tencentcloudapi.com/?Action=BatchModifyTargetWeight
&LoadBalancerId=lb-dx98lwo0
&ModifyList.0.ListenerId=lbl-4b5hnc9a
&ModifyList.0.LocationId=loc-o8cnyw6c
&ModifyList.0.Targets.0.InstanceId=ins-19404pl5
&ModifyList.0.Targets.0.Port=110
&ModifyList.0.Targets.0.Weight=50
&ModifyList.1.ListenerId=lbl-20jjtaaw
&ModifyList.1.LocationId=loc-8c5pdrb8
&ModifyList.1.Targets.0.InstanceId=ins-19411tzv
&ModifyList.1.Targets.0.Port=80
&ModifyList.1.Targets.0.Weight=30
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "83329908-a282-4f9f-8ab-031a3025b377"
  }
}

Example2 Batch modifying the weights of servers bound to layer-4 and layer-7 listeners

This example shows you how to modify the weights of servers for the layer-4 and layer-7 listeners under a CLB instance at the same time.

Input Example

https://clb.tencentcloudapi.com/?Action=BatchModifyTargetWeight
&LoadBalancerId=lb-1kkno9qf
&ModifyList.0.ListenerId=lbl-mhtffs09
&ModifyList.0.Targets.0.InstanceId=ins-kjp6cb2f
&ModifyList.0.Targets.0.Port=79
&ModifyList.0.Targets.0.Weight=50
&ModifyList.1.ListenerId=lbl-661zpn3b
&ModifyList.1.LocationId=loc-78p1r0vb
&ModifyList.1.Targets.0.EniIp=10.202.0.96
&ModifyList.1.Targets.0.Port=123
&ModifyList.1.Targets.0.Weight=30
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "38bab2ce-616d-412c-a4b0-36110d5b17a3"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Length Wrong parameter length.
UnauthorizedOperation Unauthorized operation.