1. 接口描述
接口请求域名： mna.tencentcloudapi.com 。
获取单设备的实时流量统计指标
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetNetMonitor。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-19。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| DeviceId | 是 | String | 设备id 示例值："mna-xxx" |
| BeginTime | 是 | Integer | 开始时间 示例值：1662622200 |
| EndTime | 是 | Integer | 结束时间 示例值：1662624800 |
| Metrics | 是 | String | 统计指标（上行速率："TxRate":bit/s，下行速率："RxRate":bit/s，丢包："Loss":%，时延："RTT":ms） 示例值："TxRate" |
| GatewayType | 否 | Integer | 网关类型。0：公有云网关；1：自有网关。不传默认为0。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MonitorData | Array of MonitorData | 监控数据 |
| AccessRegion | String | 接入区域。取值范围：['MC','AP','EU','AM'] MC=中国大陆 AP=亚太 EU=欧洲 AM=美洲 示例值：MC |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取流量监控信息
获取流量监控信息
输入示例
POST / HTTP/1.1
Host: mna.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetNetMonitor
<公共请求参数>
{
"Metrics": "TxRate",
"EndTime": 1662624800,
"DeviceId": "mna-xxx",
"BeginTime": 1662622200
}输出示例
{
"Response": {
"MonitorData": [
{
"Time": "1673601780",
"BusinessMetrics": 492350276.319998,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 27582845.919998
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 395158790.239997
}
]
},
{
"Time": "1673601840",
"BusinessMetrics": 412655416,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 27228367.066665
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 397505721.866666
}
]
},
{
"Time": "1673601900",
"BusinessMetrics": 411823866.666665,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 28047154.266665
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 396059005.333333
}
]
},
{
"Time": "1673601960",
"BusinessMetrics": 412108687.733331,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 29244132.933331
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 395156858.266664
}
]
},
{
"Time": "1673602020",
"BusinessMetrics": 412778279.866666,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 26898350.666666
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 398191465.733331
}
]
},
{
"Time": "1673602080",
"BusinessMetrics": 412630582.533333,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 28580784.266665
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 396357362.933332
}
]
},
{
"Time": "1673602140",
"BusinessMetrics": 412431913.466665,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 27329174.8
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 397404181.866666
}
]
},
{
"Time": "1673602200",
"BusinessMetrics": 410982346.266665,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 29038580.399999
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 394201611.866666
}
]
},
{
"Time": "1673602260",
"BusinessMetrics": 409923330.933332,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 28212205.599999
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 393937825.066666
}
]
},
{
"Time": "1673602320",
"BusinessMetrics": 353662726.399999,
"SlotNetInfo": [
{
"NetInfoName": "eth0",
"PublicIP": "9.223.110.232",
"Current": 25376171.542857
},
{
"NetInfoName": "eth1",
"PublicIP": "9.223.96.218",
"Current": 338834939.199999
}
]
}
],
"AccessRegion": "MC",
"RequestId": "odgadasd-dasdasd-dadsada"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.ControlRequestError | 请求控制器发生错误。 |
| InternalError.NetworkInfoRequestError | 智研流量数据请求错误。 |
| InvalidParameterValue | 参数取值错误。 |
