Web Services APIへのログイン

Web Services Proxyをインストールしたら、ブラウザから対話型のAPIドキュメントにアクセスできます。

開始する前に

タスク概要

APIドキュメントはWeb Servicesの各インスタンスと一緒に実行されるほか、ネットアップ サポート サイトからPDF版を入手することもできます。対話型のバージョンにアクセスするには、ブラウザを開き、Web Servicesの場所(組み込みバージョンの場合はコントローラ、プロキシの場合はサーバ)を示すURLを入力します。
注:Web Services APIはOpenAPI仕様(旧称Swagger仕様)を実装しています。

初回ログイン時は「admin」クレデンシャルを使用します。「admin」は、すべての機能とロールにアクセスできるスーパー管理者とみなされます。

手順

  1. ブラウザを開きます。
  2. 組み込み実装またはプロキシ実装のURLを入力します。
    • 組み込み:https://<controller>:<port>/devmgr/docs/
      注:このURLで、<controller>はコントローラのIPアドレスまたはFQDN、<port>はコントローラの管理ポート番号(デフォルトは8443)です。
    • プロキシ:http[s]://<server>:<port>/devmgr/docs/
      注:このURLで、<server>はプロキシがインストールされているサーバのIPアドレスまたはFQDN、<port>はリスニング ポート番号(デフォルトはHTTPが8080、HTTPSが8443)です。
    注:リスニング ポートがすでに使用されている場合は競合が検出され、別のリスニング ポートを選択するように求められます。
    ブラウザでAPIドキュメントが開きます。
  3. 対話型のAPIドキュメントを開いたら、ページ右上のドロップダウン メニューから[utils]を選択します。
  4. [Login]カテゴリをクリックし、使用可能なエンドポイントを表示します。
  5. [POST: /login]エンドポイントをクリックし、[Try it out]をクリックします。
  6. 初めてのログインの場合は、ユーザ名とパスワードに「admin」と入力します。
  7. [Execute]をクリックします。
  8. ストレージ管理用のエンドポイントにアクセスするには、右上のドロップダウン メニューから[v2]を選択します。
    エンドポイントの上位レベルのカテゴリが表示されます。APIドキュメントのナビゲート方法を以下に示します。
    要素 説明
    ドロップダウン メニュー

    ページ右上にあるドロップダウン メニューで、APIドキュメントのバージョン2(V2)、SYMbolインターフェイス(SYMbol V2)、ログイン用のAPIユーティリティ(utils)を切り替えることができます。

    注:APIドキュメントのバージョン1はプレリリース版であり、一般には提供されていないため、V1はドロップダウン メニューに含まれていません。
    カテゴリ APIドキュメントは、上位レベルのカテゴリ(AdministrationやConfigurationなど)別に編成されています。カテゴリをクリックすると、関連するエンドポイントが表示されます。
    エンドポイント エンドポイントを選択すると、そのエンドポイントのURLパス、必須パラメータ、応答本文、およびURLから返される可能性があるステータス コードが表示されます。
    Try It Out

    エンドポイントを直接操作するには、[Try it out]をクリックします。このボタンは、エンドポイント用の各ビューにあります。

    このボタンをクリックすると、パラメータを入力するためのフィールドが表示されます(該当する場合)。値を入力し、[Execute]をクリックします。

    対話型ドキュメントでは、JavaScriptを使用して直接APIに要求が送信されます。テスト要求ではありません。