Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

了解 REST API

REST API 是一种表述性状态转换 (REST) 接口,允许您安全地连接到 瞻博网络 Junos 操作系统 (Junos OS) 设备,执行远程过程调用( 命令),使用 REST API Explorer GUI,方便您实验任何 REST API,并使用各种格式和 rpc 显示选项, 包括 JavaScript 对象表示法 (JSON)。

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

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

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

  • 检索 XML、ASCII(纯文本)或 JSON 中的配置信息。

  • 检索 XML、ASCII 或 JSON 中的操作数据。

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

以下CLI显示选项可用:

  • display json 一个选项添加到 | (管道) 命令。例如,CLI show interfaces | display json 命令显示 JSON 表示法中的接口。

  • format="json" 一个选项添加到 NETCONF 服务器命令中,以返回 JSON 表示法中的操作信息。

注意:

从 Junos OS版本17.3R1,除了 XML 格式之外,OpenConfig 还支持守护程序直接以 JSON 格式发出的操作状态。要配置 JSON compact 格式,请指定以下 CLI 命令: set system export-format state-data json compact 。此命令CLI XML 格式转换为紧凑的 JSON 格式。否则,它以非紧凑格式发出 JSON。

注意:

REST API 传入请求有效负载大小不能超过 1174KB。 解决方案:将传入 REST API 请求以较小大小阻止。

REST API 支持 HTTP 基本身份验证,所有请求都需要授权标头中包含的基本 64 编码用户名和密码。HTTP 和 HTTPS 均支持:

  • 如果需要安全连接,可以使用 HTTP 使用纯文本交换内容。

  • 我们建议您使用 HTTPS 使用其中一个可用密码套件交换加密内容。您可将 REST API 配置为需要服务器认证而无需客户端认证,也可配置相互认证。

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

REST API 还提供称为 REST API Explorer 的 GUI,使您能够轻松快速地了解如何使用 REST API。默认情况下,它将被禁用,并且可通过指定 来启用 set system services rest enable-explorer 。要了解有关 REST API Explorer 详细了解,请参阅 示例:使用 REST API Explorer

版本历史记录表
释放
描述
17.3R1
从Junos OS版本17.3R1,除了 XML 格式之外,OpenConfig 还支持守护程序直接以 JSON 格式发出的操作状态。要配置 JSON compact 格式,请指定以下 CLI: set system export-format state-data json compact 。此命令CLI XML 格式转换为紧凑的 JSON 格式。否则,它以非紧凑格式发出 JSON。