Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
本页内容
 

示例：使用 REST API 资源管理器

此示例演示如何在配置了 REST API 的 Junos OS 设备上选择性地使用 REST API 资源管理器。

要求

  • 需要运行 Junos OS 14.2 或更高版本的 M Series、MX 系列、T Series 或 PTX 系列设备。

概述

使用 REST API 资源管理器可以方便地测试单个或多个 RPC 调用。它的 GUI 为您提供了用于选择 HTTP 方法（GET 或 POST）、所需输出格式（XML、JSON 或纯文本）、RPC URL、使用 POST 请求时的输入数据类型（XML 或纯文本）的选项，以及出错时退出条件。

在 Junos 中，GET 和 POST 都可用于执行单个作 RPC（如 get-software-information）。虽然这两种方法可以检索相同的信息，但当您需要执行多个 RPC 或在请求正文中包含 XML 数据（使用 -d 选项）时，POST 是必需的。

提交请求时，REST API 资源管理器会显示请求标头、响应标头、响应正文和等效的 cURL 请求，所有这些都对您的开发工作很有用。

配置

要在已配置 REST API 的任何设备上使用 REST API 资源管理器，请执行以下任务：

启用 REST API 资源管理器

分步过程

要启用 REST API 资源管理器，请执行以下作：

  1. 在设备上配置 REST API。

    有关信息和示例，请参阅 配置 REST API 和 示例：配置 REST API 。

  2. 检查是否开启了 REST API 资源管理器。

    show使用命令查看 REST API 配置中是否enable-explorer;显示。如果出现，则表示 REST API 资源管理器已启用。如果未显示，则必须启用 REST API 资源管理器。

  3. 如有必要，启用 REST API 资源管理器。

    set使用命令确保它enable-explorer;显示在 REST API 配置中。

打开 REST API 资源管理器

分步过程

要打开 REST API 资源管理器，请执行以下作：

  • 确保已启用 REST API 资源管理器，打开浏览器，然后转到以下 URL：scheme：//device-name：port（例如，https://mydevice:3000）。

使用 HTTP GET 请求执行单个 RPC

分步过程

要使用 HTTP GET 请求执行单个 RPC，请执行以下作：

  1. 在 “HTTP 方法 ”下拉列表中，选择“ GET”。

  2. 输入 RPC URL 终结点。

    例如，键入 /rpc/get-software-information。

  3. 输入您的用户名和密码。

  4. 点击 提交。

    在此示例中，响应正文中返回默认输出格式 XML：

使用 HTTP POST 请求执行单个 RPC

分步过程

要使用 HTTP POST 请求执行单个 RPC，请执行以下作：

  1. 在 “HTTP 方法 ”下拉列表中，选择 “POST”。

  2. 在 “所需的输出格式 ”下拉列表中，选择 “JSON”。

  3. 输入以下 RPC URL 终结点： /rpc/get-software-information。

  4. 输入您的用户名和密码。

  5. 在 “请求正文 ”文本区域中输入 XML 格式的请求。

    例如：

  6. 点击 提交。

    在此示例中，JSON 输出格式在响应正文中返回：

  7. 如果您更喜欢其他输出格式，请在 “所需输出格式” 下拉列表中选择可用选项之一。

    例如，可以选择 “纯文本”。单击 “提交”时，您将在“响应正文”中看到纯文本：

    同样，如果在“必需的输出格式”下拉列表中选择“XML”，则响应正文将包含 XML 格式的信息：

执行多个 RPC

分步过程

要执行多个 RPC，请执行以下作：

  1. 在 “HTTP 方法 ”下拉列表中，选择 “POST”。

    执行多个 RPC 时始终需要这样做。

  2. 若要在发生错误时设置有条件的退出，请选中 “出错时退出” 复选框。

  3. 在 “所需的输出格式” 下拉列表中选择一种输出格式。

    例如，可以选择 JSON。

  4. 此 RPC URL 终结点将自动填充： /rpc?exit-on-error=1。

  5. 输入您的用户名和密码。

  6. 在 “请求正文 ”文本区域中输入 XML 格式的请求。

    例如：

  7. 点击 提交。

    在此示例中，JSON 输出格式在响应正文中返回：

查看错误消息

分步过程

执行多个 RPC 时，可能会发生错误。如果选中 “出错时退出 ”复选框，则在发生错误时，输出中将出现一条错误消息。

要查看错误消息：

  1. 在 “HTTP 方法 ”下拉列表中，选择 “POST”。

    执行多个 RPC 时始终需要这样做。

  2. 若要在发生错误时设置有条件的退出，请选中 “出错时退出” 复选框。

  3. 在 “所需的输出格式” 下拉列表中选择一种输出格式。

    例如，可以选择 JSON。

  4. 此 RPC URL 终结点将自动填充： /rpc?exit-on-error=1。

  5. 输入您的用户名和密码。

  6. 在 “请求正文 ”文本区域中输入包含错误的 XML 格式请求。

    例如：

  7. 点击 提交。

    在此示例中，JSON 输出格式在响应正文中返回，您可以在响应正文的末尾看到 XML 格式的错误消息：

  8. 如果未选中 “出错时退出 ”复选框，则在发生错误时，响应正文中将出现一条错误消息。

    处理错误后将继续执行，结果也将包含在响应正文中：

相关主题