1. API Description

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

This API is used to bind one or more backend services to a Cloud Load Balancer listener or layer-7 forwarding rule. Before that, you need to create a related CLB layer-4 listener or layer-7 forwarding rule. For Layer-4 listeners (TCP/UDP), only specify the listener ID. For layer-7 (HTTP/HTTPS) listeners, forwarding rules must be specified through LocationId or Domain+Url.
This API is used to perform asynchronous operations. After it returns a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Registering CVM to a TCP Listener

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterTargets
<Common request parameters>

{
    "LoadBalancerId": "lb-cuxw2rm0",
    "ListenerId": "lbl-d1ubsydq",
    "Targets": [
        {
            "InstanceId": "ins-dm4xtz0i",
            "Port": 233,
            "Weight": 10
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "898b431c-2745-4b27-80f6-e6e8038a0683"
    }
}

Example2 Registering CVM to the Forwarding Rule of an HTTP Listener (with the Rule Specified by LocationId)

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterTargets
<Common request parameters>

{
    "LoadBalancerId": "lb-cuxw2rm0",
    "ListenerId": "lbl-d1ubsydq",
    "LocationId": "loc-r2q3jd4c",
    "Targets": [
        {
            "InstanceId": "ins-dm4xtz0i",
            "Port": 233,
            "Weight": 10
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "d4846a22-e758-407f-a526-db3f2d37d00e"
    }
}

Example3 Registering CVM to the Forwarding Rule of an HTTP Listener (with the Rule Specified by Domain and Url)

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterTargets
<Common request parameters>

{
    "LoadBalancerId": "lb-cuxw2rm0",
    "ListenerId": "lbl-d1ubsydq",
    "Domain": "foo.net",
    "Url": "/bar8",
    "Targets": [
        {
            "InstanceId": "ins-dm4xtz0i",
            "Port": 233,
            "Weight": 10
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "11b4338f-2d00-4766-bc67-581d959b3488"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.