APIをテストするためのシステム イベント メッセージの作成

管理APIをテストする簡単な方法は、システム イベント ログにメッセージを作成することです。

開始する前に

API Docs(Swagger)ページにログインしている必要があります。これにより、認証トークン、Eメール アドレス、APIバージョンが各APIエンドポイントの対応するフィールドに自動的に挿入されます。

タスク概要

システム イベントを作成するには、API Docsページを使用します。イベントが作成されたら、次の2つの方法でメッセージを表示できます。
  • API Docs(Swagger)ページのGET関数を使用する
  • NAS Bridgeのユーザ インターフェイスを使用する

手順

  1. API Docsページで、[system_events]をクリックします。
  2. [POST]をクリックして、新しいシステム イベントを作成するために使用するAPI呼び出しを表示します。
    POST API呼び出しが表示されます。Webページの上部で正常にログインした場合は、バージョン、Eメール アドレス(ユーザ アカウント)、認証トークンが自動的にページに入力されます。
  3. テスト メッセージ、重大度(値のリストから選択)、およびテスト ファシリティを入力します。


    テスト メッセージの例

  4. [Try it out]をクリックします。


    応答の本文の例

    応答コード200は成功を示します。
  5. 新しいメッセージが作成されたことを確認するために、次の作業を行います。
    • API Docsページで、[system_events] > [GET]をクリックし、Eメール アドレスと認証トークンのフィールドが設定されていることを確認します。qパラメータを使用して、作成したメッセージ テキストの全体または一部を含むメッセージだけに結果が限定されるようにします。次に、[Try it out]をクリックして作成したメッセージをリストします。


      システム イベントを取得する例


      応答の本文の例

    • NAS Bridgeのユーザ インターフェイスで、[Alarms]をクリックし、イベントをフィルタリングまたはソートして、投稿(POST)したメッセージを見つけます。


      [Maintenance] > [Events]の例