@ohos.net.statistics (流量管理)

流量管理模块，支持基于网卡/UID 的实时流量统计和历史流量统计查询能力。

说明： 本模块首批接口从 API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import statistics from "@ohos.net.statistics";

statistics.getIfaceRxBytes¹⁰⁺

getIfaceRxBytes(nic: string, callback: AsyncCallback<number>): void;

获取指定网卡实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getIfaceRxBytes¹⁰⁺

getIfaceRxBytes(nic: string): Promise<number>;

获取指定网卡实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getIfaceRxBytes("wlan0").then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getIfaceTxBytes¹⁰⁺

getIfaceTxBytes(nic: string, callback: AsyncCallback<number>): void;

获取指定网卡实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getIfaceTxBytes¹⁰⁺

getIfaceTxBytes(nic: string): Promise<number>;

获取指定网卡实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getIfaceTxBytes("wlan0").then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getCellularRxBytes¹⁰⁺

getCellularRxBytes(callback: AsyncCallback<number>): void;

获取蜂窝实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getCellularRxBytes¹⁰⁺

getCellularRxBytes(): Promise<number>;

获取蜂窝实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getCellularRxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getCellularTxBytes¹⁰⁺

getCellularTxBytes(callback: AsyncCallback<number>): void;

获取蜂窝实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getCellularTxBytes¹⁰⁺

getCellularTxBytes(): Promise<number>;

获取蜂窝实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getCellularTxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getAllRxBytes¹⁰⁺

getAllRxBytes(callback: AsyncCallback<number>): void;

获取所有网卡实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getAllRxBytes¹⁰⁺

getAllRxBytes(): Promise<number>;

获取所有网卡实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getCellularRxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getAllTxBytes¹⁰⁺

getAllTxBytes(callback: AsyncCallback<number>): void;

获取所有网卡实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getAllTxBytes¹⁰⁺

getAllTxBytes(): Promise<number>;

获取所有网卡实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getAllTxBytes().then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getUidRxBytes¹⁰⁺

getUidRxBytes(uid: number, callback: AsyncCallback<number>): void;

获取指定应用实时下行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getUidRxBytes¹⁰⁺

getUidRxBytes(uid: number): Promise<number>;

获取指定应用实时下行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getUidRxBytes(20010038).then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.getUidTxBytes¹⁰⁺

getUidTxBytes(uid: number, callback: AsyncCallback<number>): void;

获取指定应用实时上行流量，使用 callback 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

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.getUidTxBytes¹⁰⁺

getUidTxBytes(uid: number): Promise<number>;

获取指定应用实时上行流量，使用 Promise 方式作为异步方法。

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

statistics.getUidTxBytes(20010038).then((stats: number) => {
  console.log(JSON.stringify(stats));
});

statistics.on('netStatsChange')¹⁰⁺

on(type: 'netStatsChange', callback: Callback<{ iface: string, uid?: number }>): void

订阅流量改变事件通知。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

class IFace {
  iface: string = ""
  uid?: number = 0
}
statistics.on('netStatsChange', (data: IFace) => {
  console.log('on netStatsChange' + JSON.stringify(data));
});

statistics.off('netStatsChange')¹⁰⁺

off(type: 'netStatsChange', callback?: Callback<{ iface: string, uid?: number }>): void;

取消订阅流量改变事件通知。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

class IFace {
  iface: string = ""
  uid?: number = 0
}
let callback: (data: IFace) => void = (data: IFace) => {
    console.log("on netStatsChange, iFace:" + data.iface + " uid: " + data.uid);
}
statistics.on('netStatsChange', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
statistics.off('netStatsChange', callback);
statistics.off('netStatsChange');

statistics.getTrafficStatsByIface¹⁰⁺

getTrafficStatsByIface(ifaceInfo: IfaceInfo, callback: AsyncCallback<NetStatsInfo>): void;

获取指定网卡历史流量信息，使用 callback 方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

let iFaceInfo: statistics.IfaceInfo

statistics.getTrafficStatsByIface(iFaceInfo, (error: BusinessError, statsInfo: statistics.NetStatsInfo) => {
  console.log(JSON.stringify(error));
  console.log(
    "getTrafficStatsByIface bytes of received = " +
    JSON.stringify(statsInfo.rxBytes)
  );
  console.log(
    "getTrafficStatsByIface bytes of sent = " +
    JSON.stringify(statsInfo.txBytes)
  );
  console.log(
    "getTrafficStatsByIface packets of received = " +
    JSON.stringify(statsInfo.rxPackets)
  );
  console.log(
    "getTrafficStatsByIface packets of sent = " +
    JSON.stringify(statsInfo.txPackets)
  );
});

statistics.getTrafficStatsByIface¹⁰⁺

getTrafficStatsByIface(ifaceInfo: IfaceInfo): Promise<NetStatsInfo>;

获取指定网卡历史流量信息，使用 Promise 方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics';

let iFaceInfo: statistics.IfaceInfo
statistics.getTrafficStatsByIface(iFaceInfo).then((statsInfo: statistics.NetStatsInfo) => {
  console.log(
    "getTrafficStatsByIface bytes of received = " +
    JSON.stringify(statsInfo.rxBytes)
  );
  console.log(
    "getTrafficStatsByIface bytes of sent = " +
    JSON.stringify(statsInfo.txBytes)
  );
  console.log(
    "getTrafficStatsByIface packets of received = " +
    JSON.stringify(statsInfo.rxPackets)
  );
  console.log(
    "getTrafficStatsByIface packets of sent = " +
    JSON.stringify(statsInfo.txPackets)
  );
});

statistics.getTrafficStatsByUid¹⁰⁺

getTrafficStatsByUid(uidInfo: UidInfo, callback: AsyncCallback<NetStatsInfo>): void;

获取指定应用历史流量信息，使用 callback 方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

参数：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import { BusinessError } from '@ohos.base';
import statistics from '@ohos.net.statistics';

let uidInfo: statistics.UidInfo
uidInfo.uid = 20010037

statistics.getTrafficStatsByUid(
  uidInfo,
  (error: BusinessError, statsInfo: statistics.NetStatsInfo) => {
    console.log(JSON.stringify(error));
    console.log(
      "getTrafficStatsByUid bytes of received = " +
      JSON.stringify(statsInfo.rxBytes)
    );
    console.log(
      "getTrafficStatsByUid bytes of sent = " +
      JSON.stringify(statsInfo.txBytes)
    );
    console.log(
      "getTrafficStatsByUid packets of received = " +
      JSON.stringify(statsInfo.rxPackets)
    );
    console.log(
      "getTrafficStatsByUid packets of sent = " +
      JSON.stringify(statsInfo.txPackets)
    );
  }
);

statistics.getTrafficStatsByUid¹⁰⁺

getTrafficStatsByUid(uidInfo: UidInfo): Promise<NetStatsInfo>;

获取指定应用历史流量信息，使用 Promise 方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.GET_NETWORK_STATS

系统能力：SystemCapability.Communication.NetManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍参见statistics 错误码。

示例：

import statistics from '@ohos.net.statistics'

let uidInfo: statistics.UidInfo
uidInfo.uid = 20010037

statistics.getTrafficStatsByUid(uidInfo).then((statsInfo: statistics.NetStatsInfo) => {
  console.log("getTrafficStatsByUid bytes of received = " + JSON.stringify(statsInfo.rxBytes));
  console.log("getTrafficStatsByUid bytes of sent = " + JSON.stringify(statsInfo.txBytes));
  console.log("getTrafficStatsByUid packets of received = " + JSON.stringify(statsInfo.rxPackets));
  console.log("getTrafficStatsByUid packets of sent = " + JSON.stringify(statsInfo.txPackets));
})

IfaceInfo¹⁰⁺

查询网卡历史流量参数信息。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Communication.NetManager.Core

UidInfo¹⁰⁺

查询应用历史流量参数信息。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Communication.NetManager.Core

NetStatsInfo¹⁰⁺

获取的历史流量信息。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Communication.NetManager.Core