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が設定されているデバイスで、必要にJunos OS REST API Explorer を使用する方法を示しています。

要件

  • M Series リリース 14.2 以降を実行MX シリーズ、T Series Junos OS、PTX シリーズ デバイスの追加、削除、削除、またはPTX シリーズする必要があります。

概要

REST API Explorer を使用すると、1 回または複数の RPC コールを簡単にテストできます。その GUI には、HTTP メソッド(GET または POST)、必要な出力形式(XML、JSON、またはプレーン テキスト)、RPC URL、POST リクエストを使用する場合の入力データ タイプ(XML またはプレーン テキスト)、exit-on-error 条件を選択するオプションが用意されています。リクエストを送信すると、REST API Explorer にリクエスト ヘッダー、レスポンス ヘッダー、レスポンス本体、同等の cURL リクエストが表示されます。これらのすべてが開発作業に役立ちます。

構成

REST API が設定されているデバイスで REST API Explorer を使用するには、以下のタスクを実行します。

REST API Explorer を有効にする

手順

REST API Explorer を有効にするには、次の方法に示します。

  1. デバイスで REST API を設定します。

    情報 と例については、「 REST API の設定 」および「 例: 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 Explorer が有効になっているか、ブラウザを開き、次の 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. [Request body text] エリアに XML 形式 のリクエストを 入力します。

    例えば:

  6. [送信 ] をクリックします。

    この例では、JSON出力形式がレスポンス本体に返されます。

  7. 異なる出力形式を希望する場合は、 [必須出力形式]ドロップダウン リストから利用可能な選択肢のいずれかを選択します。

    たとえば、 [プレーン テキスト] を選択できます。[送信] をクリックすると、応答本体にプレーン テキストが表示されます。

    同様に、[必須出力形式]ドロップダウン リストでXMLを選択した場合、応答本体には XML 形式の情報が含まれる:

複数の RPC の実行

手順

複数の RPC を実行するには、以下の操作を行います。

  1. HTTP メソッド のドロップダウン リスト、POST を選択します

    これは、複数の RPC を実行する場合に必ず必要になります。

  2. エラーが発生した場合に条件出口を設定するには、[ Exit on error]チェックボックスを選択 します。

  3. [必須出力形式] ドロップダウン リストで 出力形式を選択します。

    たとえば、 [JSON] を選択します

  4. この RPC URL エンドポイントに次の情報が自動的に追加 /rpc?exit-on-error=1 されます。

  5. ユーザー名とパスワードを入力します。

  6. [Request body text] エリアに XML 形式 のリクエストを 入力します。

    例えば:

  7. [送信 ] をクリックします。

    この例では、JSON出力形式がレスポンス本体に返されます。

エラー メッセージの表示

手順

複数の RPC を実行すると、エラーが発生する可能性があります。[エラーの終了] チェックボックスをオン にした場合、エラーが発生するとエラー メッセージが出力に表示されます。

エラー メッセージを表示するには、次の方法に示します。

  1. HTTP メソッド のドロップダウン リスト、POST を選択します

    これは、複数の RPC を実行する場合に常に必要です。

  2. エラーが発生した場合に条件出口を設定するには、[ Exit on error]チェックボックスを選択 します。

  3. [必須出力形式] ドロップダウン リストで 出力形式を選択します。

    たとえば、 [JSON] を選択します

  4. この RPC URL エンドポイントに次の情報が自動的に追加 /rpc?exit-on-error=1 されます。

  5. ユーザー名とパスワードを入力します。

  6. [リクエスト本体テキスト] エリアにエラーが含まれている XML 形式 のリクエストを 入力します。

    例えば:

  7. [送信 ] をクリックします。

    この例では、レスポンス本文に JSON 出力形式が返され、レスポンス 本体の最後に XML 形式のエラー メッセージが表示されます。

  8. [エラー時に終了]チェックボックスをオフにした場合、エラーが発生した場合は、応答本体にエラー メッセージが表示されます。

    エラーが処理された後も実行が続き、その結果も応答本体に含まれます。