PrevNext
search by keyword

Recent Pages

Documentation
Documentation

DescribeListenerRealServers

Last updated: 2021-10-08 15:10:59

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: 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

3. Output Parameters

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.

4. Example

Example1 Querying the origin server list of a layer-4 listener

This example shows you how to query the origin server list of a layer-4 listener.

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeListenerRealServers
&ListenerId=listener-pbsgn7ej
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "RealServerSet": [
      {
        "ProjectId": 1,
        "RealServerId": "xx",
        "RealServerName": "xx",
        "RealServerIP": "xx"
      },
      {
        "ProjectId": 1,
        "RealServerId": "xx",
        "RealServerName": "xx",
        "RealServerIP": "xx"
      }
    ],
    "BindRealServerTotalCount": 1,
    "RequestId": "xx",
    "BindRealServerSet": [
      {
        "RealServerStatus": 1,
        "RealServerPort": 80,
        "RealServerId": "xx",
        "DownIPList": [
          "1.1.1.1"
        ],
        "RealServerWeight": 0,
        "RealServerIP": "xx"
      }
    ]
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
FailedOperation Operation failed.
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.
tencent
Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy