1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (ModifyTargetWeight) is used to modify the forwarding weight of a real server bound to a CLB instance.
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 18:07:01.
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: ModifyTargetWeight |
| 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-cuxwji93 |
| ListenerId | Yes | No | String | CLB listener ID Example: lbl-d1ubji93 |
| LocationId | No | No | String | Forwarding rule ID. When binding a real server to a layer-7 forwarding rule, you must provide either this parameter or Domain+Url. Example: loc-fi8gji93 |
| Domain | No | No | String | Domain name of the target rule. This parameter will not take effect when the LocationId parameter is provided. Example: www.new.example.com |
| Url | No | No | String | The URL of the target rule. This parameter will not take effect when the LocationId parameter is provided. Example: /index |
| Targets | Yes | No | Array of Target | The list of real servers for which the weights are to be modified Example:View |
| Weight | No | No | Int64 | New forwarding weight of a real server. Value range: 0-100. Default: 10. This parameter will not take effect when the Targets.Weight parameter is provided. Example: 8 |
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. |