配置 REST API
可以使用层级下提供的命令Junos OS在设备上配置 REST [edit system services rest]
API。配置完成后,REST API 即作为服务可用,这是一个基于 REST 的接口,允许您从远程位置将命令提交到设备,并支持 GET 和 rest
rpc
POST 请求。
要启用设备上 REST API,您需要配置:
控制参数 — 允许您选择指定允许的源 IP 地址以及 HTTP 和 HTTPS 连接共同的连接限制。
REST API Explorer— REST API 提供称为 REST API Explorer 的 GUI,允许您轻松快速地了解如何使用 REST API。默认情况下,它将被禁用,可通过指定 来启用
set system services rest enable-explorer
。要了解有关 REST API Explorer 详细了解,请参阅 示例:使用 REST API Explorer。HTTP 访问 — 您可以为传入连接指定地址和 TCP 端口列表。HTTP 连接不安全,因为它们以纯文本交换凭据和数据,因此我们建议使用 HTTPS。
HTTPS 访问(推荐)— 您可以为传入连接指定地址和 TCP 端口列表、首选密码套件列表、传输层安全 (TLS) 相互认证和服务器证书。HTTPS 连接安全,对凭据和信息进行加密。
追踪选项 — 您可以为 Lighttpd、用户界面脚本环境(或二者)启用追踪。lighttpd 的跟踪信息存储在 /var/chroot/rest-api/var/log/lighttpd,并且 juise 的跟踪信息存储在 /var/chroot/rest-api/var/log/juise上。默认情况下,追踪将被禁用。
要配置 HTTP 和 HTTPS 连接通用设置的可选控制参数:
- 指定
set system services rest control allowed-sources [ value-list ]
以为 HTTP 和 HTTPS 连接设置允许的 IP 地址。将空格用作值之间的分隔符。 - 指定
set system services rest control connection-limit limit
以设置 HTTP 和 HTTPS 连接允许的最大同时连接数。您可以为 1 到 1024 分配一个值(默认值为 64)。
要配置 HTTP 访问,
指定
set system services rest http addresses [ addresses ]
以设置服务器侦听传入 HTTP 连接的地址。指定
set system services rest http port port-number
以设置传入 HTTP 连接的 TCP 端口。您可以为 1024 到 65535 分配一个值(默认值为 3000)。
要配置 HTTPS 访问,
指定
set system services rest https addresses [ addresses ]
以设置服务器侦听传入 HTTPS 连接的地址。指定
set system services rest https port port-number
以设置传入 HTTPS 连接的 TCP 端口。您可以为 1024 到 65535 分配一个值(默认值为 3443)。指定 配置 SSH 服务器可用于执行加密和解密功能的密码
set system services rest https cipher-list[cipher-1 cipher-2 cipher-3 ... ]
套件集。指定
set system services rest https server-certificate local-certificate-identifier
以配置服务器证书。有关 创建本地证书的信息,请参阅 request security pki 生成证书 请求 。您可以将 REST API 配置为需要服务器认证而无需客户端认证,也可通过指定 在服务器和客户端上配置 TLS 相互认证
set system services rest https mutual-authentication certificate-authority certificate-authority-profile-name
。
要配置 lighttpd、juise 或二者中的追踪选项,请指定 set system services rest traceoptions flag flag.
Set to 、 或 flag
lighttpd
juise
all
。指定追踪选项时,命令将覆盖任何以前的追踪选项设置。