了解 REST API

可以使用层次结构级别下 [edit system services rest] 可用的命令在 Junos OS 设备上配置 REST API。配置后，REST API 将变为服务 rest ，这是一个基于 REST 的接口，允许您从远程位置向设备提交 rpc 命令，并支持 GET 和 POST 请求。借助 REST API，您可以：

• 使用 GET 请求提交 rpc 命令。

• 使用 POST 请求通过 rpc 命令提交信息。

• 以 XML、ASCII（纯文本）或 JSON 格式检索配置信息。

• 以 XML、ASCII 或 JSON 格式检索作数据。

[edit system services rest]在层次结构级别，您可以在 Junos OS 设备上配置和保护 REST API 服务;设置 IP 地址、端口号、服务器证书、控制参数和追踪选项;并启用 REST API 资源管理器工具，以便您可以使用方便的 GUI 试用 REST API。

可以使用以下 CLI 显示选项：

• display json一个选项已添加到 |（管道）命令。例如，CLI 命令show interfaces | display json以 JSON 表示法显示接口。

• format="json" NETCONF 服务器命令中添加了一个选项，用于以 JSON 表示法返回作信息。

注意：

REST API 传入请求有效负载大小不能超过 1174KB。
解决办法：将传入的 REST API 请求分块为较小的大小。

REST API 支持 HTTP 基本身份验证，并且所有请求都需要 Authorization 标头中包含的 base64 编码用户名和密码。提供 HTTP 和 HTTPS 支持：

• 如果不需要安全连接，可以使用 HTTP 通过明文交换内容。

• 我们建议您使用 HTTPS 通过可用的密码套件之一交换加密内容。您可以将 REST API 配置为要求服务器身份验证而不使用客户端身份验证，也可以配置相互身份验证。

在设备上配置 REST API 后，新的 REST 端点可用于通过 GET 或 POST 请求执行单个 rpc 命令，或通过单个 POST 请求执行多个 rpc 命令。有关更多信息，请参阅 向 REST API 提交 GET 请求 和 向 REST API 提交 POST 请求 。

Junos OS 支持以紧凑的 JSON 格式发出作状态数据。要以紧凑格式发出 JSON 数据，请在[edit system export-format state-data]层次结构级别配置json compact语句。否则，设备默认以非紧凑格式发出 JSON 数据。

REST API 还提供了一个名为 REST API 资源管理器的 GUI，可让您轻松快速地学习如何使用 REST API。默认情况下处于禁用状态，可以通过指定 set system services rest enable-explorer启用 。要了解有关 REST API 资源管理器的更多信息，请参阅 示例：使用 REST API 资源管理器。