REST API の使用開始
REST API のインストールおよび構成
REST APIのダウンロード方法、コントロールセンターサーバーへのインストール方法、使用設定方法については、『Paragon Active Assurance インストールガイド』を参照してください。このドキュメントを参照してください。
でパラメータを正しく/etc/netrounds/netrounds.conf設定SITE_URLすることが重要です。これは、REST API にアクセスできるパブリック URL を提供するためです。
REST認証トークンの存続期間の構成
REST API 認証トークンの有効期間は制限されており、既定では 10 年です。これは、ファイル /etc/netrounds/netrounds.conf内のパラメータREST_TOKEN_LIFETIMEによって管理されます。
REST API を使用する場合は、このパラメーターの値を必要なものに変更する必要があります。
認証トークンの取得
REST API の使用を開始する前に、その認証トークンを作成する必要があります。これは、コントロールセンターのWeb GUIで、またはコマンドラインから ncc コマンドを使用して実行できます。下記参照。
REST API を呼び出すすべてのコードにこのトークンを含める必要があります。例については、 このコードスニペット を参照してください。
Web GUI での認証トークンの取得
- Webアプリで、右上隅にあるParagon Active Assuranceユーザー名をクリックし、ポップアップメニューから[ プロファイルの編集 ]を選択します。
- [ API トークン ] タブを選択します。
- [ API トークンの追加] ボタンをクリックします。
- 新しいトークンが生成され、リストに追加されます (複数のトークンを定義できます)。必要に応じて [ 名前 ] 列に名前を付けます。
API トークンの値は、作成時にのみ表示されます。したがって、後でトークンを使用できるように書き留めておく必要があります。
コマンドラインからの認証トークンの作成と管理
次のコマンドで API トークンを作成できます。
ncc rest-create-token --email <user email> [--accounts <list of accounts>] [--full-access] [--name <name of token>] [--force]
APIトークンを作成できるのは、アカウント管理者とスーパーユーザーのみであることに注意してください。
どちらか --accounts <list of accounts> 、または --full-access 指定する必要があります。
このオプションは --accounts 、トークンがアクセスできるアカウントを指定します。トークンは、指定されたアカウントにのみアクセスできます。
代わりに --full-accessを指定した場合は、次のようになります。
- ユーザーがアカウント管理者の場合、トークンはアクセス権を持ち、管理者権限を持つすべてのアカウントで機能します。
- ユーザがスーパーユーザの場合、トークンはシステム全体にアクセスできます。これは、ユーザーがすべてのアカウントの明示的なメンバーでなくても、すべてのアカウントを意味します。
このオプションは --full-access 、トークンに すべての アカウントへのアクセスを許可します。これを確認するように求められます。 --force 確認をスキップするオプションを使用します。
このオプション --name では、トークンに名前を付けることができます。これは任意です。
あなたはすべてのAPIトークンをリストすることができます
ncc rest-list-tokens
APIトークンは、
ncc rest-delete-token [--id <token id>] [--name <token name>]
ここで、 は id トークンをリストすることによって取得されます。
GUIで作成されたAPIトークンは、デフォルトで常に1つのアカウントに関連付けられていることに注意してください。コマンドラインツールを使用して、 ncc より広範なアクセス権を持つトークンを作成する必要があります。
REST API ブラウザーへのアクセス
REST API をインストールして設定したら、(SITE_URLで/etc/netrounds/netrounds.conf定義されている)から REST API の API SITE_URL/rest/ ブラウザにアクセスできます。API ブラウザーは対話型で、REST API 操作を手動で試すことができます。また、REST API 機能に関するドキュメントも提供します。さらに、REST APIを網羅的に記述したJSONスキーマにリンクしています(/rest/apispec_1.json)。下の画像を参照してください。REST APIブラウザ自体はこのスキーマから生成されており、それに基づいてクライアントコードを生成することができます。
API ブラウザーから REST API を呼び出す前に、取得した認証トークンを指定して、このようなアクションを承認する必要があります (「 認証トークンの取得」セクションで説明されています)。
- [ 承認 ] ボタンをクリックします。
- 開いたダイアログで、[ 値 ] に認証トークンを入力し、ダイアログの [承認 ] ボタンをクリックします。次に、ダイアログを閉じます。
この Web ページから REST API 操作を繰り返し実行できるようになりました。ただし、ブラウザでページをリロードする場合は、上記の認証手順を繰り返す必要があります。
実際には、REST API の呼び出しは通常、オーケストレーターからスクリプト化されます。このドキュメントでは、オーケストレーターは主に REST API を呼び出す Python コードによって表されます。ただし、適用可能な任意の言語を使用できることを強調しておく必要があります。認証トークンは、REST API を呼び出すすべてのコードに含める必要があります。