Domain name for API request: gaap.intl.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 Params. The value used for this API: DescribeListenerRealServers. |
| Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
| Region | No | String | Common Params. This parameter is not required. |
| 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. |
This example shows you how to query the origin server list of a layer-4 listener.
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerRealServers
<Common request parameters>
{
"ListenerId": "listener-pbsgn7ej"
}{
"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": 80,
"RealServerId": "xx",
"RealServerFailoverRole": "xx",
"DownIPList": [
"1.1.1.1"
],
"RealServerWeight": 0,
"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.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. |
| UnauthorizedOperation | Unauthorized operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários