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.
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. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to bind a listener to one or more origin servers.
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
&RealServerBindSet.0.RealServerFailoverRole=master
&<Common request parameters>
{
"Response": {
"RequestId": "1f1e794d-a35e-41d2-8f40-fe32a2077329"
}
}
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.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. |
| FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
| FailedOperation.ProxyStatusNotInRuning | Unable to add listeners: the connection is not running. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.RealServerNotBelong | The origin server does not belong to this user. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?