REST API

ztC Endurance システムは Representational State Transfer (REST) アプリケーション プログラミング インタフェース (API) をサポートしています。REST API 操作にアクセスすることで、システム情報の収集や管理タスクの実行が可能です。REST API を使用すると、ネットワーク経由で ztC Endurance システムにアクセスできる場所であればどこからでも、システムの監視と管理を行うことができます。

システムは、OpenAPI (Swagger™ とも呼ばれます) 仕様を介して REST API とインタラクティブな REST API ドキュメントを提供します。ドキュメントには ztC Endurance システム上で直接アクセスできます。

ztC Endurance システムの REST API の詳細については、以下のセクションを参照してください。

REST API ドキュメントへのアクセス

Web ブラウザで以下の URL を開きます。これには、ztC Endurance コンソール システムのホスト名または IP アドレスが含まれます。

https://console_hostname_or_IP address/webdoc

たとえば、ztC Endurance コンソールのホスト名が https://sys22-ztcmgmt.ops.yourcompany.com の場合、REST API ドキュメントの URL は https://sys22-ztcmgmt.ops.yourcompany.com/webdoc になります。

この URL を開くと、REST API ドキュメント ページが表示されます。このページには、API の操作と構文に関する説明があり、自身のシステム上で操作を試すために役立つインタフェースが提供されています。

REST API テストのためのログイン

注記: REST API ドキュメント ページのほとんどの操作では、以下の手順を実行する必要はなく、[Execute (実行)] をクリックした後にユーザ名とパスワードを入力するだけで済みます。ただし、REST API ドキュメント ページに記載されているすべての操作を使用したい場合は、以下の手順を実行する必要があります。

  1. REST API ドキュメント ページを開きます。

  2. session_api をクリックして展開します。システムに session_api 操作の構文が表示されます。

  3. POST /sessions をクリックして展開し、次に [Try it out (試す)] をクリックします。

  4. LoginRequest の下にある username および password の隣の string を、実行したい REST API 操作に適切な権限レベルを持つユーザ アカウントのユーザ名とパスワードに置き換えます。以下の例では、新しいユーザ名とパスワードが太字で表示されています。

    {
  "username": "admin",
  "password": "admin"
}

  5. [Execute (実行)] をクリックします。

  6. 下にスクロールして [Server response (サーバの応答)] を表示し、[Response body (応答の本文)] を確認します。操作が成功した場合、応答には REST API セッション認証トークン (authToken) が含まれます。以下の例では、認証トークンが太字で表示されています。操作が成功しなかった場合、応答には、「Unauthorized (未認証)」のようなメッセージが含まれる場合があります。

    {
  "authToken": "a8ab7d17f4f3721494eb646ce81dfc24",
  "email": "jbrown@abccompany.com",
  "maxAge": 600000,
  "role": "admin",
  "status": "success"
}

  7. ログインに成功したら、次のステップで使用するために、引用符で囲まれた認証トークンのテキストをコピーします。

  8. REST API ドキュメント ページの上部の右側にある [Authorize (承認)] をクリックします。

  9. [key (apiKey)] の下の [Value (値)] フィールドに認証トークン文字列を貼り付け、[Authorize (承認)] をクリックします。これにより、REST API ドキュメント ページから「実行」する操作の認証トークンがリクエスト ヘッダーに保存されます。
    10. 注記: トークンは 10 分後に期限切れとなるため、新しいトークンを作成するにはこの手順を繰り返す必要があります。

    トークンをクリアするには、[Authorize (承認)] ダイアログ ボックスの隣にある [Logout (ログアウト)] ボタンを使用します。

  10. [Close (閉じる)] または [X] をクリックしてダイアログを閉じ、REST API ドキュメント ページに戻ります。

  11. REST API テストを行います。