Postmanを利用してAPIを便利に使う

 はじめに

vSphere API を例として、以下の方法を紹介します。
    • Postman に vSphere API を Import する
    • Postman から vSphere API を実行する
    • 実行した API のコードを取り出す（cURL and Python）

Postman をインストール

何も難しいことはありません。

以下のサイトからダウンロードして、Installer を実行すればよいだけです。

https://www.postman.com/downloads/


Postman の利用にはアカウント登録が必要になるようです。Google アカウントを利用することもできますし、Postman 用にアカウントを作成しても構いません。


vSphere API の Spec ファイルを入手する

以下の github から入手できます。 

https://github.com/vmware/vsphere-automation-sdk-rest/find/master



上記の4つのJsonファイルがありますので、それぞれを開きます。



開いたページで "Raw" のボタンがあるので、右クリックして



"Save link as..." を選んで、PC にファイルとして保存します。

この４つのファイルが vSphere API の API Spec ファイルです。


Spec ファイルを Import する


保存したものを Postman に Import します。

左上の Import ボタンを押して、



ファイルをアップロードします。



すると、Postman の Collections のタブに Import した vSphere API が現れます。


これで Import 完了です。



Postman に vSphere 用の環境変数を登録して、API を実行する

Postman に環境変数を登録しておくと非常に便利です。
毎回、IPアドレスや認証情報を入力しなくてすみます。


下図はvSphere API の Login を実施している様子です。
このまま Send ボタンを押してもリクエストは失敗します。
環境変数を設定することでリクエストが成功します。



上記の {{vc}} や、 {{user}} 、 {{password}} が環境変数に該当します。
右上のアイコンから環境変数を設定できます。



Add ボタンを押して環境変数のグループと、グループ配下の環境変数を設定します。



下図のように環境変数グループ（vSphere 7 ）を設定し、環境変数として、 vc, user, password を設定します。 




環境変数グループを設定したら、右上のドロップダウンリストから、作成したグループを選択します。



この状態で最初の Login リクエストを実施すると今後は成功します。
Response Body に"value"として ID が返ってきていることがわかります。




上記の実行後、Postman の右側 Cookie ボタンから Cookie を確認します。
vmware-api-session-id が格納されていることが確認できると思います。





この状態でほかのリクエストを実施してみます。
試しに https://{{vc}}/rest/vcenter/host を実行してみます。





上記を実行するとリクエストが成功し、host の情報が返されることが確認できるはずです。




cURL や python での実行コードを表示する

Postman の右側にある Code のボタンを押すと、同じリクエストをその他のプログラミング言語で実施する際のコードを表示することができます。

以下は python のコードを表示しているところです。



しかしながら、このままでは SSL 証明書のチェックで引っかかりますので、コードを利用する場合は、SSL 証明書のチェックを無効にしたほうが良いです。

以下の例では、verify=False を追加してます。
コードをコピーする際は右上のアイコンからコピーすると便利です。



cURL の場合は以下です。 -k を追加すると証明書のチェックを無効化できます。 




まとめ

この記事では、Postman に vSphere API の Spec ファイルをインポートし、vSphere API を実行したのちに、コードを表示する手順を説明しました。特に vSphere API に限らず、REST API であれば全般的に利用できる手法ですので、普段ご利用の API のテストやプログラミング言語への実装などの際にご活用ください。 

 

 

 

 

 

 

コメント

コメントを投稿

このブログの人気の投稿

vSwitchにSTPが不要な理由

イメージ
  ** 知っている人にとっては当たり前の内容です**     ESXiは多くの場合、冗長構成をとるために二つ以上のNICを利用し、それぞれ単一、もしくは別個の物理スイッチに接続されていると思います。 ESXiの物理NICはuplinkまたはvmnicとよばれ、ESXi内部にある仮想スイッチ（vSwitch）につながっています。 vSwitchはL2SWとしての役割をするため、物理スイッチをESXiの接続はスイッチ間接続となります。   図１：ネットワークトポロジ     vSwitchが物理スイッチと同等の動作をすると仮定した場合、この構成はループに相当します。 L2レベルでループがある場合は、ブロードキャストストームなどの問題が発生するためにSpanning Tree Protocol（STP）を設定する必要（最近では必ずしもそうとは言い切れないようですが。。。）があります。   ではvSwitchの場合でもSpanning Treeに参加する（ネットワークは専門外なので表現が間違っていたらすみません。。。）必要があるのでしょうか？ 表題からもわかるように答えはNoです。 L2ネットワークでBPDUと呼ばれるパケットをやり取りすることで Spanning Treeが構成されますが、実際に、vSwitchではこのBPDUをDropしますので、vSwitchのUplinkがBlockされることはありません。   ではなぜ、vSwitchではトポロジ的にLoopであるにもかかわらずSpanning Treeが不要なのでしょうか？Loopによる問題は発生しないのでしょうか？   実はvSwitchはFloodingが必要な通信に対して特殊な動作をします。 その特殊動作のため、トポロジ的にLoopであっても問題は発生せず、Spanning Treeに参加する必要がないのです。   たとえば、ARPなどの外部からのブロードキャストフレームをuplink経由でvSwitchが受け取った場合、vSwitchに接続されるVMに対してはフレームを転送しますが、ほかのUplinkに対してはフレームを転送しません。   下図ではUplink1からBroadcast Packetを受信した際の動作を示しています。 Broadcast Packetは仮想スイッチに接続されるVMに対して転送
続きを読む

ESXi に DNS サーバを何個まで登録できるか

イメージ
ESXi の DNS サーバの最大登録可能数を調べる vSphere 構築経験のある多くの方は2つまでとお答えになるかもしれない。 なぜならば、DCUI や vSphere Client から設定した場合、Primary DNS と Alternative DNS の2つまでしか設定できないからだ。 GUI から設定する場合、苦し紛れにカンマ区切りなどで3つ以上登録しようと試みても無駄である。GUI でエラーになってはじかれるだけだ。 ならば、CLI はどうか。 /etc/resolv.conf に手動で追記していくだけであればストレージの許す限り記載することはできるだろうが、 この方法は当然ながら標準的な手順ではない。 esxcli を利用して DNS を登録することも可能である。具体的には以下のコマンドを利用する esxcli network ip dns server add -s <ip_address> 上記のコマンドを利用してどこまで登録可能かを試してみた。 具体的には以下のコマンドを用いて255個のDNSサーバを追加してみた for i in `seq 1 255`; do esxcli network ip dns server add -s 192.0.2.$i ;done なお、本ブログで記載される IP Address は例示用に予約されたものであり、RFC5737 から拝借している。 結果として、少々時間はかかるが登録自体は問題なく成功した。 実環境においてこれほど多くの DNS の登録をすることはあり得ないので、事実上制限なしと考えられる。 なお、参考のために他ベンダーも含める形で DNS 登録数の最大数を調べたところ、2 か 3 にしているところが多いようだ。 DNS を大量に登録した際の動作を調べる DNS クエリのタイムアウト時間：5 秒則 ESXi の DNS Client は最近の systemd-resolved などではなく、レガシーなソフトウェアであるため、 resolv.conf の上から順番に問い合わせていき、問合せ先の DNS に到達できなかった場合に次の DNS サーバに問い合わせる動作になる。 次の DNS サーバに問い合わせる条件はあくまでも到達できなかった場合であり、到達できた
続きを読む

障害でVDSから切断されたVCSAの復旧方法

この投稿は vExpert Advent Calendarの10日目です。 https://adventar.org/calendars/6689 本記事では以下の状況と、簡易な復旧方法について説明します。 環境 vCSAは自身が管理するvSphere Cluster上に存在する。 vCSAは自身が管理する vDSに接続される vCSAが接続されるdvportgroupはEphemeralではない 該当のvCSA以外にvSphere Clusterを管理できる vCSA は存在しない  障害状況 vCSAは何らかの理由により、もともと存在していたESXiから、別のESXiに再登録されている。 vCSAはvDSから切断されてしまっている。 解説 上記の状況は、ESXiの障害などによって副次的に発生しうる状況です。もともと、vCSA は vDS に接続されていましたが、ESXi の障害などにより、いったん Guest OS から Shutdown され、Host Client を利用して別の ESXi に再登録したうえで起動しています。 この場合、もともとvCSAが接続されていたdvportは別の ESXi 上のポートであるため、起動時にvCSAはvNICを接続することができず、切断状態となります。 vCSAが切断状態になり、かつESXiのHost Clientからは仮想マシンをvDSに接続することができないため（Ephemeral Port を除く）、vCSAの復旧が困難となります。  この状況において有効な解決策としては事前に用意しておいたEphemeral Port を利用するか、もしくは一時的にVSSを作成して復旧する方法が一般的な方法です。 事前にEphemeral Port の準備がない場合には、VSSを作成することになりますが、Uplinkに空きがない場合は、Uplinkを付け替える必要があり、手順は複雑になります。 今回はVSSを利用しない簡易な復旧方法についてご紹介します。 簡易な復旧方法 完結に手順を示すと以下です。 vNICが切断されているVCSAをShutdown  vCSAが存在する ESXi を Maintenance Mode～Reboot  vCSA を再度起動～vNICが接続状態であることを確認  上記に示した通り、ESXiをリブート
続きを読む