International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    DescribeProxyStatistics

    Last updated: 2020-09-25 14:26:35
    Download PDF

    1. API Description

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

    This API is used to query listener statistics, including inbound/outbound bandwidth, inbound/outbound packets, concurrence, packet loss, and latency data. It supports granularities of 300, 3,600, and 86,400. Default value is the highest within the granularity range.

    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: DescribeProxyStatistics.
    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.
    ProxyId Yes String Connection ID
    StartTime Yes Timestamp Start time (2019-03-25 12:00:00)
    EndTime Yes Timestamp End time (2019-03-25 12:00:00)
    MetricNames.N Yes Array of String Statistical metric name list. Values: InBandwidth (inbound bandwidth); OutBandwidth (outbound bandwidth); Concurrent (concurrence); InPackets (inbound packets); OutPackets (outbound packets); PacketLoss (packet loss rate); Latency (latency).
    Granularity Yes Integer Monitoring granularity. It currently supports: 60, 300, 3,600, and 86,400. Unit: seconds.
    Time range: <= 1 day, supported minimum granularity: 60 seconds;
    Time range: <= 7 days, supported minimum granularity: 3,600 seconds;
    Time range: <= 30 days, supported minimum granularity: 86,400 seconds;

    3. Output Parameters

    Parameter Name Type Description
    StatisticsData Array of MetricStatisticsInfo Connection statistics
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying connection statistics

    This example shows you how to query connection statistics.

    Input Example

    https://gaap.tencentcloudapi.com/?Action=DescribeProxyStatistics
&ProxyId=link-rfgt56hy
&MetricNames.0=Concurrent
&StartTime=2019-03-25 12:00:00
&EndTime=2019-03-26 12:00:00
&Granularity=300
&<common request parameters>

    Output Example

    {
  "Response": {
    "StatisticsData": [
      {
        "MetricName": "Concurrent",
        "MetricData": [
          {
            "Time": 1564734780,
            "Data": 2000
          },
          {
            "Time": 1564734720,
            "Data": 2001
          }
        ]
      }
    ],
    "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.

    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
    FailedOperation Operation failed.
    FailedOperation.ResourceCanNotAccess This resource is not accessible.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy