tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeRealServerStatistics

最后更新时间：2023-05-04 10:13:18

1. API Description

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

This API is used to query the statistics of an origin server's health check results. Origin server status is displayed as 1 (normal) or 0 (exceptional). The queried origin server must be bound to a listener or rule, and the ID of the bound listener or rule must be specified for the query. This API supports displaying origin server status statistics at a 1-minute granularity.

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: DescribeRealServerStatistics.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required for this API.
RealServerId Yes String Origin server ID
ListenerId No String Listener ID
RuleId No String Layer-7 rule ID
WithinTime No Integer Statistics duration. Unit: hours. It only supports querying statistics for the past 1, 3, 6, 12, and 24 hours.
StartTime No String Statistics start time, such as 2020-08-19 00:00:00
EndTime No String Statistics end time, such as 2020-08-19 23:59:59
Granularity No Integer Statistics granularity in seconds. Only 1-minute (60-second) and 5-minute (300-second) granularities are supported.

3. Output Parameters

Parameter Name Type Description
StatisticsData Array of StatisticsDataInfo Origin server status statistics of specified listener
RsStatisticsData Array of MetricStatisticsInfo Status statistics of multiple 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 health check result of the bound origin server

This example shows you how to query the health check results of the bound origin server.

Input Example

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

{
    "WithinTime": "3",
    "RealServerId": "rs-rfgt56hy",
    "ListenerId": "listener-gucvb6d"
}

Output Example

{
    "Response": {
        "RsStatisticsData": [
            {
                "MetricData": [
                    {
                        "Data": 0.0,
                        "Time": 1
                    },
                    {
                        "Data": 0.0,
                        "Time": 1
                    }
                ],
                "MetricName": "xx"
            },
            {
                "MetricData": [
                    {
                        "Data": 0.0,
                        "Time": 1
                    },
                    {
                        "Data": 0.0,
                        "Time": 1
                    }
                ],
                "MetricName": "xx"
            }
        ],
        "RequestId": "xx",
        "StatisticsData": [
            {
                "Data": 0.0,
                "Time": 1
            }
        ]
    }
}

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.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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款