Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Пример: Использование rest API Explorer

В этом примере показано, как при желании использовать REST API Explorer на устройстве Junos OS на котором был настроен REST API.

Требования

  • Требуется M Series, серия MX, серия T или серия PTX под управлением Junos OS версии 14.2 или более поздней.

Обзор

Анализатор REST API Explorer позволяет удобно протестировать одиночные или несколько вызовов RPC. Его GUI предоставляет вам варианты выбора метода HTTP (GET или POST), требуемого формата вывода (XML, JSON или простого текста), URL RPC, типа вводимых данных при использовании POST-запросов (XML или простого текста) и условия выхода в случае ошибки. При отправке запроса, в проводнике REST API отображается заглавныйдер запроса, за головнойдер ответа, тело ответа и эквивалентный запрос cURL, все из которых полезно для ваших усилий по разработке.

Конфигурации

Чтобы использовать REST API Explorer на любом устройстве, на котором был настроен REST API, выполните эти задачи:

Включение rest API Explorer

Пошаговая процедура

Чтобы включить REST API Explorer:

  1. Настройка REST API на устройстве.

    См. "Настройка API REST" и "Пример: настройка REST API для информации и примеров".

  2. Проверьте, включен ли rest API Explorer.

    Используйте эту show команду, чтобы enable-explorer; увидеть, отображается ли конфигурация REST API. Если он появляется, то включено устройство REST API Explorer. Если он не появляется, необходимо включить REST API Explorer.

  3. При необходимости в включить REST API Explorer.

    Используйте эту set команду, чтобы убедиться, enable-explorer; что она отображается в конфигурации REST API.

Открытие rest API Explorer

Пошаговая процедура

Чтобы открыть REST API Explorer:

  • Убедитесь, что браузер REST API включен, откройте веб-браузер и перейдите на следующий URL-адрес: scheme://device-name:port (например, https://mydevice:3000).

Выполнение одиночного RPC с помощью запроса HTTP GET

Пошаговая процедура

Чтобы выполнить один RPC с помощью ЗАПРОСа HTTP GET:

  1. В выпадаемом списке методов HTTP выберите GET.

  2. Введите конечную точку URL-адреса RPC.

    Например, введите /rpc/get-software-information .

  3. Введите имя пользователя и пароль.

  4. Нажмите кнопку Submit (Отправить).

    В данном примере формат вывода по умолчанию, XML, возвращается в корпусе ответа:

Выполнение одиночного RPC с использованием POST-запроса HTTP

Пошаговая процедура

Чтобы выполнить один RPC с помощью POST-запроса HTTP:

  1. В выпадаемом списке методов HTTP выберите POST.

  2. В выпадаемом списке required output format выберите JSON.

  3. Введите конечную точку URL-адреса /rpc/get-software-information RPC.

  4. Введите имя пользователя и пароль.

  5. Введите форматированный XML-запрос в области текстового текста корпуса запроса.

    Например:

  6. Нажмите кнопку Submit (Отправить).

    В данном примере формат вывода JSON возвращается в тело ответа:

  7. Если требуется другой формат вывода, выберите один из доступных вариантов в выпадаемом списке необходимых выходных данных формата.

    Например, можно выбрать простой текст. При нажатии кнопки Submit (Отправить)в теле ответа вы увидите неявный текст:

    Аналогичным образом, если выбрать XML в выпадаемом списке необходимых выходных данных, тело ответа будет содержать информацию в формате XML:

Выполнение нескольких RPC

Пошаговая процедура

Для выполнения нескольких RPC:

  1. В выпадаемом списке методов HTTP выберите POST.

    Это всегда необходимо при выполнении нескольких RPC.

  2. Чтобы установить условный выход в случае ошибки, установите для этого положение в положение Exit on error.

  3. Выберите формат вывода в выпадаемом списке необходимых выходных данных.

    Например, можно выбрать JSON.

  4. Конечная точка URL-адреса RPC автоматически заполняется: /rpc?exit-on-error=1 .

  5. Введите имя пользователя и пароль.

  6. Введите форматированный XML-запрос в области текстового текста корпуса запроса.

    Например:

  7. Нажмите кнопку Submit (Отправить).

    В данном примере формат вывода JSON возвращается в тело ответа:

Просмотр сообщений об ошибках

Пошаговая процедура

При выполнении нескольких RPC может возникнуть ошибка. Если выбрано "Exit on error" (Выход в ошибке), в выходных данных появится сообщение об ошибке в случае возникновения ошибки.

Для просмотра сообщений об ошибках:

  1. В выпадаемом списке методов HTTP выберите POST.

    Это всегда необходимо при выполнении нескольких RPC.

  2. Чтобы установить условный выход в случае ошибки, установите для этого положение в положение Exit on error.

  3. Выберите формат вывода в выпадаемом списке необходимых выходных данных.

    Например, можно выбрать JSON.

  4. Конечная точка URL-адреса RPC автоматически заполняется: /rpc?exit-on-error=1 .

  5. Введите имя пользователя и пароль.

  6. Введите форматированный XML-запрос, содержащий ошибку в области текстового текста корпуса запроса.

    Например:

  7. Нажмите кнопку Submit (Отправить).

    В этом примере формат вывода JSON возвращается в тело ответа, и в конце тела ответа можно увидеть сообщение об ошибках в формате XML:

  8. Если в сообщении об ошибке не выбран exit on error, в органе ответа при обнаружении ошибки появляется сообщение об ошибке.

    Выполнение будет продолжаться после обработки ошибки, и результаты также будут включены в тело ответа: