tencent cloud

Feedback

DescribePeakNetworkOverview

Last updated: 2022-06-01 18:41:26

1. API Description

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

This API is used to get the peak network data.

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: DescribePeakNetworkOverview.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
StartTime No String Start time (xxxx-xx-xx), such as 2019-08-14. It is 7 days ago by default and should not be more than 30 days ago.
EndTime No String End time (xxxx-xx-xx), such as 2019-08-14. It is yesterday by default and should not be more than 30 days ago. When the time period between the start time and end time is within 1 day, data at the 1-minute granularity will be returned; when the time period is within 7 days, data at the 5-minute granularity will be returned; otherwise, data at the 1-hour granularity will be returned.
Filters.N No Array of Filter Filter.

region String Required: no (Filter) Filter by region. Fuzzy match is not supported. Note: you need to enter the ECM region to be queried before data can be returned.
area String Required: no (Filter) Filter by region. Fuzzy match is not supported. Regions include china-central, china-east, etc. You can call DescribeNode to get the information of all regions. You can also use ALL_REGION to indicate all regions.
isp String Required: no (Filter) Filter region traffic by ISP. ISPs include CTCC, CUCC, and CMCC. This parameter must be used together with area, and you can specify only one ISP at a time.

You can specify either region or area.
Period No Integer Statistical period in seconds. Valid values: 60, 300.

3. Output Parameters

Parameter Name Type Description
PeakNetworkRegionSet Array of PeakNetworkRegionInfo Array of network peaks.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting peak network data

This example shows you how to get the peak network data.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribePeakNetworkOverview
&StartTime=2020-09-04
&EndTime=2020-09-04
&Filters.0.Name=region
&Filters.0.Values.0=ap-zhengzhou-ecm
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "ee2849f2-facd-4f84-a0ab-bec49edda5fc",
    "PeakNetworkRegionSet": [
      {
        "PeakNetworkSet": [
          {
            "PeakInNetwork": "31467.2",
            "RecordTime": "2020-09-04 00:00:00",
            "PeakOutNetwork": "32461.6"
          },
          {
            "PeakInNetwork": "25255.2",
            "RecordTime": "2020-09-04 00:05:00",
            "PeakOutNetwork": "31626.4"
          },
          {
            "PeakInNetwork": "24559.2",
            "RecordTime": "2020-09-04 00:10:00",
            "PeakOutNetwork": "30908.0"
          },
          {
            "PeakInNetwork": "24356.8",
            "RecordTime": "2020-09-04 00:15:00",
            "PeakOutNetwork": "31393.6"
          },
          {
            "PeakInNetwork": "28112.0",
            "RecordTime": "2020-09-04 00:20:00",
            "PeakOutNetwork": "33372.0"
          },
          {
            "PeakInNetwork": "28352.8",
            "RecordTime": "2020-09-04 00:25:00",
            "PeakOutNetwork": "32520.0"
          },
          {
            "PeakInNetwork": "25950.4",
            "RecordTime": "2020-09-04 00:30:00",
            "PeakOutNetwork": "30731.2"
          },
          {
            "PeakInNetwork": "29326.4",
            "RecordTime": "2020-09-04 00:35:00",
            "PeakOutNetwork": "39581.6"
          },
          {
            "PeakInNetwork": "30898.4",
            "RecordTime": "2020-09-04 00:40:00",
            "PeakOutNetwork": "40880.8"
          },
          {
            "PeakInNetwork": "30900.8",
            "RecordTime": "2020-09-04 00:45:00",
            "PeakOutNetwork": "35427.2"
          },
          {
            "PeakInNetwork": "31771.2",
            "RecordTime": "2020-09-04 00:50:00",
            "PeakOutNetwork": "37540.0"
          }
        ],
        "Region": "ap-zhengzhou-ecm"
      }
    ]
  }
}

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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidFilter The filter is invalid.
InvalidParameterValue.InvalidTime The time is invalid.
MissingParameter.MissingOverViewParameter The request parameters required to get the configuration of the overview page are incomplete.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support