示例:使用 REST API Explorer
此示例演示如何在已配置 REST API Junos OS设备上选择使用 REST API Explorer。
要求
需要M Series版本 14.2 T Series运行 MX 系列、M Junos OS X 系列或 PTX 系列设备的设备。
概述
REST API Explorer 允许您方便地测试一个或多个 RPC 调用。其 GUI 为您提供了以下选项:HTTP 方法(GET 或 POST)、所需输出格式(XML、JSON 或纯文本)、RPC URL、使用 POST 请求时输入的数据类型(XML 或纯文本)和"错误退出"情况。提交请求时,REST API Explorer 将显示请求标头、响应标头、响应正文和等效 cURL 请求,所有这些都对开发工作很有用。
配置
要配置 REST API 的任何设备上使用 REST API Explorer,请执行以下任务:
- 启用 REST API Explorer
- 打开 REST API Explorer
- 使用 HTTP GET 请求执行单个 RPC
- 使用 HTTP POST 请求执行单个 RPC
- 执行多个 RPC
- 查看错误消息
启用 REST API Explorer
逐步过程
要启用 REST API Explorer,请进行以下操作:
在设备上配置 REST API。
请参阅 配置 REST API 和 示例:配置 REST API 获取信息和示例。
检查 REST API Explorer 是否已启用。
使用
show
命令查看 RESTenable-explorer;
API 配置中是否显示。如果显示,则 REST API Explorer 已启用。如果未显示,则必须启用 REST API Explorer。[edit] user@R1# show system services rest http; traceoptions { flag all; } enable-explorer;
必要时启用 REST API Explorer。
使用
set
命令确保显示在enable-explorer;
REST API 配置中。[edit] user@R1# set system services rest enable-explorer
打开 REST API Explorer
逐步过程
要打开 REST API Explorer,请进行以下操作:
确保启用了 REST API Explorer,打开浏览器并转到以下 URL: scheme://device-name:port(例如,https://mydevice:3000)。
使用 HTTP GET 请求执行单个 RPC
逐步过程
要使用 HTTP GET 请求执行单个 RPC:
在 HTTP 方法 下拉菜单中,选择 GET。
输入 RPC URL 端点。
例如,键入
/rpc/get-software-information
。输入用户名和密码。
单击"提交"。
此示例在响应正文中返回默认输出格式 XML:
使用 HTTP POST 请求执行单个 RPC
逐步过程
要使用 HTTP POST 请求执行单个 RPC:
在 HTTP 方法 下拉菜单中,选择 POST。
在 "所需输出格式 "下拉列表中,选择 JSON。
输入此 RPC URL 端点:
/rpc/get-software-information
。输入用户名和密码。
在"请求正文"区域中输入 XML 格式 的请求。
例如:
<brief/>
单击"提交"。
此示例在响应正文中返回 JSON 输出格式:
如果您希望使用不同的输出格式,请在"所需输出格式"下拉列表 中选择一个 可用选项。
例如,您可以选择 纯文本。单击 "提交"时,在回答正文中将会显示纯文本:
同样,如果在"所需输出格式"下拉列表中选择XML,响应正文将包含 XML 格式的信息:
执行多个 RPC
逐步过程
要执行多个 RPC:
在 HTTP 方法 下拉菜单中,选择 POST。
在执行多个 RPC 时,始终需要此功能。
如果出错,请选中"错误退出"复选框 以设置条件退出 。
在"所需输出格式" 下拉列表中选择输出 格式。
例如,您可以选择 JSON。
此 RPC URL 端点将自动填充:
/rpc?exit-on-error=1
。输入用户名和密码。
在"请求正文"区域中输入 XML 格式 的请求。
例如:
<get-software-information /> <get-interface-information />
单击"提交"。
此示例在响应正文中返回 JSON 输出格式:
查看错误消息
逐步过程
执行多个 RPC 时,发生错误。如果选择" 错误时退出 "复选框,则输出中将出现错误消息(如果出现错误)。
要查看错误消息,
在 HTTP 方法 下拉菜单中,选择 POST。
在执行多个 RPC 时,始终需要此功能。
如果出错,请选中"错误退出"复选框 以设置条件退出 。
在"所需输出格式" 下拉列表中选择输出 格式。
例如,您可以选择 JSON。
此 RPC URL 端点将自动填充:
/rpc?exit-on-error=1
。输入用户名和密码。
输入 XML 格式的请求,其中包含"请求正文"文本 区域中 的错误。
例如:
<get-software-information /> <get-unknown-rpc /> <get-interface-information />
单击"提交"。
此示例在响应正文中返回 JSON 输出格式,您可以在响应正文的末尾看到 XML 格式的错误消息:
如果未选择"错误 退出" 复选框,则出现错误时,响应正文中将出现错误消息。
处理错误后,执行将继续,结果还将包含在响应正文中: