Domain name for API request: gaap.tencentcloudapi.com.
This API (DescribeListenerRealServers) is used to query the origin server list of TCP/UDP listeners, including the list of bound origin servers and origin servers that can be 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 parameter. The value used for this API: DescribeListenerRealServers. |
| 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 |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of origin servers that can be bound |
| RealServerSet | Array of RealServer | An information list of origin servers |
| BindRealServerTotalCount | Integer | Number of bound origin servers |
| BindRealServerSet | Array of BindRealServer | Information list of bound origin servers |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Query an origin server list of a layer-4 listener.
https://gaap.tencentcloudapi.com/?Action=DescribeListenerRealServers
&ListenerId=listener-pbsgn7ej
&<Common request parameters>{
"Response": {
"TotalCount": 2,
"RealServerSet": [
{
"RealServerId": "rs-2k5qnys5",
"RealServerIP": "123.123.123.123",
"RealServerName": "rs_test",
"ProjectId": 0
},
{
"RealServerId": "rs-d5y6ei2u",
"RealServerIP": "118.89.46.86",
"RealServerName": "rs_test-2",
"ProjectId": 0
}
],
"BindRealServerTotalCount": 1,
"BindRealServerSet": [
{
"RealServerId": "rs-d5y6ei2u",
"RealServerIP": "118.89.46.86",
"RealServerWeight": 0,
"RealServerPort": 80,
"RealBindStatus": 0
}
],
"RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Parameter value error |
| MissingParameter | Parameter missing |
| ResourceNotFound | Resource does not exist |
| UnauthorizedOperation | Unauthorized operation |
Was this page helpful?