Documentation|Tencent Cloud

Recent Pages

BindListenerRealServers

Last updated: 2020-07-24 15:09:20

1. API Description

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

This API (BindListenerRealServers) is used for the TCP/UDP listener to bind/unbind the origin server.
Note: This API unbinds the previously bound origin servers, and binds the origin servers selected for this call. For example, the previously bound origin servers are A, B and C, and the origin servers selected for this call are C, D and E, then the origin servers bound after this call will be C, D and E.

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 parameter. The value used for this API: BindListenerRealServers.
Version	Yes	String	Common parameter. The value used for this API: 2018-05-29.
Region	No	String	Common parameter. This parameter is not required for this API.
ListenerId	Yes	String	Listener ID
RealServerBindSet.N	No	Array of RealServerBindSetReq	List of origin servers to be bound. If the origin server scheduling policy type of this listener is weighted round robin, you need to enter the `RealServerWeight`, i.e., the origin server weight. If this field is left empty or for other scheduling types, the default origin server weight is 1.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Binding Listeners to the Origin Server

Bind a listener to an origin server.

Input Example

https://gaap.tencentcloudapi.com/?Action=BindListenerRealServers
&ListenerId=listener-pbsgn7ej
&RealServerBindSet.0.RealServerId=rs-04v3s12t
&RealServerBindSet.0.RealServerIP=119.28.69.101
&RealServerBindSet.0.RealServerPort=80
&RealServerBindSet.0.RealServerWeight=1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1f1e794d-a35e-41d2-8f40-fe32a2077329"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

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.GroupStatusNotInRuning	Unable to operate: the connection group is not running.
FailedOperation.InstanceStatusNotInRuning	Unable to operate: the connection is not running.
FailedOperation.LimitRealServerNum	Limit on the number of bound origin servers exceeded.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
InvalidParameterValue.RealServerNotBelong	The origin server does not belong to this user.
MissingParameter	Parameter missing
ResourceNotFound	Resource does not exist
UnauthorizedOperation	Unauthorized operation