【連載】次世代ハイパーコンバージド「HPE SimpliVity」を取り巻くエコシステム ー 第６回 APIでSimpliVityを操作してみよう！その２

[yoshihiko1989]

前回ではSimpliVityをAPIで操作するうえで、REST APIの仕組み、リファレンスの参照の仕方を解説させていただきました。

今回はAPIを気軽にお試しできる「Google POSTMAN」を例にとって、クライアントツールを使用したAPI操作の例をご紹介します。

APIクライアントツール

APIを気軽に試すことのできるツールとして現在主流なものとして、cURLコマンドの活用や、Windows Power Shell、「Google POSTMAN」、「Google Advanced REST Client」などが挙げられます。特に、グーグルより提供されている後者の2つはユーザー目線に立った仕様になっており、初心者でも使いやすいでしょう。

• Google POSTMAN

https://www.getpostman.com/

• Google Advanced REST Client

https://install.advancedrestclient.com/#/install

ちなみに、、、実はHPEもRESTクライアントを提供しています。

• HPE RESTfulインターフェースツール：

https://www.hpe.com/us/en/product-catalog/detail/pip.7630408.html#

 本稿では、機能豊富で使い勝手の良い「Google POSTMAN」を使用してSimpliVityを実際に操作してみたいと思います。

APIでSimpliVityを操作してみよう①：まずはアクセストークン取得

APIで操作する際、まずは対象機器やサービスへのアクセス権限を取得する必要があります。

接続先に合わせた認証情報を利用し、アクセストークンを発行してもらいましょう。

REST APIの規格はステートレス仕様なので、このアクセストークンには有効期限が設けられているのが一般的です。SimpliVityの場合は、アクセストークンは24時間後に失効もしくは、10分間何も操作しないと無効になりますので、その都度再取得する必要があります。

 SimpliVityの場合、ご使用されているOVC（OmniStack Virtual Controller）の管理IPアドレスをエンドポイントとして、アクセスしたい項目毎にパラメータを追加します。

例えば、<192.168.10.242>がOVCの管理IPアドレスの場合は

「https://simplivity@192.168.10.242/api/oauth/token」となります。

 あとは前回ご紹介したリファレンスを参照いただきながら、必要なヘッダー情報、ボディ情報（POSTの場合）を入力。最後に「Send」をクリックすれば、アクセストークンの発行依頼が行われます。

命令が正常実行されれば、HTTPレスポンスは200番台で返ってき、レスポンスボディにJSON形式でアクセストークンが表示されるはずです。

 なお、アクセストークン取得の際には、ボディの記載は”Form-Data”ですのでご注意ください。

APIでSimpliVityを操作してみよう②：仮想マシン情報の取得

無事にアクセストークンを取得できましたら、実際にAPIで操作してみましょう。

まずは仮想マシンの情報を取得（GET）してみたいと思います。 

エンドポイントは先ほどのトークン発行時と少々異なり、https://<OVC Mgmt IP>/apiがベースです。

今回は対象が仮想マシンになりますので、その後方に仮想マシンを意味する「/virtual_machine」を加えて、そのパラメータとしてアクセスしたい仮想マシン名や（本環境ではTestMachine）、オプションを入力します。

データの送受信はJSONフォーマットで行われるため、ヘッダー情報にJSON表記を記載し、先ほど取得したアクセストークンの情報を認証情報として追記してください。

最後に「Send」をクリックすると、次のような形で各種情報を取得できます。

ここで表記されるような様々なID情報は、その他のAPI操作をする際に活用します。

何かタスクを自動化しようとした場合に必要となる、サービス・仮想マシン・ホスト・ポリシー等の情報が示されているわけです。

APIでSimpliVityを操作してみよう③：仮想マシンをバックアップ

最後にSimpliVityのイチ押し機能でもある「バックアップ」をAPIで実施（POST）してみたいと思います。

エンドポイントには、操作例②で取得した仮想マシンのID情報が必要になります。

そろそろ入力の仕方に慣れてきたころでしょうか？

ここで1つTipsをご紹介。

操作例①で実施したトークン発行時のボディ情報の記載方法は、「Form-Data」でしたが、認証系以外は基本的にJSON形式でのやり取りとなるので「raw - json」でボディ情報を記載します。ここでは、バックアップファイル名の指定だけでシンプルに留めていますが、もちろんアプリの静止点連携やバックアップ保存期間などの指示も行うことができます。

2回に渡って、SimpliVityをREST APIで操作する実例をご紹介させていただきましたいたしました。APIで操作できるようになると、AnsibleやChefといった構成管理ツールを活用した『ITサービス全体の自動化』も現実的になってくるでしょう。

次世代のIT運用に近づくためのインフラとしても、ぜひHPE SimpliVityをご活用いただければと思います。