Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeRealServersStatus

Last updated: 2020-07-24 15:09:13

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (DescribeRealServersStatus) is used to query whether an origin server has been bound to a rule or listener.

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: DescribeRealServersStatus.
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.
RealServerIds.N	Yes	Array of String	List of origin server IDs

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Quantity of origin server query results returned
RealServerStatusSet	Array of RealServerStatus	Binding status list of 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 Binding Status of the Origin Server

Query the binding status of the origin server.

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeRealServersStatus
&RealServerIds.0=rs-4ftghy6
&<Common request parameters>

Output Example

{
  "Response": {
    "RealServerStatusSet": [
      {
        "RealServerId": "rs-4ftghy6",
        "BindStatus": 0,
        "ProxyId": "link-asfke"
      }
    ],
    "TotalCount": 1,
    "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
  }
}

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.

API 3.0 Explorer

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.RealServerNotInProject	The origin server do not belong to this project.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
InvalidParameterValue.RealServerNotBelong	The origin server does not belong to this user.
MissingParameter	Parameter missing
ResourceNotFound	Resource does not exist