Domain name for API request: clb.intl.tencentcloudapi.com.
The BatchModifyTargetWeight API is used to modify the forwarding weight of backend machines bound to a Cloud Load Balancer listener in batch. The resource limit is 500. This is an async API. After it returns a successful result, call DescribeTaskStatus API with the returned RequestID as input parameter to check whether this task is successful.
This API is supported by layer-4 and layer-7 CLB listeners but not by classic CLB.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: BatchModifyTargetWeight. |
| Version | Yes | String | Common Params. The value used for this API: 2023-04-17. |
| Region | Yes | String | Common Params. 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. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to modify the weight of the RS ins-19404pl5 (port 110) bound to the forwarding rule loc-o8cnyw6c under the listener lbl-4b5hnc9a to 50 and modify the weight of the RS ins-19411tzv (port 80) bound to the forwarding rule loc-8c5pdrb8 under the listener lbl-20jjtaaw to 30 for the CLB instance (lb-dx98lwo0).
https://clb.intl.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>
{
"Response": {
"RequestId": "83329908-a282-4f9f-8ab-031a3025b377"
}
}
This example shows you how to modify the weights of servers bound to both layer-4 and layer-7 listeners of a CLB instance.
https://clb.intl.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=80
&ModifyList.1.Targets.0.Weight=30
&<Common request parameters>
{
"Response": {
"RequestId": "38bab2ce-616d-412c-a4b0-36110d5b17a3"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter format. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Length | Invalid parameter length. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック