REST APIについて
REST APIは、REST(Representational State Transfer)インターフェイスで、ジュニパーネットワークス Junos オペレーティング システム(Junos OS)デバイスに安全に接続し、リモートプロシージャコール( コマンド)を実行し、REST API Explorer GUIを使用して、任意の REST APIを便利に試し rpc 、JSON(JavaScript Object Notation)などのさまざまなフォーマットと表示オプションを使用できます。
REST API は、階層レベルで使用可能なコマンドJunos OSデバイス上で [edit system services rest] 設定できます。設定が完了すると、REST APIをサービスとして利用できます。RESTベースのインターフェイスでは、コマンドをリモートからデバイスに送信し、GETリクエストと POSTリクエストをサポートできます rest rpc 。REST APIを使用すると、以下が可能です。
GET リクエストを使用してコマンドを
rpc送信します。POST リクエストを使用して、コマンドを使用して情報を
rpc送信します。設定情報を XML、ASCII(プレーン テキスト)、または JSON で取得します。
XML、ASCII、または JSON で動作データを取得します。
階層レベルでは、Junos OS デバイス上で REST API サービスを設定および保護し、IP アドレス、ポート番号、サーバー証明書、制御パラメーター、トレース オプションを設定し、便利な GUI を使用して REST API を試用できる REST API Explorer ツールを有効にできます。 [edit system services rest]
以下のCLIオプションは使用できます。
オプション
display jsonが| (パイプ) コマンド。たとえば、 CLI コマンドはインターフェイスを JSON 表記show interfaces | display jsonで表示します。format="json"NETCONF サーバー コマンドにオプションが追加され、動作情報を JSON 表記で返します。
OpenConfig の Junos OS リリース 17.3R1、XML 形式に加え、デーモンから直接送信される動作状態も JSON 形式でサポートします。JSON コンパクトな形式を設定するには、次のオプション コマンドをCLIします set system export-format state-data json compact 。このCLIコマンドは、XML 形式をコンパクトな JSON 形式に変換します。それ以外の場合は、JSON を非コンパクトな形式で送信します。
REST API 受信リクエストペイロードのサイズは、1,174KB を超えすることはできません。
回避:受信した REST API 要求を小さなサイズにチャンク化します。
REST API は HTTP Basic Authentication をサポートし、すべてのリクエストには認証ヘッダーに base64 エンコードのユーザー名とパスワードが含まれている必要があります。HTTP と HTTPS の両方のサポートが提供されています。
セキュアな接続が必要ない場合は、HTTP を使用してクリア テキストを使用してコンテンツを交換できます。
HTTPSを使用して、利用可能な暗号スイートのいずれかを使用して暗号化されたコンテンツを交換することをお勧めします。クライアント認証なしでサーバー認証を要求する REST API を設定したり、相互認証を設定することもできます。
デバイスで REST API を設定すると、GET または POST リクエストを介して 1 つのコマンドを実行したり、1 つの POST リクエストを介して複数のコマンドを実行したりできる新しい REST エンドポイントを利用 rpc rpc できます。詳細 については、「 GET リクエストを REST API に送信する 」および「 POST リクエストを REST API に送信する 」を参照してください。
REST API には REST API Explorer と呼ばれる GUI も用意されています。これにより、REST API の使い方を簡単かつ迅速に学習できます。デフォルトでは無効になり、 を指定して有効にできます set system services rest enable-explorer 。REST API Explorer の詳細については、「 例: REST API Explorer の使用 」 を参照してください。