Domain name for API request: gaap.tencentcloudapi.com.
This API is used to bind an origin server to the forwarding rules of layer-7 listeners. Note: This API unbinds all previously bound origin servers before binding those selected.
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: BindRuleRealServers. |
| 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. |
| RuleId | Yes | String | Forwarding rule ID |
| RealServerBindSet.N | No | Array of RealServerBindSetReq | An information list of the origin servers to bind. If there are origin servers bound already, they will be replaced by this new origin server list. If this field is empty, it indicates unbinding all origin servers of this rule. If the origin server scheduling policy type of this rule is weighted round robin, you need to enter 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 forwarding rule to origin servers.
https://gaap.tencentcloudapi.com/?Action=BindRuleRealServers
&RuleId=0
&RealServerBindSet.0.RealServerId=rs-i3658cdf
&RealServerBindSet.0.RealServerPort=80
&RealServerBindSet.0.RealServerIP=1.1.1.1
&RealServerBindSet.0.RealServerWeight=1
&<Common request parameters>{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}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.DomainStatusNotInRunning | Operation unavailable: the domain name is not running. |
| FailedOperation.InstanceStatusNotInRuning | Unable to operate: the connection is not running. |
| FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
| FailedOperation.ListenerStatusError | The listener does not support this operation in current status. |
| FailedOperation.NotSupportProxyGroup | This operation is not supported for connection groups. |
| 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?