サポートされるParagon Active Assurance機能
Paragon Active Assuranceのすべてのテストおよびモニタータイプは、テンプレートを使用してREST APIから作成および実行できます。テストテンプレートと監視テンプレートの設定方法は、アプリ内ヘルプの「テストと監視」>「テンプレートの作成」で説明しています。
Paragon Active Assuranceアカウントの作成は現在サポートされていません。ただし、1つまたは複数の事前定義されたアカウントがユーザー用に設定されています。
以下の表は、このリリースで使用できる製品機能の詳細を示しています。
構文の詳細については、「」を参照してください https://<Control Center host IP>/rest。
REST APIで利用可能な製品機能
各 REST API 操作は、指定された構文で URL に適用される HTTP メソッド (GET、PUT、PATCH、POST、DELETE など) で構成されます。したがって、各操作は次のように表されます。
| HTTPメソッド | パス |
ここで、省略された URL {protocol}://{Control Center host IP}/restの最初の部分は です。
すべての操作は、URLで指定されたParagon Active Assuranceアカウントで実行されます。
- ページネーション
- リソース: アラーム
- リソース: アラームメーリングリスト
- リソース: アラームテンプレート
- リソース: 外部 URL 共有
- リソース: IPTVチャンネル
- リソース: モニター
- リソース: モニター・テンプレート
- リソース: SIP アカウント
- リソース: SNMP マネージャ
- リソース: スピードテスト
- リソース: SSH キー
- リソース: タグ
- リソース: テスト エージェント
- リソース: テスト
- リソース: テスト テンプレート
- リソース:TWAMP リフレクタ
- リソース: Y.1731 MEP
ページネーション
REST API の API リソースの多くは、複数の項目を一覧表示するために使用されます。これらのリソースはすべて、クエリ パラメーターを指定して返された結果を改ページ位置分割するための同じメカニズムを共有しています。
limit: これを n に設定すると、最大 n 個の要素が返されます。既定では、この制限は 10 要素に設定されています。offset: これを n に設定すると、リスト内の位置 n から要素が返されます。デフォルトでは、オフセットはありません。
結果は次の形式で返されます。
{
"items":
{
...
},
"offset": 0,
"limit": 10,
"count": 123
}
ここでは、 items には返された結果項目が含まれ、 count はリストで使用可能な項目の総数を示します。
リソースは、以下のサブセクションに一覧表示されます。
リソース: アラーム
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarms/ |
すべてのアラームとその完全な定義のリストを取得します。アラームごとに、アクティブな設定が返されます。これは、実際にアラームをトリガーするために使用されるものです。これは、アラーム設定の値で上書きされたアラームテンプレートのパラメータで構成されます。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/alarms/{alarm_id}/ |
特定の ID を持つアラームを抑制して、トリガーされないようにします。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarms/{alarm_id}/ |
指定された ID を持つアラームの完全な定義を取得します。アラームに対してアクティブな設定が返されます。これは実際にそれをトリガーするために使用されるものです。config は、アラーム テンプレートのパラメータで構成され、アラーム 設定の値によって上書きされます。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/alarms/{alarm_id}/ |
指定された ID のアラームを削除します。
リソース: アラームメーリングリスト
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/alarm_emails/{alarm_emails_id}/ |
指定した ID でアラームメーリングリストの設定を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarm_emails/{alarm_emails_id}/ |
指定されたIDを持つアラームメーリングリストを取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/alarm_emails/{alarm_emails_id}/ |
指定されたIDを持つアラームメーリングリストを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/alarm_emails/ |
新しいアラームメーリングリストを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarm_emails/ |
すべてのアラームメーリングリストのリストを取得します。
リソース: アラームテンプレート
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/alarm_templates/{alarm_template_id}/ |
特定の ID でアラームテンプレートの設定を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarm_templates/{alarm_template_id}/ |
指定された ID を持つアラームテンプレートの完全な定義を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/alarm_templates/{alarm_template_id}/ |
指定された ID のアラームテンプレートを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/alarm_templates/ |
新しいアラームテンプレートを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/alarm_templates/ |
すべてのアラームテンプレートのリストを取得します。
リソース: 外部 URL 共有
外部 URL 共有は、URL を使用して外部と共有されるテストまたはモニターの結果で構成されます。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/external_url_shares/{share_id}/ |
特定の ID を持つ外部 URL 共有の構成を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/external_url_shares/{share_id}/ |
指定された ID を持つ外部 URL 共有の構成を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/external_url_shares/{share_id}/ |
特定の ID を持つ外部 URL 共有を削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/external_url_shares/ |
新しい外部 URL 共有を作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/external_url_shares/ |
すべての外部 URL 共有の一覧を取得します。
リソース: IPTVチャンネル
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/iptv_channels/{iptv_id}/ |
指定された ID を持つ IPTV チャンネルの設定を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/iptv_channels/{iptv_id}/ |
指定された ID を持つ IPTV チャンネルの設定を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/iptv_channels/{iptv_id}/ |
指定されたIDを持つIPTVチャンネルを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/iptv_channels/ |
新しいIPTVチャンネルを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/iptv_channels/ |
すべてのIPTVチャンネルのリストを取得します。
リソース: モニター
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitors/{monitor_id}/pdf_report |
指定された ID を持つモニター上の PDF レポートを生成します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/monitors/ |
モニターテンプレートに基づいて新しいモニターを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitors/ |
定義されているすべてのモニターのリストと、実行中のSLA履行に関するデータを取得します。SLA の履行は、既定では過去 15 分間に示されます。クエリ文字列パラメーターの開始と終了を使用して、異なる期間を指定できます。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/monitors/{monitor_id}/ |
特定の ID でモニターを開始または停止します。これを行うには、パラメーターを started True または False に設定します。この操作を使用して、モニターの名前や説明を変更したり、構成内のパラメーターを変更したりすることもできます。
| アクション | パス |
|---|---|
| パッチ | /accounts/{account}/monitors/{monitor_id}/ |
特定の ID でモニターを開始または停止します。これを行うには、パラメーターを started True または False に設定します。PATCH を使用して、モニターの名前または説明を変更することもできます。
PATCH を使用して他のモニター・パラメーターを編集することはできません。代わりに PUT を使用する必要があります。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitors/{monitor_id}/ |
特定の ID を持つモニターの完全な定義、実行中の SLA 履行に関するデータ、および連続する時間間隔の包括的なデータ メトリックを取得します (これらの間隔の長さはパラメーターによって resolution 制御されます)。SLA の履行は、既定では過去 15 分間に示されます。クエリ文字列パラメーター start と endを使用して別の期間を指定できます。 – 定期的なテストはモニターの一部として実行されます。タスク task_type の値が periodicの場合、 results リストは常に空になります。代わりに、 executions テストの各実行のテスト ID のリストを含むリストが提供されます。ここに実際の結果があります。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/monitors/{monitor_id}/ |
指定された ID を持つモニターを削除します。
リソース: モニター・テンプレート
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitor_templates/ |
すべてのモニター・テンプレートのリストを取得します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/monitor_templates/import/ |
以前にエクスポートしたモニターテンプレートをインポートします。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitor_templates/{template_id}/ |
指定された ID を持つモニター・テンプレートの完全な定義を取得します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/monitor_templates/export/ |
すべてのモニター テンプレートをエクスポートします。
モニター・テンプレートの作成は、コントロール・センターの Web GUI を使用して行う必要があります。この手順の詳細については、「テストと監視」の「テンプレートの作成」>アプリ内ヘルプを参照してください。
リソース: SIP アカウント
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/sip_accounts/ |
新しい SIP アカウントを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/sip_accounts/ |
すべての SIP アカウントの一覧を取得します。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/sip_accounts/{sip_id}/ |
指定された ID を持つ SIP アカウントの設定を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/sip_accounts/{sip_id}/ |
指定された ID を持つ SIP アカウントの設定を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/sip_accounts/{sip_id}/ |
指定された ID を持つ SIP アカウントを削除します。
リソース: SNMP マネージャ
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/snmp_managers/{snmp_manager_id}/ |
SNMPマネージャーの設定を特定のIDに変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/snmp_managers/{snmp_manager_id}/ |
指定された ID を持つ SNMP マネージャーを取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/snmp_managers/{snmp_manager_id}/ |
特定の ID を持つ SNMP マネージャーを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/snmp_managers/ |
新しいSNMPマネージャーを作成します。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/snmp_managers/ |
すべてのSNMPマネージャーのリストを取得します。
リソース: スピードテスト
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/speedtest/results/ |
すべてのスピードテスト結果のリストを取得します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/speedtest/results/{speedtest_id} |
指定されたインスタンス ID の速度テスト結果を返します。
スピードテストコマンドは、直接使用するためのものではなく、スピードテスト用に設定されたカスタムWebページで使用するためのものです。ドキュメント「 カスタムスピードテストWebページの作成 」を参照してください。
リソース: SSH キー
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/ssh_keys/{ssh_key_id}/ |
指定された ID を持つ SSH キーの設定を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/ssh_keys/{ssh_key_id}/ |
指定された ID を持つ SSH キーを取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/ssh_keys/{ssh_key_id}/ |
指定された ID を持つ SSH キーを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/ssh_keys/ |
新しい SSH キーを追加します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/ssh_keys/ |
すべての SSH キーのリストを取得します。
リソース: タグ
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/tags/ |
新しいタグを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/tags/ |
すべてのタグのリストを取得します。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/tags/{tag_id}/ |
指定された ID のタグを変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/tags/{tag_id}/ |
タグとそれが適用されているすべての項目(モニター、テンプレート、テストエージェント、TWAMPリフレクター)を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/tags/{tag_id}/ |
指定された ID のタグを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/tags/assign/ |
指定したリソースにタグを割り当てます。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/tags/unassign/ |
指定したリソースからタグの割り当てを解除します。
リソース: テスト エージェント
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/test_agents/reboot/ |
ターゲットのテストエージェントで再起動をトリガーします。ターゲットのテストエージェントは、リストで ID を指定するか、「?all」クエリパラメータを使用することで提供できます。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/test_agents/ |
新しい仮想テストエージェントを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_agents/ |
すべてのテストエージェントのリストを取得します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/test_agents/update/ |
テストエージェントを再起動してアップデートします。このアクションを実行するには、すべてのテストエージェントに対して URL にクエリ文字列を追加する ?all 方法と、スキーマに記述されている本文の ID でリストされた特定のテストエージェントに対して実行することができます。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/test_agents/{test_agent_id}/ |
指定された ID を持つテスト エージェントの構成を変更します。PUTメソッドでは、設定全体を指定する必要があります。
| アクション | パス |
|---|---|
| パッチ | /accounts/{account}/test_agents/{test_agent_id}/ |
特定の ID を持つテストエージェントの名前、説明、または GPS 座標を変更できます。注: PATCH を使用して、他のテストエージェントのプロパティを編集することはできません。この目的のために、代わりにPUTを使用する必要があります。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_agents/{test_agent_id}/ |
指定された ID を持つテスト エージェントの構成を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/test_agents/{test_agent_id}/ |
特定の ID を持つテスト エージェントを削除します。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/test_agents/{test_agent_id}/move/ |
特定のIDを持つテストエージェントを別のコントロールセンターに移動します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/test_agents/{test_agent_id}/move/ |
指定したIDを持つテストエージェントから別のコントロールセンターへの移動をキャンセルします。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/test_agents/{test_agent_numeric_id}/wifiscan/ {test_agent_interface_name}/ |
指定されたIDを持つテストエージェントの名前付きインターフェイスでWi-Fiスキャンを開始します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_agents/{test_agent_numeric_id}/wifiscan/ {test_agent_interface_name}/ |
特定のIDを持つテストエージェントの名前付きインターフェイスでのWi-Fiスキャンの結果を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/test_agents/{test_agent_numeric_id}/wifiscan/ {test_agent_interface_name}/ |
指定されたIDを持つテストエージェントの名前付きインターフェイスでWi-Fiスキャンを停止します。
リソース: テスト
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/tests/{test_id}/ |
指定された ID を持つテストの結果を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/tests/{test_id}/ |
指定された ID を持つテストを削除します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/tests/{test_id}/pdf_report |
指定された ID を持つテストに関する PDF レポートを生成します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/tests/ |
テスト テンプレートに基づいてテストを作成し、テストを実行します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/tests/ |
定義されているすべてのテストの一覧を取得します。
リソース: テスト テンプレート
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_templates/ |
すべてのテスト テンプレートの一覧を取得します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_templates/{template_id}/ |
指定された ID を持つテスト テンプレートの完全な定義を取得します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/test_templates/import/ |
以前にエクスポートしたテストテンプレートをインポートします。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/test_templates/export/ |
すべてのテスト テンプレートをエクスポートします。
テスト・テンプレートの作成は、コントロール・センターの Web GUI を使用して行う必要があります。この手順の詳細については、「テストと監視」の「テンプレートの作成」>アプリ内ヘルプを参照してください。
リソース:TWAMP リフレクタ
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/twamp_reflectors/{twamp_id}/ |
指定されたIDを持つTWAMPリフレクタの設定を変更します。
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/twamp_reflectors/{twamp_id}/ |
指定されたIDを持つTWAMPリフレクタの設定を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/twamp_reflectors/{twamp_id}/ |
指定されたIDを持つTWAMPリフレクタを削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/twamp_reflectors/ |
新しい TWAMP リフレクタを作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/twamp_reflectors/ |
すべての TWAMP リフレクタのリストを取得します。
リソース: Y.1731 MEP
| アクション | パス |
|---|---|
| 置く | /accounts/{account}/y1731_meps/{mep_id}/ |
指定された ID を持つ Y.1731 MEP の構成を変更します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/y1731_meps/{mep_id}/ |
指定された ID を持つ Y.1731 MEP の構成を取得します。
| アクション | パス |
|---|---|
| 削除 | /accounts/{account}/y1731_meps/{mep_id}/ |
指定された ID を持つ Y.1731 MEP を削除します。
| アクション | パス |
|---|---|
| 投稿 | /accounts/{account}/y1731_meps/ |
新しい Y.1731 MEP を作成します。
| アクション | パス |
|---|---|
| 取得 | /accounts/{account}/y1731_meps/ |
すべての Y.1731 MEP の一覧を取得します。