1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API is used to modify the attributes of a CLB instance, such as name and cross-region attributes.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-09-04 14:41:39.
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: ModifyLoadBalancerAttributes |
| 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 | Unique ID of CLB Example: lb-6efswuxa |
| LoadBalancerName | No | No | String | CLB Instance Name Example: newlbname |
| TargetRegionInfo | No | No | TargetRegionInfo | Geographical information of the real server bound to CLB Example:View |
| InternetChargeInfo | No | No | InternetAccessible | A network billing parameter Example:View |
| LoadBalancerPassToTarget | No | No | Bool | Whether to allow CLB traffic to the target. True: Allow CLB traffic to the target and verify security groups only on CLB. False: Deny CLB traffic to the target and verify security groups on both CLB and backend instances. Example: true |
| ChargeType | No | No | String | Billing type of the CLB instance, Postpaid: POSTPAID_BY_HOUR; Prepaid: PREPAID. Example: POSTPAID_BY_HOUR |
| SwitchFlag | No | No | Uint64 | Switch between different billing modes. 0: No switch; 1: Switch between prepaid and postpaid options; 2: Switch between postpaid options. Default: 0 Example: 0 |
| PrepaidInfo | No | No | LBChargePrepaid | Prepaid billing attributes of a CLB instance Example:View |
| ExclusiveCluster | No | No | ExclusiveCluster | Layer-7 cluster list Example:View |
| SnatPro | No | No | Bool | Whether to enable the feature of cross-region binding 2.0. (This parameter is not supported on Private Cloud.) Example: false |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| DealName | String | When switching the billing mode for CLB, you can use this parameter to check if the switch task is successful. Example: null |
| 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 |
|---|---|
| LimitExceeded | Quota limit reached |
| MissingParameter | Missing parameter error. |
| FailedOperation | Failed to operate. |
| InvalidParameter | Wrong parameter. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameterValue.Duplicate | Duplicate parameter values. |
| ResourceInsufficient | Insufficient resources |
| UnauthorizedOperation | Unauthorized operation |
| InternalError | Internal Error |
| InvalidParameterValue | Incorrect parameter value |
| InvalidParameterValue.Length | Invalid parameter length. |
| InvalidParameter.RegionNotFound | Invalid region. |