根据设备名获取流量监控信息

最近更新时间:2026-01-26 01:33:00

我的收藏

1. 接口描述

接口请求域名: mna.tencentcloudapi.com 。

获取单设备的实时流量统计指标

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetNetMonitorByName。
Version String 公共参数,本接口取值:2021-01-19。
Region String 公共参数,本接口不需要传递此参数。
DeviceName String 设备名
示例值:"devicexxx"
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 根据DeviceName(testdev)获取流量监控信息

输入示例

POST / HTTP/1.1
Host: mna.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetNetMonitorByName
<公共请求参数>

{
    "DeviceName": "testdev",
    "BeginTime": 1758545194,
    "EndTime": 1758545494,
    "Metrics": "RxRate"
}

输出示例

{
    "Response": {
        "AccessRegion": "MC",
        "MonitorData": [
            {
                "BusinessMetrics": 158.133333,
                "SlotNetInfo": [
                    {
                        "Current": 7104.8,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": 7331.466667,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545160"
            },
            {
                "BusinessMetrics": 1329.733333,
                "SlotNetInfo": [
                    {
                        "Current": 7064.666667,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": 8696.8,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545220"
            },
            {
                "BusinessMetrics": 497.466667,
                "SlotNetInfo": [
                    {
                        "Current": 7428.4,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": 7513.066667,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545280"
            },
            {
                "BusinessMetrics": 1156.933333,
                "SlotNetInfo": [
                    {
                        "Current": 9330.933333,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": 8388.133333,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545340"
            },
            {
                "BusinessMetrics": 3181.866667,
                "SlotNetInfo": [
                    {
                        "Current": 8754,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": 9718.666667,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545400"
            },
            {
                "BusinessMetrics": -1,
                "SlotNetInfo": [
                    {
                        "Current": -1,
                        "NetInfoName": "rmnet_data5",
                        "PublicIP": "123.138.183.224:34771"
                    },
                    {
                        "Current": -1,
                        "NetInfoName": "wlan0",
                        "PublicIP": "113.142.183.133:37034"
                    }
                ],
                "Time": "1758545460"
            }
        ],
        "RequestId": "09975f22-b4fc-45a6-81d4-67236cb9e867"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.ControlRequestError 请求控制器发生错误。
InternalError.NetworkInfoRequestError 智研流量数据请求错误。
InvalidParameterValue 参数取值错误。