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デバイス上で [edit system services rest] 設定できます。設定が完了すると、REST APIをサービスとして利用できます。RESTベースのインターフェイスでは、コマンドをリモートからデバイスに送信し、GETリクエストと POSTリクエストをサポートできます rest rpc 。

デバイスで REST API を有効にするには、以下の設定が必要です。

  • 制御パラメータ: 許可される送信元IPアドレスと、HTTP接続とHTTPS接続の両方に共通する接続制限をオプションで指定できます。

  • REST API Explorer: REST API Explorerと呼ばれるGUIを備えた REST APIは、REST APIの使い方を簡単かつ迅速に学習できます。デフォルトでは無効になり、 を指定して有効にできます set system services rest enable-explorer 。REST API Explorer の詳細については、「 例: REST API Explorer の使用 」 を参照してください。

  • HTTP アクセス— 受信接続のアドレスおよび TCP ポートのリストを指定できます。HTTP 接続は認証情報とデータをクリア テキストで交換するから安全ではないので、HTTPS を使用することをお勧めします。

  • HTTPS アクセス(推奨 )— 受信接続のアドレスおよび TCP ポートのリスト、推奨される暗号スイートのリスト、TLS(トランスポート レイヤー セキュリティ)相互認証、サーバー証明書を指定できます。HTTPS 接続は安全で、認証情報と情報の両方を暗号化します。

  • トレース オプション — lighttpd、ユーザー インターフェイス スクリプト環境(Juise)、または両方のトレースを有効にできます。lighttpd のトレース情報は /var/chroot/rest-api/var/log/lighttpdに保存され、Juise のトレース情報は /var/chroot/rest-api/var/log/juiseに保存されます。デフォルトでは、トレースは無効になっています。

HTTP 接続と HTTPS 接続の両方に共通の設定にオプションの制御パラメータを設定するには、次の手順に示します。

  1. HTTP set system services rest control allowed-sources [ value-list ] 接続と HTTPS 接続の両方で許可される IP アドレスを設定する場合に指定します。値間の区切り記号としてスペースを使用します。
  2. HTTP set system services rest control connection-limit limit と HTTPS の両方の同時接続を許可する最大数を設定するために指定します。1~1024の値を割り当てできます(デフォルトは64です)。

HTTP アクセスを設定するには、以下の手順にアクセスします。

  1. 指定 set system services rest http addresses [ addresses ] して、サーバーが受信する HTTP 接続をリッスンするアドレスを設定します。

  2. 指定 set system services rest http port port-number して、受信 HTTP 接続の TCP ポートを設定します。1024から65535の値を割り当てできます(デフォルトは3000です)。

HTTPS アクセスを設定するには、次の手順に示します。

  1. 指定 set system services rest https addresses [ addresses ] して、サーバーが受信した HTTPS 接続をリッスンするアドレスを設定します。

  2. 指定 set system services rest https port port-number して、受信する HTTPS 接続の TCP ポートを設定します。1024から65535の値を割り当てできます(デフォルトは3443です)。

  3. SSH set system services rest https cipher-list[cipher-1 cipher-2 cipher-3 ... ] サーバーが暗号化と暗号化解除機能の実行に使用できる暗号スイートのセットを設定するために指定します。

  4. 指定 set system services rest https server-certificate local-certificate-identifier してサーバー証明書を設定します。ローカル 証明書の作成に関する情報は、 request security pki generate-certificate-request を参照してください。

  5. クライアント認証なしでサーバー認証が必要な REST API を設定するか、 を指定してサーバーとクライアントの両方で TLS 相互認証を設定できます set system services rest https mutual-authentication certificate-authority certificate-authority-profile-name 。

lighttpd、juise、または両方の trace オプションを設定するには、 を指定 set system services rest traceoptions flag flag. flag lighttpd juise all します。trace オプションを指定すると、コマンドは以前のトレース オプション設定を上書きします。

関連ドキュメント