1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API is used to batch bind CVM instances or ENIs. Up to 500 resources can be bound in a batch. It supports cross-region binding and binding based on layer-4 and layer-7 (TCP/UDP/HTTP/HTTPS) protocols. It supports VPC-based CLB instances only.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-07-28 10:21:19.
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: BatchRegisterTargets |
| 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 ID. Example: lb-j3ix99s2 |
| Targets | Yes | No | Array of BatchTarget | Bound targets. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| FailListenerIdSet | Array of String | ID of the listener failed to bind. Empty indicates all listeners are bound successfully. Example: ["lbl-4ibsji93"] |
| 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 |
| LimitExceeded | Quota limit reached |
| FailedOperation | Failed to operate. |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameter.ListenerIdNotFound | Listener ID error. |
| InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
| InvalidParameter.PortCheckFailed | Listener port check due to port conflicts or other reasons. |
| InvalidParameter.ProtocolCheckFailed | Listener protocol check failed because, for example, the protocol used is incompatible with the corresponding operation. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |
| InvalidParameter.RegionNotFound | Invalid region. |
| MissingParameter | Missing parameter error. |