Module name: network
Basic URL: /api/v1/network/
获取当前网络配置
API URL
**/api/v1/network/get**Request
Method: **GET/POST**
Parameters: **NONE**Response
Example:
{
"result": "ok",
"data": [
{
"device": "eth0",
"state": "up",
"ip": "192.168.2.160",
"mask": "255.255.255.0",
"mac": "68:3A:7F:8C:A7:96",
"gw": "192.168.2.1",
"dynamic": "y",
"dns": "8.8.8.8; 4.4.4.4",
"ip2": "192.168.100.168",
"mask2": "255.255.255.0",
"gw2": "",
"ip3": "0.0.0.0",
"mask3": "255.255.255.0",
"gw3": ""
}
],
"data_size": 1
}Data字段说明：
"data"是一个JSON数组，"data_size"是一个辅助描述"data"数组大小的字段（也许你用不上它）。
数组中的每一个item代表一个网络接口的配置:
| Field | Value | 说明 |
|---|---|---|
| device | [STRING] | 当前网络接口的设备名称。请注意这个设备名称，它是您修改网络配置的依据。也就是说，当您修改网络配置时，您必须指定这个device名称。 |
| state | [STRING] | 当前网络的工作状态： up： 网络工作正常 down：由于网线没有接入而断开 disabled: 由于其它原因而禁止使用该网络 error: 网络工作故障 |
| ip | [STRING] | 当前网络配置的IP地址。请注意：如果您的网络配置的是DHCP地址获取，那么ip将显示当前DHCP实际获取的IP地址；而如果网络配置的是静态IP地址，则ip表示您所设置的静态IP地址 |
| mask | [STRING] | 当前网络的子网掩码 (netmask) |
| mac | [STRING] | 当前网卡的MAC地址 |
| gw | [STRING] | 当前网络的默认网关(gateway)。如果没有设置，它将可能是""（空字符串）或者"0.0.0.0" |
| dynamic | [STRING] | y: 启动DHCP配置 n: 使用静态IP地址配置 |
| dns | [STRING] | 当前配置的DNS服务器地址。多个地址之间用 ‘;’ 隔开。 |
| ip2 | [STRING] | 设备的第二IP地址（也称之为Failsafe地址）。由于设备的主IP地址修改可能发生错误或因忘记而导致您无法访问设备，Failsafe地址允许您配置一个默认的、易于记忆的IP，此时您可以通过Failsafe地址来访问和配置设备。
所以，我们建议您尽可能不要修改ip2（Failsafe地址）。 |
| mask2 | [STRING] | ip2对应的子网掩码 (netmask) |
| gw2 | [STRING] | ip2对应的默认网关 (gateway)。如果没有设置，它将可能是""（空字符串）或者"0.0.0.0" |
| ip3/mask3/gw3 | [STRING] | ip3/mask3/gw3和ip2/mask2/gw2有相似的意义和用途。不过大多数情况下，您不必配置ip3。我们不对此参数配置的有效性提供担保 |
修改网络配置
重要提示： 网络配置的修改是一个敏感操作，错误的配置可能导致设备无法正常访问。因此，我们提醒您注意：
- 常规的网络地址修改，请您尽量通过NDI Device的Web UI来完成；
- 如果因为修改网络参数而导致不可访问，您可以通过按设备的Reset按钮来恢复出厂设置。
API URL
**/api/v1/network/set**Request
Method: **GET/POST**| Field | Value | 说明 |
|---|---|---|
| device | [STRING], Required | 指定要修改网络接口的名称。请参见 获取当前网络配置 /api/v1/network/get 中关于device参数的说明。这个参数是必须的。 |
| dynamic | [STRING], Optional | y: IP地址获取使用DHCP。如果dynamic="y"，则ip, mask, gw, dns参数将没有意义n: 使用静态IP地址配置 |
| ip | [STRING]， Optional | 配置IP地址 |
| mask | [STRING]， Optional | 子网掩码 (netmask) |
| mac | [STRING]， Optional | 如果指定mac，则可修改当前网卡的MAC地址。请注意： 1. 您必须提供有效、合法的MAC地址； 2. 除非您确定您要这样做的意图，否则请尽量不要修改设备的MAC地址 |
| gw | [STRING]， Optional | 默认网关(gateway)。指定""（空字符串）表示无gateway配置。 |
| dns | [STRING]， Optional | 指定0个或多个DNS服务器地址。多个地址之间用 ‘;’ 隔开。""（空字符串）表示无DNS配置。 |
| ip2 | [STRING]， Optional | 配置Failsafe IP地址。如果您需要清除Failsafe地址，请设置 ip2 = ""（空字符串） |
| mask2 | [STRING]， Optional | Failsafe地址的子网掩码 (netmask) |
| gw2 | [STRING]， Optional | Failsafe地址对应的默认网关 (gateway)。指定""（空字符串）表示无gateway配置。 |
| ip3/mask3/gw3 | [STRING]， Optional | ip3/mask3/gw3和ip2/mask2/gw2有相似的意义和用途。不过大多数情况下，您不必配置ip3。我们不对此参数配置的有效性提供担保 |
Response
Example:
{
"result": "ok"
}如果执行成功，将返回 result = "ok" 的消息；否则请参见 HTTP响应和错误处理 的标准错误消息描述。
注意：网络地址修改后，如果IP地址发生变化，您务须使用新的IP地址进行HTTP API访问。网络地址修改的生效通常 < 1s。但如果您指定ip地址为DHCP获取，取决于您的实际网络环境，它获得有效IP地址所需要等待的时间是不确定的。
