Domain name for API request: gaap.tencentcloudapi.com.
This API (DescribeRuleRealServers) is used to query forwarding rules-related origin server information, including information of origin servers that can be bound and have been bound.
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 Params. The value used for this API: DescribeRuleRealServers. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
RuleId | Yes | String | Forwarding rule ID |
Offset | No | Integer | Offset. Default value: 0. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 1000. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Quantity of origin servers that can be bound |
RealServerSet | Array of RealServer | Information list of origin servers that can be bound |
BindRealServerTotalCount | Integer | Quantity of bound origin servers |
BindRealServerSet | Array of BindRealServer | Bound origin server information list |
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 query the origin server information of forwarding rules.
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleRealServers
<Common request parameters>
{
"RuleId": "rule-hh5xg2yd"
}
{
"Response": {
"TotalCount": 1,
"RealServerSet": [
{
"ProjectId": 1,
"RealServerId": "xx",
"InBanBlacklist": 0,
"RealServerName": "xx",
"RealServerIP": "xx"
},
{
"ProjectId": 1,
"RealServerId": "xx",
"InBanBlacklist": 0,
"RealServerName": "xx",
"RealServerIP": "xx"
}
],
"BindRealServerTotalCount": 1,
"RequestId": "xx",
"BindRealServerSet": [
{
"RealServerStatus": 1,
"RealServerPort": 234,
"RealServerId": "xx",
"RealServerFailoverRole": "xx",
"DownIPList": [
"xx"
],
"RealServerWeight": 1,
"RealServerIP": "xx"
},
{
"RealServerStatus": 1,
"RealServerPort": 424,
"RealServerId": "xx",
"RealServerWeight": 1,
"RealServerFailoverRole": "xx",
"DownIPList": [
"xx"
],
"RealServerIP": "xx"
}
]
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
FailedOperation | Operation failed. |
FailedOperation.ResourceUpgrading | The resource is being upgraded. |
FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
Was this page helpful?