DescribeRealServers

Recent Pages

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

1. API Description

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

This API is used to query origin server information. It can query all origin servers under the specified project name, and supports fuzzy query by specified IPs or domain names.

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: DescribeRealServers.
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.
ProjectId	Yes	Integer	Queries the project ID to which the origin server belongs. -1: all projects.
SearchValue	No	String	Origin server IP or domain name to be queried. The fuzzy match is supported.
Offset	No	Integer	Offset, which is 0 by default.
Limit	No	Integer	Quantity of values to return. The default value is 20 and the maximum value is 50.
TagSet.N	No	Array of TagPair	Tag list. If this field exists, the list of the resources with the tag will be pulled. It supports up to 5 tags. If there are two or more tags, the origin servers tagged any of them will be pulled.
Filters.N	No	Array of Filter	Filter conditions. The value of the `name` of the `filter` (RealServerName, RealServerIP)

3. Output Parameters

Parameter Name	Type	Description
RealServerSet	Array of BindRealServerInfo	An information list of origin server
TotalCount	Integer	The quantity 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 origin server information

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeRealServers
&ProjectId=0
&SearchValue='1.1.1.1'
&<Common request parameters>

Output Example

{
  "Response": {
    "RealServerSet": [
      {
        "RealServerId": "rs123",
        "RealServerIP": "1.1.1.1",
        "RealServerName": "rsname",
        "ProjectId": 0,
        "TagSet": []
      }
    ],
    "TotalCount": 1,
    "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
  }
}

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

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
AuthFailure.NotEnterpriseAuthorization	Not an organizational customer.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameterValue	Incorrect parameter value.
MissingParameter	Missing parameter.
ResourceUnavailable	The resource is unavailable.
ResourceUnavailable.AccountViolation	Restricted resources found in your account. Check your inbox and email for details.
UnknownParameter	Unknown parameter.

Recent Pages