1. 接口描述
接口请求域名: mna.tencentcloudapi.com 。
获取指定设备Id,指定时间点数据流量使用情况
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetFlowStatistic。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-19。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
DeviceId | 是 | String | 设备ID 示例值:245aee95-f37e-55d0-5258-19520bdf4b53 |
BeginTime | 是 | Integer | 开始查找时间 示例值:1659514436 |
EndTime | 是 | Integer | 截止时间 示例值:1659515436 |
Type | 是 | Integer | 流量种类(1:上行流量,2:下行流量,3:上下行总和) 示例值:1 |
TimeGranularity | 是 | Integer | 时间粒度(1:按小时统计,2:按天统计) 示例值:1 |
AccessRegion | 否 | String | 接入区域。取值范围:['MC','AP','EU','AM'] MC=中国大陆 AP=亚太 EU=欧洲 AM=美洲。不填代表全量区域。 示例值:MC |
GatewayType | 否 | Integer | 网关类型。0:公有云网关;1:自有网关。不传默认为0。 示例值:0 |
DeviceList.N | 否 | Array of String | 设备ID列表,用于查询多设备流量,该字段启用时DeviceId可传"-1" 示例值:["mna-test1","mna-test2"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NetDetails | Array of NetDetails | 流量详细信息 |
MaxValue | Float | 查找时间段流量使用最大值(单位:byte) 示例值:216516 |
AvgValue | Float | 查找时间段流量使用平均值(单位:byte) 示例值:25151 |
TotalValue | Float | 查找时间段流量使用总量(单位:byte) 示例值:35465464 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取指定id设备流量使用信息
获取指定id设备流量使用信息
输入示例
POST / HTTP/1.1
Host: mna.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFlowStatistic
<公共请求参数>
{
"EndTime": 1659514692,
"Type": 1,
"DeviceId": "abc",
"TimeGranularity": 1,
"BeginTime": 1659513692
}
输出示例
{
"Response": {
"MaxValue": 51548,
"AvgValue": 15441,
"TotalValue": 656546,
"NetDetails": [
{
"Time": "1659513692",
"Current": 3546545
},
{
"Time": "1659513692",
"Current": 4454864
},
{
"Time": "1659513692",
"Current": 4848941
}
],
"RequestId": ""
}
}
示例2 获取多个设备的流量使用信息之和
输入示例
POST / HTTP/1.1
Host: mna.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetFlowStatistic
<公共请求参数>
{
"EndTime": 1659514692,
"Type": 1,
"DeviceId": "",
"DeviceList": [
"abc",
"bcd"
],
"TimeGranularity": 1,
"BeginTime": 1659513692
}
输出示例
{
"Response": {
"MaxValue": 51548,
"AvgValue": 15441,
"TotalValue": 656546,
"NetDetails": [
{
"Time": "1659513692",
"Current": 3546545
},
{
"Time": "1659513692",
"Current": 4454864
},
{
"Time": "1659513692",
"Current": 4848941
}
],
"RequestId": ""
}
}
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.MonitorDataRequestError | 监控数据请求错误。 |
InternalError.NetworkInfoRequestError | 智研流量数据请求错误。 |
InvalidParameterValue | 参数取值错误。 |