1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (RegisterTargets) is used to bind one or more real servers to a CLB listener (or layer-7 forwarding rule). Before using this API, you need to create a relevant layer-4 listener or layer-7 forwarding rule. For the former (TCP/UDP), only the listener ID needs to be specified, while for the latter (HTTP/HTTPS), the forwarding rule also needs to be specified through LocationId or Domain+Url.
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: 2020-01-10 20:37:04.
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: RegisterTargets |
| 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 forwarding rule. This parameter will not take effect when the LocationId parameter is provided. Example: www.yuncloud.example.com |
| Url | No | No | String | The URL of the target forwarding rule. This parameter will not take effect when the LocationId parameter is provided. Example: /index |
| Targets | Yes | No | Array of Target | List of real servers to be bound. Array length limit: 20 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 |
| ResourceInsufficient | Insufficient resources |
| LimitExceeded | Quota limit reached |
| FailedOperation | Failed to operate. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |
| MissingParameter | Missing parameter error. |