VMware Cloud on AWS クラウド クラウド運用・管理

VMware Cloud on AWS の REST API 管理で役立つ「API Explorer」

今回は、VMware Cloud on AWS を REST API で管理する際に役立つ API ツール「API Explorer」の活用方法についてご紹介します。

 

 

API Explorer とは?

API Explorer とは、以前から vSphere Client にも実装されている機能の一つで、REST API の仕様と動作を確認できるツールです。API Explorer は、VMware Cloud on AWS の管理コンソールにも実装されており、管理コンソール画面から VMware Cloud サービスや VMware Cloud on AWS 環境向けの API コールの書式やリソース名、ステータスコードなどがその場で確認できるようになっています(図1)。

図1  VMware Cloud on AWS の API Explorer

 

現時点において API Explorer で確認および実行できる API の対象は、下記の通りです(図2)。

  • VMware Cloud プラットフォーム(サブスクリプションやアカウント管理など)
  • VMware Cloud サービス(インベントリや AWS ネットワーク管理など)
  • VMWare Cloud on AWS(SDDC 全般の管理や NSX ポリシー管理など)
図2   VMware Cloud on AWS の API Explorer でサポートされているカテゴリ

 

この API Explorer は、API コールの対象が予め分類されているので、目的の API を見つけ易いというメリットがあります。

また、API の書式を確認できるだけではなく、その場で実際に API コールを実行することもできます。レスポンス(API コールの実行結果)も直ぐに画面に表示されます。書式やレスポンスをその場で確認しながらコーディングが進められるので、作業効率を高められます!

 

 

API Explorer を試してみる

早速、API Explorer を試してみましょう。API Explorer は、VMware Cloud on AWS の管理コンソールの「デベロッパーセンター」メニューからアクセスできます(図3)。

図3  VMware Cloud on AWS の「デベロッパーセンター」

 

例えば、画面左側から「VMware Cloud on AWS」の「全般」を選択し(図4)、画面右側の「API Categories」から「SDDC」を展開すると、SDDC の管理に関連する API リストが表示されます(図5)。

図4  VMware Cloud on AWS 全般メニューの API リスト

図5  SDDC の API コール一覧

 

その一覧の中から SDDC の情報を取得する GET メソッドの「/orgs/{org}/sddcs/{sddc}」を展開すると、レスポンスコードや API コールで渡すパラメータが判別できます(図6)。

図6  SDDC GET メソッドの詳細画面

 

その画面の下部にある「EXECUTE」ボタンをクリックすると API コールが実行され、直ぐにレスポンスが表示されます(図7)。レスポンスの中身を見ると、SDDC に関する情報(SDDC ID やステータス、Org ID など)が取得できていることがわかります。

図7  SDDC GET メソッドのレスポンス内容

 

 

ネットワーク(NSX-T)関連の管理もサポート

ネットワークに関連する API も実行できます。ネットワークセグメントや Firewall、VPN、NAT などの管理もサポートされていますし、管理系ネットワークの情報などを取得することもできます(図8)。

図8  VMware Cloud on AWS の NSX 向け ポリシー API 一覧(一部のみ)

 

例として、既に SDDC 上に払い出されている「パブリック IP アドレス」の情報を取得してみましょう。画面左側の「NSX VMC AWS 統合 API」を選択して、画面右側の「Cloud, Service, VMC, AWS, Public, Ip」を展開します(図9)。

図9  Public IP の API 一覧

 

そのリストから GET メソッドの「/infra/public-ips」を実行すると、現在 SDDC に払い出されているパブリック IP の一覧が取得できました(図10)。また、一覧の中から一つの項目を展開してみると、この API コールのレスポンスで得られるパラメータ(Public IP の名前や実際のアドレスなど)が確認できます。

図10  Public IP GET メソッドのレスポンス内容

 

 

まとめ

VMware Cloud on AWS は、REST API による制御をサポートしており、ここでご紹介した「API Explorer」のような便利なツールもお使いいただけます。クラウド運用のさらなる効率化にお役立てください。

 

 

関連情報リンク

 

関連記事