2017.05.23

SkyOnDemand APIによる連携サーバーの管理

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

製品開発部の中山です。
今回はSkyOnDemand APIをご紹介します。

新機能のテストや実験のため、運用中の連携サーバーを複製したい場面は多いものです。
連携サーバーの複製には、サーバを新しく作成し、設定をインポートするという手順を踏む必要があります。

この一連の操作は管理画面から行うことも可能ですが、SkyOnDemand APIでも実現できます。

APIを利用する場合の具体的な手順は以下のようになります。

  1. 連携サーバーを作成する
  2. 連携サーバーが使用可能になるまで待つ
  3. 設定をインポートする

では、順に試してみましょう。

1. 連携サーバーを作成する

サーバー作成はPOSTリクエストになります。(パス中の「契約ID」は、お客様ごとに固有の識別子です)
リクエストボディには、必要なパラメータをxml形式で指定します。

サーバー作成





サーバー作成は非同期に実行されるので、成功の場合には応答コード202が返されます。

SkyOnDemandの管理画面を確認すると、サーバーが作成されたことが分かります。

サーバー一覧

2. サーバーが利用可能になるまで待つ

作成されたばかりのサーバーの処理状況は「準備中」となります。
設定をインポートするには、サーバーの初期化処理が完了し、「利用可能」になるまで待たなければなりません。

サーバー一覧(API)

数分おきにサーバー状態取得APIを呼び出すと...

サーバー一覧(API-2)

しばらくして、「利用可能」になりました。

3. 設定をインポートする

(準備)

APIを実行する前に、複製元のサーバーから設定をエクスポートします。
エクスポートの方法は、
連携サーバー間で設定を移行するをご参照ください。

以下、設定エクスポートしたものを「パッケージ」と呼びます。

3-1 パッケージを登録する

パッケージの登録は、マルチパートリクエストで行います。
先ほど作成したエクスポートファイルをそのままアップロードすればOKです。

パッケージ登録

登録に成功すると、応答コード201が返されます。
APIで登録内容を確認してみましょう。

パッケージ一覧

無事、登録されていることが分かりました。

3-2. パッケージをインポートする

これまでのAPIで取得したサーバーID、パッケージIDを使用して、パッケージのインポートを実行します。
パッケージのインポートは非同期で実行され、連携サーバーの再起動を伴います。

インポート

WebStudioでログインすると、サーバー設定が複製されていることが確認できました。 

WebStudio

おわりに

SkyOnDemand APIを利用して、連携サーバーを複製する方法をご説明しました。

APIにはこの他、以下のような機能があります。

  • IPフィルター設定の追加・変更
  • HTTPトリガー設定の追加・変更
  • WebDAV設定の追加・変更
  • 連携サーバーの再起動
  • アダプタのインポート
  • グローバルリソース設定の変更

これらのAPIを組み合わせることにより、SkyOnDemand活用の可能性がさらに広がりますね。

なお、SkyOnDemand APIのご利用には弊社にて設定変更が必要です。
ご利用を希望される際はご一報ください。

1 件

関連する記事