CLB Release Notes
Product Announcements
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.
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: RegisterTargets. |
| 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 |
| ListenerId | Yes | String | CLB listener ID |
| Targets.N | Yes | Array of Target | List of real servers to be bound. Array length limit: 20. |
| LocationId | No | String | Specifies the forwarding rule ID, which can be obtained through the DescribeListeners API (https://www.tencentcloud.com/document/product/214/30686?from_cn_redirect=1). you must provide this parameter or either Domain or Url when binding a backend service to a layer-7 forwarding rule. |
| Domain | No | String | Target forwarding rule domain name. This parameter does not take effect if LocationId is specified. |
| Url | No | String | Target forwarding rule URL. This parameter does not take effect if LocationId is specified. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
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
}
]
}{
"Response": {
"RequestId": "898b431c-2745-4b27-80f6-e6e8038a0683"
}
}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
}
]
}{
"Response": {
"RequestId": "d4846a22-e758-407f-a526-db3f2d37d00e"
}
}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
}
]
}{
"Response": {
"RequestId": "11b4338f-2d00-4766-bc67-581d959b3488"
}
}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. |
| FailedOperation.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Wrong parameter format. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.Duplicate | Duplicate parameter value. |
| InvalidParameterValue.Length | Wrong parameter length. |
| LimitExceeded | Quota exceeded. |
| MissingParameter | Missing parameter. |
| ResourceInsufficient | Insufficient resources. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback