API Explorer では、選択したエンドポイントから使用可能な vSphere REST API を取得して、API 呼び出しに関する情報やコンテキストを提供します。

手順

  1. vSphere Client のホーム ページで [ デベロッパー センター] をクリックし、[API Explorer] タブを選択します。
  2. [エンドポイントを選択] ドロップダウン メニューで、使用環境のエンドポイントを選択します。
  3. [API を選択] ドロップダウン メニューで、API を選択します。表示される API は、vCenter Server で API Explorer によって公開されたものです。
  4. （オプション） フィルタ テキスト ボックスにテキストを入力すると、結果をフィルタリングできます。たとえば、health と入力すると、選択した API の健全性の監視に関連するメソッドのリストが表示されます。
  5. リストから API カテゴリを選択します。
  6. リストからメソッドを選択します。
    廃止された API を確認するには、リストの各メソッドの横にある切り替えボタンを使用します。廃止された API を使用しないでください。廃止された API は、今後応答しなくなる可能性があります。また、自動化スクリプトで予期しないエラーが発生する可能性があります。
    メソッドの詳細情報が表示されます。
  7. 選択したメソッドのパラメータの詳細に関するセクションが表示される場合は、[Value] テキスト ボックスにメソッド パラメータ値を入力します。
  8. （オプション） ライブ環境に対してメソッドを呼び出すには、[実行] をクリックします。
    1. 警告ダイアログ ボックスが表示された場合は、[Yes] をクリックします。
    呼び出したメソッドの結果が応答ボックスに表示されます。
  9. （オプション） 呼び出したメソッドの結果をクリップボードにコピーするには、[応答 をコピー] をクリックします。
  10. （オプション） 呼び出したメソッドの結果をダウンロードするには、[ダウンロード] をクリックします。