1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (BatchModifyTargetWeight) is used to batch modify the forwarding weights of real servers bound to CLB listeners. It is supported by layer-4 and layer-7 CLB listeners, but not by Classic CLB.
This is an async API. After it returns a successful result, you need to call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-04-27 20:46:14.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: BatchModifyTargetWeight |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-03-17 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LoadBalancerId | Yes | No | String | CLB instance ID Example: lb-dx98lwo0 |
| ModifyList | Yes | No | Array of RsWeightRule | List of weights to be modified in batches. For example, "ModifyList": [{"ListenerId": "lbl-di3kx902", "LocationId":"", "Domain": "", "Url": "", "Targets": [{"Type":"CVM", "InstanceId": "ins-xxxxxxx", "Port": "443", "Weight": 10, "EniIp":""}], "Weight": 10}]. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue | Incorrect parameter value |
| InternalError | Internal Error |
| UnauthorizedOperation | Unauthorized operation |
| FailedOperation | Failed to operate. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |