tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRealServersStatus

Last updated: 2023-07-13 15:25:30

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 Params. The value used for this API: DescribeRealServersStatus.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
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

This example shows you how to query the binding status of the origin server.

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealServersStatus
<Common request parameters>

{
    "RealServerIds": [
        "rs-4ftghy6"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "RealServerStatusSet": [
            {
                "ProxyId": "xx",
                "BindStatus": 0,
                "RealServerId": "xx",
                "GroupId": "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 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.RealServerNotInProject The origin server do not belong to this project.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.RealServerNotBelong The origin server does not belong to this user.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy