Domain name for API request: clb.tencentcloudapi.com.
This API is used to batch bind CVM instances or ENIs. Up to 500 servers can be bound in a batch. It supports cross-region binding, layer-4 and layer-7 (TCP/UDP/HTTP/HTTPS) protocols, and VPC-based CLBs only.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: BatchRegisterTargets. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
LoadBalancerId | Yes | String | CLB instance ID |
Targets.N | Yes | Array of BatchTarget | Binding target |
Parameter Name | Type | Description |
---|---|---|
FailListenerIdSet | Array of String | IDs of the listeners failed to bind. If this is blank, all listeners are bound successfully. Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchRegisterTargets
<Common request parameters>
{
"Targets": [
{
"InstanceId": "ins-xxx",
"ListenerId": "lbl-xxxx",
"Weight": "10",
"Port": "80"
}
],
"LoadBalancerId": "lb-xxxx"
}
{
"Response": {
"FailListenerIdSet": [],
"RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Parameter error. |
InvalidParameter.FormatError | Wrong parameter format. |
InvalidParameter.LBIdNotFound | Wrong CLB instance ID. |
InvalidParameter.ListenerIdNotFound | Wrong listener ID. |
InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
InvalidParameter.PortCheckFailed | Listener port checks failed due to port conflicts or other reasons. |
InvalidParameter.ProtocolCheckFailed | Listener protocol checks failed because the protocol used is incompatible with the corresponding operation. |
InvalidParameter.RegionNotFound | Invalid region. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.Length | Wrong parameter length. |
LimitExceeded | Quota exceeded. |
MissingParameter | Missing parameter. |
ResourceInsufficient | Insufficient resources. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?