openharmony 鸿蒙 js-apis-net-ethernet-sys

2025-06-16 浏览 (1)

@ohos.net.ethernet (以太网连接管理)（系统接口）

以太网连接管理主要提供有线网络能力，提供设置有线网络的IP地址，子网掩码，网关，DNS，代理等信息。

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

导入模块

import { ethernet } from '@kit.NetworkKit';

ethernet.setIfaceConfig9+

setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback<void>): void

设置网络接口配置信息，使用callback方式作为异步方法。

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

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

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

参数：

参数名类型必填说明
ifacestring是网络接口名。
icInterfaceConfiguration是要设置的网络接口配置信息。
callbackAsyncCallback<void>是回调函数。成功无返回，失败返回对应错误码。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201004Invalid Ethernet profile.
2201005Device information does not exist.
2201006Ethernet device not connected.
2201007Ethernet failed to write user configuration information.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let config: ethernet.InterfaceConfiguration = {
  mode: 0,
  ipAddr: "192.168.xx.xxx",
  route: "192.168.xx.xxx",
  gateway: "192.168.xx.xxx",
  netMask: "255.255.255.0",
  dnsServers: "1.1.1.1"
};

ethernet.setIfaceConfig("eth0", config, (error: BusinessError) => {
  if (error) {
    console.error("setIfaceConfig callback error = " + JSON.stringify(error));
  } else {
    console.log("setIfaceConfig callback ok");
  }
});

ethernet.setIfaceConfig9+

setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise<void>

设置网络接口配置信息，使用Promise方式作为异步方法。

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

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

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

参数：

参数名类型必填说明
ifacestring是接口名。
icInterfaceConfiguration是要设置的网络接口配置信息。

返回值：

类型说明
Promise<void>以Promise形式返回执行结果。成功无返回，失败返回对应错误码。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201004Invalid Ethernet profile.
2201005Device information does not exist.
2201006Ethernet device not connected.
2201007Ethernet failed to write user configuration information.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let config: ethernet.InterfaceConfiguration = {
  mode: 0,
  ipAddr: "192.168.xx.xxx",
  route: "192.168.xx.xxx",
  gateway: "192.168.xx.xxx",
  netMask: "255.255.255.0",
  dnsServers: "1.1.1.1"
};

const setConfigPromise = ethernet.setIfaceConfig("eth0", config);

setConfigPromise.then(() => {
  console.log("setIfaceConfig promise ok");
}).catch((error: BusinessError)  => {
  console.error("setIfaceConfig promise error = " + JSON.stringify(error));
});

ethernet.getIfaceConfig9+

getIfaceConfig(iface: string, callback: AsyncCallback<InterfaceConfiguration>): void

获取指定网络接口信息，使用callback方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
ifacestring是指定网络接口。
callbackAsyncCallback<InterfaceConfiguration>是回调函数。返回指定网络接口信息。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201005Device information does not exist.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.getIfaceConfig("eth0", (error: BusinessError, value: ethernet.InterfaceConfiguration) => {
  if (error) {
    console.error("getIfaceConfig  callback error = " + JSON.stringify(error));
  } else {
    console.log("getIfaceConfig callback mode = " + JSON.stringify(value.mode));
    console.log("getIfaceConfig callback ipAddr = " + JSON.stringify(value.ipAddr));
    console.log("getIfaceConfig callback route = " + JSON.stringify(value.route));
    console.log("getIfaceConfig callback gateway = " + JSON.stringify(value.gateway));
    console.log("getIfaceConfig callback netMask = " + JSON.stringify(value.netMask));
    console.log("getIfaceConfig callback dnsServers = " + JSON.stringify(value.dnsServers));
  }
});

ethernet.getIfaceConfig9+

getIfaceConfig(iface: string): Promise<InterfaceConfiguration>

获取指定网络接口信息，使用Promise方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
ifacestring是指定网络接口。

返回值：

类型说明
Promise<InterfaceConfiguration>以Promise形式返回接口信息。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201005Device information does not exist.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.getIfaceConfig("eth0").then((data: ethernet.InterfaceConfiguration) => {
  console.log("getIfaceConfig promise mode = " + JSON.stringify(data.mode));
  console.log("getIfaceConfig promise ipAddr = " + JSON.stringify(data.ipAddr));
  console.log("getIfaceConfig promise route = " + JSON.stringify(data.route));
  console.log("getIfaceConfig promise gateway = " + JSON.stringify(data.gateway));
  console.log("getIfaceConfig promise netMask = " + JSON.stringify(data.netMask));
  console.log("getIfaceConfig promise dnsServers = " + JSON.stringify(data.dnsServers));
}).catch((error: BusinessError) => {
  console.error("getIfaceConfig promise error = " + JSON.stringify(error));
});

ethernet.isIfaceActive9+

isIfaceActive(iface: string, callback: AsyncCallback<number>): void

判断接口是否已激活，使用callback方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
ifacestring是接口名。为空时代表查询是否存在激活接口。
callbackAsyncCallback<number>是回调函数。已激活：1，未激活：0，其他为获取失败错误码。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201005Device information does not exist.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.isIfaceActive("eth0", (error: BusinessError, value: number) => {
  if (error) {
    console.error("whether2Activate callback error = " + JSON.stringify(error));
  } else {
    console.log("whether2Activate callback = " + JSON.stringify(value));
  }
});

ethernet.isIfaceActive9+

isIfaceActive(iface: string): Promise<number>

判断接口是否已激活，使用Promise方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
ifacestring是接口名。为空时代表查询是否存在激活接口。

返回值：

类型说明
Promise<number>以Promise形式返回获取结果。已激活：1，未激活：0，其他为获取失败错误码。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.
2200001Invalid parameter value.
2200002Failed to connect to the service.
2200003System internal error.
2201005Device information does not exist.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.isIfaceActive("eth0").then((data: number) => {
  console.log("isIfaceActive promise = " + JSON.stringify(data));
}).catch((error: BusinessError) => {
  console.error("isIfaceActive promise error = " + JSON.stringify(error));
});

ethernet.getAllActiveIfaces9+

getAllActiveIfaces(callback: AsyncCallback<Array<string>>): void

获取活动的网络接口，使用callback方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
callbackAsyncCallback<Array<string>>是回调函数。返回值为对应接口名。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
2200002Failed to connect to the service.
2200003System internal error.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.getAllActiveIfaces((error: BusinessError, value: string[]) => {
  if (error) {
    console.error("getAllActiveIfaces callback error = " + JSON.stringify(error));
  } else {
    console.log("getAllActiveIfaces callback value.length = " + JSON.stringify(value.length));
    for (let i = 0; i < value.length; i++) {
      console.log("getAllActiveIfaces callback = " + JSON.stringify(value[i]));
    }
  }
});

ethernet.getAllActiveIfaces9+

getAllActiveIfaces(): Promise<Array<string>>

获取活动的网络接口，使用Promise方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

返回值：

类型说明
Promise<Array<string>>以Promise形式返回获取结果。返回值为对应接口名。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
2200002Failed to connect to the service.
2200003System internal error.

示例：

import { ethernet } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

ethernet.getAllActiveIfaces().then((data: string[]) => {
  console.log("getAllActiveIfaces promise data.length = " + JSON.stringify(data.length));
  for (let i = 0; i < data.length; i++) {
    console.log("getAllActiveIfaces promise  = " + JSON.stringify(data[i]));
  }
}).catch((error:BusinessError) => {
  console.error("getAllActiveIfaces promise error = " + JSON.stringify(error));
});

ethernet.on('interfaceStateChange')10+

on(type: 'interfaceStateChange', callback: Callback<InterfaceStateInfo>): void

注册网卡热插拔事件，使用callback方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
typestring是订阅的事件类型，'interfaceStateChange'。
callbackAsyncCallback<InterfaceStateInfo>是回调函数。返回以太网卡状态信息。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.

示例：

import { ethernet } from '@kit.NetworkKit';

ethernet.on('interfaceStateChange', (data: object) => {
  console.log('on interfaceSharingStateChange：' + JSON.stringify(data));
});

ethernet.off('interfaceStateChange')10+

off(type: 'interfaceStateChange', callback?: Callback<InterfaceStateInfo>): void

注销网卡热插拔事件，使用callback方式作为异步方法。

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

需要权限：ohos.permission.GET_NETWORK_INFO

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

参数：

参数名类型必填说明
typestring是订阅的事件类型，'interfaceStateChange'。
callbackAsyncCallback<InterfaceStateInfo>否回调函数。返回以太网卡状态信息。

错误码：

错误码ID错误信息
201Permission denied.
202Non-system applications use system APIs.
401Parameter error.

示例：

import { ethernet } from '@kit.NetworkKit';

ethernet.off('interfaceStateChange');

InterfaceConfiguration9+

以太网连接配置网络信息。

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

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

名称类型必填说明
modeIPSetMode是以太网连接配置模式。
ipAddrstring是以太网连接静态配置ip信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。
routestring是以太网连接静态配置路由信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。
gatewaystring是以太网连接配置网关信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。
netMaskstring是以太网连接配置子网掩码，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。
dnsServersstring是以太网连接配置dns服务地址，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）多地址间用“,”隔开。
httpProxy10+HttpProxy否以太网连接代理配置信息，默认情况下不配置任何代理信息。

InterfaceStateInfo11+

监听以太网卡状态变化

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

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

名称类型必填说明
ifacestring是以太网卡名称。
activeboolean是以太网卡是否处于激活状态（true：激活；false：未激活）。

IPSetMode9+

以太网连接模式。

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

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

名称值说明
STATIC0以太网连接静态配置网络信息。
DHCP1以太网连接动态配置网络信息。
LAN_STATIC11+2LAN连接静态配置网络信息。
LAN_DHCP11+3LAN连接动态配置网络信息。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Network Kit（网络服务）

harmony 鸿蒙NetConn_ConnectionProperties

harmony 鸿蒙NetConn_HttpProxy

harmony 鸿蒙NetConn_NetAddr

harmony 鸿蒙NetConn_NetCapabilities

harmony 鸿蒙NetConn_NetConnCallback

harmony 鸿蒙NetConn_NetHandle

harmony 鸿蒙NetConn_NetHandleList

harmony 鸿蒙NetConn_NetSpecifier

harmony 鸿蒙NetConn_Route

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/hSBQ3U