1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
获取网络峰值数据
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePeakNetworkOverview。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| StartTime | 否 | String | 开始时间（xxxx-xx-xx）如2019-08-14，默认为一周之前的日期，不应与当前日期间隔超过30天。 示例值：2019-08-14 |
| EndTime | 否 | String | 结束时间（xxxx-xx-xx）如2019-08-14，默认为昨天，不应与当前日期间隔超过30天。当开始与结束间隔不超过1天时会返回1分钟粒度的数据，不超过7天时返回5分钟粒度的数据，否则返回1小时粒度的数据。 示例值：2019-08-14 |
| Filters.N | 否 | Array of Filter | 过滤条件。 region String 是否必填：否 （过滤条件）按照region过滤，不支持模糊匹配。注意 region 填上需要查询ecm region才能返回数据。 area String 是否必填：否 （过滤条件）按照大区过滤，不支持模糊匹配。大区包括：china-central、china-east等等，可以通过DescribeNode获得所有大区；也可使用ALL_REGION表示所有地区。 isp String 是否必填：否 （过滤条件）按照运营商过滤大区流量，运营商包括CTCC、CUCC和CMCC。只和area同时使用，且一次只能指定一种运营商。 region和area只应填写一个。 示例值：Filters |
| Period | 否 | Integer | 统计周期，单位秒。取值60/300。 示例值：30 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PeakNetworkRegionSet | Array of PeakNetworkRegionInfo | 网络峰值数组。 注意：此字段可能返回 null，表示取不到有效值。 示例值：PeakNetworkRegionSet |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取网络峰值数据
获取网络峰值数据
输入示例
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
&<公共请求参数>输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue.FilterLimitExceeded | Filter参数数值超过限制。 |
| InvalidParameterValue.InvalidFilter | 无效过滤器。 |
| InvalidParameterValue.InvalidTime | 时间不合法。 |
| MissingParameter.MissingOverViewParameter | 获取概览页配置请求参数不全。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |