Module name: sys

Basic URL: /api/v1/sys/

获取设备的工作状态

---

API URL

**/api/v1/sys/server_info**

Request

Method: **GET/POST**

Parameters: **NONE**

Response

Example:

{
    "result": "ok",
    "data": {
        "addr": "192.168.0.100",
        "port": 443,
        "name": "https://192.168.0.100",
        "persis": "4H 15M 32S",
        "start_time": "2020-05-03 12:10:09",
        "cpu_cores": 2,
        "cpu_payload": 33,
        "mem_used": 124.06,
        "mem_total": 620.00
    }
}

Field	Value	说明
addr	[STRING]	当前设备的IP地址
port	[INT]	当前您请求HTTP API所访问的端口（默认HTTP: 80, HTTPS: 443）
name	[STRING]	注意： 这是一个将被放弃或改变的字段。目前代表的是您访问HTTP API的URL。
persis	[STRING]	设备持续工作的时间长度，格式为： <小时>H <分>M <秒>S
start_time	[STRING]	设备开始启动的时间，格式为： Year-Month-Day Hour:Minute:Second
cpu_cores	[INT]	当前设备的CPU Core数量
cpu_payload	[INT]	当前CPU的负载%
mem_used	[NUM]	当前使用的内存数量，MB
mem_total	[NUM]	当前设备总共可用的内存，MB

重置所有NDI连接

---

本操作将断开所有的NDI连接并重新开始：对于NDI Encoder而言，意味着它将重新初始化NDI Sender；对于NDI Decoder而言，它将断开现有的NDI Source并且重新连接。

完成重置的时间大约需要4-6秒，请注意。

API URL

**/api/v1/sys/reconnect**

Request

Method: **GET/POST**

Parameters: **NONE**

Response

Example:

{
    "result": "ok"
}

如果执行成功，将返回 result = "ok" 的消息；否则请参见 HTTP响应和错误处理 的标准错误消息描述。

设备重新启动

---

本操作将控制NDI设备重新启动。

调用本API，HTTP将会立即返回，但设备真正的重新启动动作将在API执行成功后3秒开始，整个重启的过程大约需要20秒。由于设备的网络通常采用DHCP获取地址，而DHCP获取的时间取决您的实际网络条件，所以，您能预期的可以重新访问设备的时间将 >= 30秒。

设备重启的过程中，您将无法再访问任何HTTP API，直到设备重启完成。

特别注意：设备重新启动后，您现有的安全凭据（Session ID和Authorization Token）将失效，您必须按照安全性规则所描述的方法，重新进行HTTP API授权！

API URL

**/api/v1/sys/reboot**

Request

Method: **GET/POST**

Parameters: **NONE**

Response

Example:

{
    "result": "ok"
}

如果执行成功，将返回 result = "ok" 的消息；否则请参见 HTTP响应和错误处理 的标准错误消息描述。

恢复出厂设置

---

本操作将恢复NDI Device的默认出厂设置。将影响的设置包括：

• 网络地址的获取方式将恢复为DHCP；
• 网络的Failsafe地址将恢复为出厂默认值（192.168.100.168，或192.168.1.168，取决于不同的设备，请参考产品使用说明手册）；
• NDI Group将恢复为默认值(public)；
• NDI Device Name将恢复为 "\<PRODCT_TYPE>-\<SERIAL-NUMBER>" 的格式；
• NDI Channel Name将恢复为出厂的默认名称（通常是Channel-1，但以实际产品为准）；
• NDI Connection的方式将恢复为默认（TCP）连接方式；
• NDI Decoder的当前解码Source和Preset将被清空，Preset 0 (Blank)的颜色将恢复为默认（黑色）；
• 所有的用户将被清除，admin用户将恢复默认的密码。

调用本API，HTTP将会立即返回，但设备会在API执行成功后3秒开始重新启动，重新启动的行为和造成的影响同 设备重新启动 所描述的一致。

API URL

**/api/v1/sys/restore**

Request

Method: **GET/POST**

Parameters: **NONE**

Response

Example:

{
    "result": "ok"
}

如果执行成功，将返回 result = "ok" 的消息；否则请参见 HTTP响应和错误处理 的标准错误消息描述。