tencent cloud

Feedback

BatchRegisterTargets

Last updated: 2022-06-01 18:41:50

1. API Description

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

This API is used to batch bind backend targets.

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: 2019-07-19.
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 Bound targets

3. Output Parameters

Parameter Name Type Description
FailListenerIdSet Array of String IDs of the listeners failed to be bound. If this parameter is empty, all listeners have been 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.

4. Example

Example1 Batch binding backend targets

Input Example

https://ecm.tencentcloudapi.com/?Action=BatchRegisterTargets
&LoadBalancerId=lb-xxxx
&Targets.0.ListenerId=lbl-xxxx
&Targets.0.InstanceId=ein-xxx
&Targets.0.Port=80
&Targets.0.Weight=10
&<Common request parameters>

Output Example

{
  "Response": {
    "FailListenerIdSet": [
      "xx"
    ],
    "RequestId": "a2764f3c-f173-421c-8e42-7b1e7a608a33"
  }
}

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

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.InternalOperationFailure Internal error.
InvalidParameter.FormatError The parameter format is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameter.LBIdNotFound The CLB instance ID is incorrect.
InvalidParameter.ListenerIdNotFound The listener ID is incorrect.
InvalidParameter.LocationNotFound No eligible forwarding rules were found.
InvalidParameter.PortCheckFailed Listener port check failed due to a port conflict.
InvalidParameter.ProtocolCheckFailed Listener protocol check failed, because this operation is not supported by the protocol.
InvalidParameter.RegionNotFound The region is invalid.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.Length The parameter length is incorrect.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this 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