API エクスプローラについて

組織の所有者は、Cloud Services コンソールで [API エクスプローラ] にアクセスして組織内で使用可能なすべての VMware Cloud services API を検索します。

以下を行うことができます。

• Cloud Services コンソールから API を直接呼び出します。
• API 構造を参照します。
• API 呼び出しをライブで試行し、サービス内の一般的な機能に対して開発する方法を学習します。

API の操作を開始するには、Cloud Services コンソールにログインし、[デベロッパ センター] > [API エクスプローラ] の順に移動します。

上のスクリーンショットに示すように、[API エクスプローラ] 画面は、使用可能な API の選択、組織の環境およびサービス情報のコピー、選択した API の操作が可能な複数のセクションに分かれています。

使用可能な API

[API エクスプローラ] 画面の [使用可能な API] セクションでは、組織環境の API を参照できます。画面の左側にあるいずれかの API リンクをクリックすると、次の情報が表示されます。

• 各カテゴリ内の特定の API に関する情報。
• 選択したカテゴリに表示されている API のいずれかの一部として返される可能性のあるオブジェクト モデル/データ構造のリスト。このリストには、API 呼び出しの応答に含まれる可能性のある内容の詳細も含まれています。

API カテゴリの詳細については、「 デベロッパ センターで使用可能な API」を参照してください。

環境

[API エクスプローラ] 画面の [環境] セクションでは、次のような一部の API で一般的に必要とされるパラメータを表示およびコピーできます。

• [組織名]：ログインしている組織の名前。
• [組織 ID]：ログインしている組織の ID。
• [認証トークン]：ベアラー トークンと組み合わせ、API 呼び出しの認証ヘッダーで使用できます。
• [サービス]：ドロップダウンからサービスを選択し、コピー アイコンをクリックすると、選択したサービス ID がコピーされます。

サービス情報

[サービス情報] セクションは、 [使用可能な API] リストから API を選択すると表示されます。ここでは、特定の API カテゴリから API を呼び出す際に使用するベース URL を表示およびコピーできます。