BindRuleRealServers
Last updated: 2019-11-25 22:41:51
Contents：
1. API Description
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.
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: 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. |
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 Forwarding Rules to the Origin Server
Bind forwarding rules to an origin server.
Input Example
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>Output Example
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}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.
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.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. |
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Parameter value error |
| MissingParameter | Parameter missing |
| ResourceNotFound | Resource does not exist |
| UnauthorizedOperation | Unauthorized operation |
