BatchRegisterTargets

Last updated: 2025-11-25 10:11:34

BatchRegisterTargets

Last updated: 2025-11-25 10:11:34

1. API Description

Domain name for API request: clb.intl.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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId	Yes	String	CLB instance ID
Targets.N	Yes	Array of BatchTarget	Binding target

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.
Message	String	Information of the binding failure cause.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Binding a Cloud Host or Elastic Network Interface

Input Example

POST / HTTP/1.1
Host: clb.intl.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"
}

Output Example

{
    "Response": {
        "FailListenerIdSet": [],
        "Message": "",
        "RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.
FailedOperation.ResourceInOperating	The specified resource is currently being operated. Please try again later.
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.
UnauthorizedOperation	Unauthorized operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud