From 49f73f1a9787e2206544d73422e9f41b0c8dd462 Mon Sep 17 00:00:00 2001 From: xujie Date: Wed, 28 Jun 2023 11:43:00 +0800 Subject: [PATCH] update Change-Id: I81b25c3613d9f3bc3f6753fb7ecd68045b557c15 Signed-off-by: xujie --- .../reference/apis/js-apis-net-statistics.md | 140 ++++++++---------- 1 file changed, 64 insertions(+), 76 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-net-statistics.md index bcdc3fd7e2..b0d81eda51 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-statistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-statistics.md @@ -15,7 +15,7 @@ import statistics from '@ohos.net.statistics' getIfaceRxBytes(nic: string, callback: AsyncCallback\): void; -获取指定网卡实时下行流量。 +获取指定网卡实时下行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -24,10 +24,12 @@ getIfaceRxBytes(nic: string, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | | nic | string | 是 | 指定查询的网卡名。 | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时下行流量时，error为undefined，stats为获取到的网卡实时下行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时下行流量时，error为undefined，stats为获取到的网卡实时下行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -37,8 +39,6 @@ getIfaceRxBytes(nic: string, callback: AsyncCallback\): void; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 **示例：** @@ -53,7 +53,7 @@ getIfaceRxBytes(nic: string, callback: AsyncCallback\): void; getIfaceRxBytes(nic: string): Promise\; -获取指定网卡实时下行流量。 +获取指定网卡实时下行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -66,10 +66,12 @@ getIfaceRxBytes(nic: string): Promise\; **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回网卡实时下行流量 | +| Promise\ | 以Promise形式返回获取结果。返回网卡实时下行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -79,9 +81,6 @@ getIfaceRxBytes(nic: string): Promise\; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -94,7 +93,7 @@ getIfaceRxBytes(nic: string): Promise\; getIfaceTxBytes(nic: string, callback: AsyncCallback\): void; -获取指定网卡实时上行流量。 +获取指定网卡实时上行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -103,10 +102,12 @@ getIfaceTxBytes(nic: string, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | | nic | string | 是 | 指定查询的网卡名。 | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时上行流量时，error为undefined，stats为获取到的网卡实时上行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取网卡实时上行流量时，error为undefined，stats为获取到的网卡实时上行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -116,9 +117,6 @@ getIfaceTxBytes(nic: string, callback: AsyncCallback\): void; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -132,7 +130,7 @@ getIfaceTxBytes(nic: string, callback: AsyncCallback\): void; getIfaceTxBytes(nic: string): Promise\; -获取指定网卡实时上行流量。 +获取指定网卡实时上行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -145,10 +143,12 @@ getIfaceTxBytes(nic: string): Promise\; **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回网卡实时上行流量 | +| Promise\ | 以Promise形式返回获取结果。返回网卡实时上行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -158,9 +158,6 @@ getIfaceTxBytes(nic: string): Promise\; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -173,7 +170,7 @@ getIfaceTxBytes(nic: string): Promise\; getCellularRxBytes(callback: AsyncCallback\): void; -获取蜂窝实时下行流量。 +获取蜂窝实时下行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -181,10 +178,12 @@ getCellularRxBytes(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时下行流量时，error为undefined，stats为获取到的蜂窝实时下行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时下行流量时，error为undefined，stats为获取到的蜂窝实时下行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -206,17 +205,19 @@ getCellularRxBytes(callback: AsyncCallback\): void; getCellularRxBytes(): Promise\; -获取蜂窝实时下行流量。 +获取蜂窝实时下行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回蜂窝实时下行流量 | +| Promise\ | 以Promise形式返回获取结果。返回蜂窝实时下行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -225,9 +226,6 @@ getCellularRxBytes(): Promise\; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -240,7 +238,7 @@ getCellularRxBytes(): Promise\; getCellularTxBytes(callback: AsyncCallback\): void; -获取蜂窝实时上行流量。 +获取蜂窝实时上行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -248,10 +246,12 @@ getCellularTxBytes(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时上行流量时，error为undefined，stats为获取到的蜂窝实时上行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取蜂窝实时上行流量时，error为undefined，stats为获取到的蜂窝实时上行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -260,9 +260,6 @@ getCellularTxBytes(callback: AsyncCallback\): void; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -276,17 +273,19 @@ getCellularTxBytes(callback: AsyncCallback\): void; getCellularTxBytes(): Promise\; -获取蜂窝实时上行流量。 +获取蜂窝实时上行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回蜂窝实时上行流量 | +| Promise\ | 以Promise形式返回获取结果。返回蜂窝实时上行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -295,9 +294,6 @@ getCellularTxBytes(): Promise\; | 2103011 | Failed to create map. | | 2103012 | Get iface name failed. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -310,7 +306,7 @@ getCellularTxBytes(): Promise\; getAllRxBytes(callback: AsyncCallback\): void; -获取所有网卡实时下行流量。 +获取所有网卡实时下行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -318,10 +314,12 @@ getAllRxBytes(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时下行流量，error为undefined，stats为获取到的所有网卡实时下行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时下行流量，error为undefined，stats为获取到的所有网卡实时下行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -329,9 +327,6 @@ getAllRxBytes(callback: AsyncCallback\): void; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -345,17 +340,19 @@ getAllRxBytes(callback: AsyncCallback\): void; getAllRxBytes(): Promise\; -获取所有网卡实时下行流量。 +获取所有网卡实时下行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回所有网卡实时下行流量。 | +| Promise\ | 以Promise形式返回获取结果。返回所有网卡实时下行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -363,9 +360,6 @@ getAllRxBytes(): Promise\; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -378,7 +372,7 @@ getAllRxBytes(): Promise\; getAllTxBytes(callback: AsyncCallback\): void; -获取所有网卡实时上行流量。 +获取所有网卡实时上行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -386,10 +380,12 @@ getAllTxBytes(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时上行流量，error为undefined，stats为获取到的所有网卡实时上行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取所有网卡实时上行流量，error为undefined，stats为获取到的所有网卡实时上行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -397,9 +393,6 @@ getAllTxBytes(callback: AsyncCallback\): void; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -413,17 +406,19 @@ getAllTxBytes(callback: AsyncCallback\): void; getAllTxBytes(): Promise\; -获取所有网卡实时上行流量。 +获取所有网卡实时上行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回所有网卡实时上行流量。 | +| Promise\ | 以Promise形式返回获取结果。返回所有网卡实时上行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 2100002 | Operation failed. Cannot connect to service. | @@ -431,9 +426,6 @@ getAllTxBytes(): Promise\; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -446,7 +438,7 @@ getAllTxBytes(): Promise\; getUidRxBytes(uid: number, callback: AsyncCallback\): void; -获取指定应用实时下行流量。 +获取指定应用实时下行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -455,10 +447,12 @@ getUidRxBytes(uid: number, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | | uid | number | 是 | 指定查询的应用uid。 | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时下行流量时，error为undefined，stats为获取到的应用实时下行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时下行流量时，error为undefined，stats为获取到的应用实时下行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -467,9 +461,6 @@ getUidRxBytes(uid: number, callback: AsyncCallback\): void; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -483,7 +474,7 @@ getUidRxBytes(uid: number, callback: AsyncCallback\): void; getUidRxBytes(uid: number): Promise\; -获取指定应用实时下行流量。 +获取指定应用实时下行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -496,10 +487,12 @@ getUidRxBytes(uid: number): Promise\; **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回指定应用实时下行流量。 | +| Promise\ | 以Promise形式返回获取结果。返回指定应用实时下行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -508,9 +501,6 @@ getUidRxBytes(uid: number): Promise\; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -523,7 +513,7 @@ getUidRxBytes(uid: number): Promise\; getUidTxBytes(uid: number, callback: AsyncCallback\): void; -获取指定应用实时上行流量。 +获取指定应用实时上行流量，使用callback方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -532,10 +522,12 @@ getUidTxBytes(uid: number, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------------- | ---- | ------------------------------------------------------------ | | uid | number | 是 | 指定查询的应用uid。 | -| callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时上行流量时，error为undefined，stats为获取到的应用实时上行流量；否则为错误对象| +| callback | AsyncCallback\ | 是 | 回调函数。当成功获取应用实时上行流量时，error为undefined，stats为获取到的应用实时上行流量(单位:字节)；否则为错误对象| **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -544,9 +536,6 @@ getUidTxBytes(uid: number, callback: AsyncCallback\): void; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js @@ -560,7 +549,7 @@ getUidTxBytes(uid: number, callback: AsyncCallback\): void; getUidTxBytes(uid: number): Promise\; -获取指定应用实时上行流量。 +获取指定应用实时上行流量，使用Promise方式作为异步方法。 **系统能力**：SystemCapability.Communication.NetManager.Core @@ -573,10 +562,12 @@ getUidTxBytes(uid: number): Promise\; **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise\ | 以Promise形式返回获取结果。返回指定应用实时上行流量。 | +| Promise\ | 以Promise形式返回获取结果。返回指定应用实时上行流量(单位:字节)。 | **错误码：** +> 以下错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 + | 错误码ID | 错误信息 | | ------- | ----------------------------- | | 401 | Parameter error. | @@ -585,9 +576,6 @@ getUidTxBytes(uid: number): Promise\; | 2103005 | Failed to read map. | | 2103011 | Failed to create map. | -> **错误码说明：** -> 以上错误码的详细介绍参见[statistics错误码](../errorcodes/errorcode-net-statistics)。 - **示例：** ```js -- GitLab