Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 d16a0067 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!20136 流量管理md 

Merge pull request !20136 from 徐杰/doc_stats
上级 c1df7fda c49e53c0
隐藏空白更改
内联 并排
Showing with 707 addition and 0 deletion
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ d16a0067
......@@ -309,6 +309,7 @@
- [@ohos.net.mdns (MDNS管理)](js-apis-net-mdns.md)
- [@ohos.net.sharing (网络共享管理)](js-apis-net-sharing.md)
- [@ohos.net.socket (Socket连接)](js-apis-socket.md)
- [@ohos.net.statistics (流量管理)](js-apis-net-statistics.md)
- [@ohos.net.webSocket (WebSocket连接)](js-apis-webSocket.md)
- [@ohos.request (上传下载)](js-apis-request.md)
......
zh-cn/application-dev/reference/apis/js-apis-net-statistics.md 0 → 100644
浏览文件 @ d16a0067
# @ohos.net.statistics (流量管理)
流量管理模块，支持基于网卡/UID的实时流量统计和历史流量统计查询能力。
> **说明：**
> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import statistics from '@ohos.net.statistics'
```
## statistics.getIfaceRxBytes<sup>10+</sup>
getIfaceRxBytes(nic: string, callback: AsyncCallback\<number>): void;
获取指定网卡实时下行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| nic | string | 是 | 指定查询的网卡名。 |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取网卡实时下行流量时，error为undefined，stats为获取到的网卡实时下行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getIfaceRxBytes("wlan0", (error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getIfaceRxBytes<sup>10+</sup>
getIfaceRxBytes(nic: string): Promise\<number>;
获取指定网卡实时下行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| nic | string | 是 | 指定查询的网卡名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回网卡实时下行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getIfaceRxBytes("wlan0").then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getIfaceTxBytes<sup>10+</sup>
getIfaceTxBytes(nic: string, callback: AsyncCallback\<number>): void;
获取指定网卡实时上行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| nic | string | 是 | 指定查询的网卡名。 |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取网卡实时上行流量时，error为undefined，stats为获取到的网卡实时上行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getIfaceTxBytes("wlan0", (error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getIfaceTxBytes<sup>10+</sup>
getIfaceTxBytes(nic: string): Promise\<number>;
获取指定网卡实时上行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| nic | string | 是 | 指定查询的网卡名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回网卡实时上行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getIfaceTxBytes("wlan0").then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getCellularRxBytes<sup>10+</sup>
getCellularRxBytes(callback: AsyncCallback\<number>): void;
获取蜂窝实时下行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取蜂窝实时下行流量时，error为undefined，stats为获取到的蜂窝实时下行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getCellularRxBytes((error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getCellularRxBytes<sup>10+</sup>
getCellularRxBytes(): Promise\<number>;
获取蜂窝实时下行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回蜂窝实时下行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getCellularRxBytes().then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getCellularTxBytes<sup>10+</sup>
getCellularTxBytes(callback: AsyncCallback\<number>): void;
获取蜂窝实时上行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取蜂窝实时上行流量时，error为undefined，stats为获取到的蜂窝实时上行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getCellularTxBytes((error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getCellularTxBytes<sup>10+</sup>
getCellularTxBytes(): Promise\<number>;
获取蜂窝实时上行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回蜂窝实时上行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
| 2103012 | Get iface name failed. |
**示例：**
```js
statistics.getCellularTxBytes().then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getAllRxBytes<sup>10+</sup>
getAllRxBytes(callback: AsyncCallback\<number>): void;
获取所有网卡实时下行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取所有网卡实时下行流量，error为undefined，stats为获取到的所有网卡实时下行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getAllRxBytes((error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getAllRxBytes<sup>10+</sup>
getAllRxBytes(): Promise\<number>;
获取所有网卡实时下行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回所有网卡实时下行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getCellularRxBytes().then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getAllTxBytes<sup>10+</sup>
getAllTxBytes(callback: AsyncCallback\<number>): void;
获取所有网卡实时上行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取所有网卡实时上行流量，error为undefined，stats为获取到的所有网卡实时上行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getAllTxBytes((error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getAllTxBytes<sup>10+</sup>
getAllTxBytes(): Promise\<number>;
获取所有网卡实时上行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回所有网卡实时上行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getAllTxBytes().then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getUidRxBytes<sup>10+</sup>
getUidRxBytes(uid: number, callback: AsyncCallback\<number>): void;
获取指定应用实时下行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| uid | number | 是 | 指定查询的应用uid。 |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取应用实时下行流量时，error为undefined，stats为获取到的应用实时下行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getUidRxBytes(20010038, (error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getUidRxBytes<sup>10+</sup>
getUidRxBytes(uid: number): Promise\<number>;
获取指定应用实时下行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| uid | number | 是 | 指定查询的应用uid。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回指定应用实时下行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getUidRxBytes(20010038).then(function (stats) {
console.log(JSON.stringify(stats))
})
```
## statistics.getUidTxBytes<sup>10+</sup>
getUidTxBytes(uid: number, callback: AsyncCallback\<number>): void;
获取指定应用实时上行流量，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| uid | number | 是 | 指定查询的应用uid。 |
| callback | AsyncCallback\<number> | 是 | 回调函数。当成功获取应用实时上行流量时，error为undefined，stats为获取到的应用实时上行流量(单位:字节)；否则为错误对象|
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getUidTxBytes(20010038, (error, stats) => {
console.log(JSON.stringify(error))
console.log(JSON.stringify(stats))
})
```
## statistics.getUidTxBytes<sup>10+</sup>
getUidTxBytes(uid: number): Promise\<number>;
获取指定应用实时上行流量，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| uid | number | 是 | 指定查询的应用uid。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<number> | 以Promise形式返回获取结果。返回指定应用实时上行流量(单位:字节)。 |
**错误码：**
以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2100002 | Operation failed. Cannot connect to service. |
| 2100003 | System internal error. |
| 2103005 | Failed to read map. |
| 2103011 | Failed to create map. |
**示例：**
```js
statistics.getUidTxBytes(20010038).then(function (stats) {
console.log(JSON.stringify(stats))
})
```
zh-cn/application-dev/reference/errorcodes/Readme-CN.md
浏览文件 @ d16a0067
......@@ -57,6 +57,7 @@
- [网络共享错误码](errorcode-net-sharing.md)
- [策略管理错误码](errorcode-net-policy.md)
- [MDNS错误码](errorcode-net-mdns.md)
- [流量管理](errorcode-net-statistics.md)
- 通信与连接
- [Bluetooth错误码](errorcode-bluetoothManager.md)
- [WIFI错误码](errorcode-wifi.md)
......
zh-cn/application-dev/reference/errorcodes/errorcode-net-statistics.md 0 → 100644
浏览文件 @ d16a0067
# statistics错误码
> **说明：**
>
> 以下仅介绍本模块特有错误码，通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。
## 2100001 无效的参数
**错误信息**
Invalid parameter value.
**错误描述**
参数输入有误。
**可能原因**
输入的结束时间小于开始时间。
**处理步骤**
检查输入的时间参数是否合理。
## 2100002 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败，连接系统服务发生异常。
**可能原因**
服务发生异常。
**处理步骤**
检查系统服务运行状态是否正常。
## 2100003 系统内部错误
**错误信息**
System internal error.
**错误描述**
系统内部错误。
**可能原因**
1.内存异常。
2.空指针。
**处理步骤**
1.检查内存空间是否充足，清理内存后重试。
2.系统异常，请稍后重试或重启设备。
## 2103005 读取系统map失败
**错误信息**
Failed to read map.
**错误描述**
读取系统map失败。
**可能原因**
在内核map对象上读取流量数据失败。
**处理步骤**
检查输入的网卡或应用UID是否有流量产生。
## 2103011 系统map创建失败
**错误信息**
Failed to create map.
**错误描述**
内核对象创建失败。
**可能原因**
网卡没有流量产生，内核流量对象还未创建。
**处理步骤**
确保网卡上有流量产生。
## 2103012 获取网卡名失败
**错误信息**
Get iface name failed.
**错误描述**
获取网卡名失败。
**可能原因**
本机没有此网卡名。
**处理步骤**
检查传入的网卡名是否正确。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或