# @ohos.net.statistics (流量管理) 流量管理模块,支持基于网卡/UID 的实时流量统计和历史流量统计查询能力。 > **说明:** > 本模块首批接口从 API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 ## 导入模块 ```js import statistics from "@ohos.net.statistics"; ``` ## statistics.getIfaceRxBytes10+ getIfaceRxBytes(nic: string, callback: AsyncCallback\): void; 获取指定网卡实时下行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | nic | string | 是 | 指定查询的网卡名。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时下行流量时,error 为 undefined,stats 为获取到的网卡实时下行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getIfaceRxBytes("wlan0", (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getIfaceRxBytes10+ getIfaceRxBytes(nic: string): Promise\; 获取指定网卡实时下行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------ | | nic | string | 是 | 指定查询的网卡名。 | **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回网卡实时下行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getIfaceRxBytes("wlan0").then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getIfaceTxBytes10+ getIfaceTxBytes(nic: string, callback: AsyncCallback\): void; 获取指定网卡实时上行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | nic | string | 是 | 指定查询的网卡名。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时上行流量时,error 为 undefined,stats 为获取到的网卡实时上行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getIfaceTxBytes("wlan0", (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getIfaceTxBytes10+ getIfaceTxBytes(nic: string): Promise\; 获取指定网卡实时上行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------ | | nic | string | 是 | 指定查询的网卡名。 | **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回网卡实时上行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getIfaceTxBytes("wlan0").then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getCellularRxBytes10+ getCellularRxBytes(callback: AsyncCallback\): void; 获取蜂窝实时下行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时下行流量时,error 为 undefined,stats 为获取到的蜂窝实时下行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getCellularRxBytes((error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getCellularRxBytes10+ getCellularRxBytes(): Promise\; 获取蜂窝实时下行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回蜂窝实时下行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getCellularRxBytes().then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getCellularTxBytes10+ getCellularTxBytes(callback: AsyncCallback\): void; 获取蜂窝实时上行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时上行流量时,error 为 undefined,stats 为获取到的蜂窝实时上行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getCellularTxBytes((error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getCellularTxBytes10+ getCellularTxBytes(): Promise\; 获取蜂窝实时上行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回蜂窝实时上行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getCellularTxBytes().then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getAllRxBytes10+ getAllRxBytes(callback: AsyncCallback\): void; 获取所有网卡实时下行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时下行流量,error 为 undefined,stats 为获取到的所有网卡实时下行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | **示例:** ```js import statistics from '@ohos.net.statistics'; import { BusinessError } from '@ohos.base'; statistics.getAllRxBytes((error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getAllRxBytes10+ getAllRxBytes(): Promise\; 获取所有网卡实时下行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回所有网卡实时下行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | **示例:** ```js import statistics from '@ohos.net.statistics'; statistics.getCellularRxBytes().then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getAllTxBytes10+ getAllTxBytes(callback: AsyncCallback\): void; 获取所有网卡实时上行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时上行流量,error 为 undefined,stats 为获取到的所有网卡实时上行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | **示例:** ```js import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getAllTxBytes((error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getAllTxBytes10+ getAllTxBytes(): Promise\; 获取所有网卡实时上行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回所有网卡实时上行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | **示例:** ```js import statistics from '@ohos.net.statistics'; statistics.getAllTxBytes().then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getUidRxBytes10+ getUidRxBytes(uid: number, callback: AsyncCallback\): void; 获取指定应用实时下行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | uid | number | 是 | 指定查询的应用 uid。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时下行流量时,error 为 undefined,stats 为获取到的应用实时下行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getUidRxBytes(20010038, (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getUidRxBytes10+ getUidRxBytes(uid: number): Promise\; 获取指定应用实时下行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | | uid | number | 是 | 指定查询的应用 uid。 | **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回指定应用实时下行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getUidRxBytes(20010038).then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getUidTxBytes10+ getUidTxBytes(uid: number, callback: AsyncCallback\): void; 获取指定应用实时上行流量,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------- | | uid | number | 是 | 指定查询的应用 uid。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时上行流量时,error 为 undefined,stats 为获取到的应用实时上行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; statistics.getUidTxBytes(20010038, (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getUidTxBytes10+ getUidTxBytes(uid: number): Promise\; 获取指定应用实时上行流量,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | | uid | number | 是 | 指定查询的应用 uid。 | **返回值:** | 类型 | 说明 | | -------- | -------- | | Promise\ | 以 Promise 形式返回获取结果。返回指定应用实时上行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 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 import statistics from '@ohos.net.statistics'; statistics.getUidTxBytes(20010038).then((stats: number) => { console.log(JSON.stringify(stats)); }); ``` ## statistics.getSockfdRxBytes11+ getSockfdRxBytes(sockfd: number, callback: AsyncCallback\): void; 获取指定socket的下行流量信息,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | sockfd | number | 是 | 指定查询的socket的fd(file description)。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取socket的下行流量时,error 为 undefined,stats 为获取到的该socket的实时下行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 401 | Parameter error. | | 2100001 | Invalid parameter value. | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | **示例:** ```js import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到 statistics.getSockfdRxBytes(sockfd, (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getSockfdRxBytes11+ getSockfdRxBytes(sockfd: number): Promise\; 获取指定socket的下行流量信息,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------------------- | | sockfd | number | 是 | 指定查询的socket的fd(file description)。 | **返回值:** | 类型 | 说明 | | ---------------- | ------------------------------------------------------------ | | Promise\ | 以 Promise 形式返回获取结果,返回该socket的实时下行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 401 | Parameter error. | | 2100001 | Invalid parameter value. | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | **示例:** ```js import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到 statistics.getSockfdRxBytes(sockfd).then((stats: number) => { console.log(JSON.stringify(stats)); }).catch((err: BusinessError) => { console.error(JSON.stringify(err)); }); ``` ## statistics.getSockfdTxBytes11+ getSockfdTxBytes(sockfd: number, callback: AsyncCallback\): void; 获取指定socket的上行流量信息,使用 callback 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | sockfd | number | 是 | 指定查询的socket的fd(file description)。 | | callback | AsyncCallback\ | 是 | 回调函数。当成功获取socket的上行流量时,error 为 undefined,stats 为获取到的该socket的实时上行流量(单位:字节);否则为错误对象。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 401 | Parameter error. | | 2100001 | Invalid parameter value. | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | **示例:** ```js import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到 statistics.getSockfdTxBytes(sockfd, (error: BusinessError, stats: number) => { console.log(JSON.stringify(error)); console.log(JSON.stringify(stats)); }); ``` ## statistics.getSockfdTxBytes11+ getSockfdTxBytes(sockfd: number): Promise\; 获取指定socket的上行流量信息,使用 Promise 方式作为异步方法。 **系统能力**:SystemCapability.Communication.NetManager.Core **参数:** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------------------- | | sockfd | number | 是 | 指定查询的socket的fd(file description)。 | **返回值:** | 类型 | 说明 | | ---------------- | ------------------------------------------------------------ | | Promise\ | 以 Promise 形式返回获取结果,返回该socket的实时上行流量(单位:字节)。 | **错误码:** 以下错误码的详细介绍参见[statistics 错误码](errorcode-net-statistics.md)。 | 错误码 ID | 错误信息 | | --------- | -------------------------------------------- | | 401 | Parameter error. | | 2100001 | Invalid parameter value. | | 2100002 | Operation failed. Cannot connect to service. | | 2100003 | System internal error. | **示例:** ```js import { BusinessError } from '@ohos.base'; import statistics from '@ohos.net.statistics'; let sockfd = 50; // 实际开发中需要先根据自己创建的socket获取到 statistics.getSockfdTxBytes(sockfd).then((stats: number) => { console.log(JSON.stringify(stats)); }).catch((err: BusinessError) => { console.error(JSON.stringify(err)); }); ```