tencent cloud



Last updated: 2023-08-18 14:28:04

1. API Description

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

This API is used to get the monthly peak and billable inbound/outbound bandwidth values of your node.

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: DescribeMonthPeakNetwork.
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.
Month Yes String Month (xxxx-xx), such as 2021-03. Default value: the last month
Filters.N No Array of Filter Filter

3. Output Parameters

Parameter Name Type Description
MonthNetWorkData Array of MonthNetwork None
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 the bandwidth information of specified month

This example shows you how to get the bandwidth information of the specified month.

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "ee2849f2-facd-4f84-a0ab-bec49edda5fc",
        "MonthNetWorkData": [
                "ZoneInfo": {
                    "ZoneId": "490001",
                    "ZoneName": "Nanjing",
                    "Zone": "ap-nanjing-ecm-1"
                "Month": "202001",
                "BandwidthPkgId": "bwp-mm9aw7jq",
                "Isp": "CMCC",
                "TrafficMaxIn": 12.345,
                "TrafficMaxOut": 12.345,
                "FeeTraffic": 12.345,
                "StartTime": "2021-03-01 00:00:00",
                "EndTime": "2021-03-29 23:59:59",
                "EffectiveDays": 2,
                "MonthDays": 30,
                "EffectiveDaysRate": 12.34

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.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InvalidISPInNode The ISP is invalid.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.Malformed The input parameter format is invalid.
InvalidParameterValue.TooLong The parameter value is too long.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation Unsupported 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