tencent cloud



Last updated: 2022-10-11 11:23:58

1. API Description

Domain name for API request: clb.tencentcloudapi.com.

This API is used to batch unbind real servers of the layer-4 and layer-7 VPC-based CLBs. Up to 500 real servers can be unbound in a batch.

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: BatchDeregisterTargets.
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 Unbinding targets

3. Output Parameters

Parameter Name Type Description
FailListenerIdSet Array of String IDs of the listeners failed to unbind
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Unbinding an ENI

Input Example

Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchDeregisterTargets
<Common request parameters>

    "Targets": [
            "InstanceId": "ins-xxx",
            "ListenerId": "lbl-xxxx",
            "Weight": "10",
            "Port": "80"
    "LoadBalancerId": "lb-xxxx"

Output Example

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

5. Developer Resources


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

Command Line Interface

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.
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.Duplicate Duplicate parameter value.
InvalidParameterValue.Length Wrong parameter length.
InvalidParameterValue.Range Wrong parameter value range.
LimitExceeded Quota exceeded.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resources.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support