APIを活用しよう - PHPで簡易コントロールパネルを作る

こんにちは、ちなつです。

今回は、携帯を含む様々なWeb系のシステム開発に携わり、iPhone/Androidアプリなどの開発も手がけているライター・わたなべ氏の記事をご紹介します。

（＊本記事の最後にわたなべ氏のプロフィールを掲載しています）

*********************************************************************

今回は前回までの非公式PHP SDKの解説を踏まえて、CakePHPで簡易的なコントロールパネルを作ってみたので紹介してみたいと思います。

今回実装したのは以下の3つの機能になります。

• サーバーの一覧表示
• サーバーの起動
• サーバーの停止

今回はCakePHPのブラグインとして実装したので、比較的簡単に皆さんのプロジェクトにも組み込んで使っていただけるのでは無いかと思います。

*今回公開するプラグインには認証機能などは含まれていませんので、制限のかかっていない環境への配置は絶対にしないでください！

ではまずはインストール方法から説明します。

CakePHPの設定

まずは、通常通り最新のCakePHPを以下からダウンロードし展開し、通常通りの初期設定をします。

cd [インストール先]
wget --output-document=cakephp-1.3.11.tgz https://github.com/cakephp/cakephp/tarball/1.3.11
tar xvfz cakephp-1.3.11.tgz
mv cakephp-cakephp-3b830a4 controllpanel
cd controllpanel
chmod -R go+w ./app/tmp
vim ./app/config/core.php
# Security.saltとSecurity.cipherSeedを修正
cp ./app/config/database.php.default ./app/config/database.php
# defaultのデータソースに接続可能なデータベースを設定

CakePHPの設定に関しては、以前書いた記事や設定用スクリプトも参考にしてみてください。

設定完了後、CakePHPを配置したURLにアクセスすると以下のように表示されると思います。

今回のプラグインを試用するだけであればデータベースは使用しないのですが、なにも設定しないとエラーが出てしまうので接続可能なデータベースの設定をしてください。

PHP SDK／プラグインの設置

つぎに、以下の手順で非公式PHP SDKと今回作成したプラグインをダウンロードして配置します。

# SDKの配置
cd APP/vendors
wget --output-document=phpsdk-0.2a.tgz https://github.com/kaz29/unofficial-niftycloud-sdk-for-php/zipball/v0.2a
mv kaz29-unofficial-niftycloud-sdk-for-php-e051b0f niftycloud
# プラグインの配置
cd APP/plugins
wget --output-document=nifty_cloud_controll_panel_plugin.tgz https://github.com/kaz29/nifty_cloud_controll_panel_plugin/tarball/master
mv kaz29-nifty_cloud_controll_panel_plugin-ee66b20 nifty_cloud_controll_panel

API認証キーの設定

次に、使用するNifty Cloud アカウントのAPI認証キーを登録します。
NiftyCloudのコントロールパネル上の「API認証」よりREST用認証キーを作成し以下のように設定します。

cd APP
vim config/core.php
# ファイルの最後に以下の様に認証キーの設定を追加します。
Configure::write('nifty_cloud', array(
	'secret_key' => "シークレットアクセスキーを入力",
	'access_key' => "アクセスキーを入力",
));

これでプラグインの準備は完了です。

サーバー一覧

CakePHPを配置したURL配下の以下のURLにアクセスすると、サーバーの一覧が表示されます。

http://[path to cakephp]/nifty_cloud_controll_panel/instances

解説

一覧表示用の処理は、instances_controller.php の indexアクションになります。CakePHPを使った事がある方ならお分かりかと思いますが、普通にデータベースからデータを表示する場合と全く同じで、Instance モデルの findメソッドを呼んでビューにセットしています。

# controllers/instances_controller.php - indexメソッド
function index() 
{
	$this->Instance->recursive = 0;
	$this->set('instances', $this->Instance->find('all'));
}

では、findメソッドは何をしているかというとこんな感じ...

# models/instance.php
public function find($type)
{
  if (is_null($this->api)) {
    $config = Configure::read('nifty_cloud');
    $this->api = new NiftyCloud($config);
  }
  
  $result = false ;
  $api_result = $this->api->describe_instances();
  if ( $this->api->isError() ) {
    $result = array();
  } else {
    $result = array();
    foreach($api_result->reservationSet->item as $item) {
      $launch_time = date('Y/m/d H:i:s',strtotime((string)$item->instancesSet->item->launchTime));
      $result[] = array(
        $this->alias => array(
          'id' => (string)$item->instancesSet->item->instanceId,
          'type' => (string)$item->instancesSet->item->instanceType,
          'image_id' => (string)$item->instancesSet->item->imageId,
          'global_ip' => (string)$item->instancesSet->item->dnsName,
          'local_ip' => (string)$item->instancesSet->item->privateDnsName,
          'status' => (string)$item->instancesSet->item->instanceState->name,
          'launch_time' => $launch_time,
          'description' => (string)$item->instancesSet->item->description,
        )
      );
    }
  }
  
  return $result;
}

PHP SDKを使用し describe_instances メソッドを呼んで、レスポンスデータを元に標準的なCakePHPの形式の配列を生成しているだけです。

サーバー起動

サーバーの起動画面は下記のようになっています。

解説

以下がコントローラ、モデルのコードですが、こちらもコントローラのアクションは通常のCakePHPアプリとほぼ同様です。Instanceモデルのstopメソッドでは、PHP SDK用のパラメータを生成して、start_instancesを呼び出しています。

* 今回は、OSイメージの一覧やサーバータイプ一覧は実装を出来るだけシンプルする為に、instances_controller内に固定データとして定義しています。

# controller/instances_controller.php - startアクション
public function start($id=null)
{
  if ( empty($this->data) ) {
    $this->data = array(
      'Instance' => array(
        'id' => $id,
      )
    );
    
  } else {
    $this->Instance->create();
    $this->Instance->set($this->data);
    $result = $this->Instance->start();
    if ( $result === true ) {
      $this->Session->setFlash(__('The instance has been started', true));
      $this->redirect(array('action' => 'index'));
    } else {
      $this->Session->setFlash(__('The instance could not be start. Please, try again.', true));
    }
  }
}
# models/instance.php - startメソッド
public function start()
{
  if (is_null($this->api)) {
    $config = Configure::read('nifty_cloud');
    $this->api = new NiftyCloud($config);
  }

  $params = array(

    'InstanceId'      => array($this->data[$this->alias]['id']),

    'InstanceType'    => array($this->data[$this->alias]['instance_type']),

    'AccountingType'  => array($this->data[$this->alias]['accounting_type']),

  );

  

  $api_result = $this->api->start_instances($params);

  return !$this->api->isError();

}

stop_instancesはstart_instanceと内容的にあまり差異もないので説明は省略します。

おまけ

今回、web経由でのサーバー起動/停止のみですが、おまけとしてCakePHPのシェルコマンドでも同様の操作が出来る機能も実装しました。
それぞれ下記のようにコマンドラインから実行出来ます。

# サーバーの起動
# accounting_type: 1=月額課金,2=従量課金
cake start_instance -id サーバー名 -instance_type mini -accounting_type 2
# サーバーの停止
# コマンドラインパラメータに '-force' を指定すると強制終了になります
cake start_instance -id サーバー名

CLIを使えば色々な操作がコマンドラインからできますが、まぁPHPからも出来たら良いよねってことでおまけでした。

まとめ

APIを使えばサーバーの操作はとても簡単に実装出来るのでいろいろ試して自動化出来ると面白いのではないかと思います。
今回作成したプラグインはgithubにあげてあります。これを拡張すれば例えば、ユーザー毎に操作出来るサーバーを限定するとかいろいろ出来ると思います。是非試してみてください。

------------------------------------
プロフィール

  ライターネーム：わたなべ　かずひろ

専門学校卒業後、ソフトウェア開発会社で電力系統制御
システムの開発に従事。
その後、CD-ROM等マルチメディア系PCソフトの開発を
経て、1998年フリーランスに。
2000年8月に株式会社イーツーの設立に参画。
携帯を含む様々なWeb系のシステム開発に携わる。
現在はiPhone/Androidアプリなどの開発も手がけている。
------------------------------------