Last updated: 2021-07-12 16:11:11

    1. API Description

    Domain name for API request:

    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 parameter. The value used for this API: DescribeRealServerStatistics.
    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.
    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 statistics of the bound origin server

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

    Input Example
    &<Common request parameters>

    Output Example

    "Response": {
      "StatisticsData": [
      "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"

    5. Developer Resources


    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.