サーバ関連API

GET /server - サーバを検索・一覧を取得
POST /server - サーバを作成
GET /server/:serverid - 該当IDのサーバ情報を取得
PUT /server/:serverid - サーバ情報を更新
DELETE /server/:serverid - 該当IDのサーバを削除
GET /server/:serverid/cdrom - 該当IDのサーバに挿入されたISOイメージの状態を取得
PUT /server/:serverid/cdrom - 該当IDのサーバにISOイメージを挿入
DELETE /server/:serverid/cdrom - 該当IDのサーバからISOイメージを排出
GET /server/:serverid/interface - 該当IDのサーバが備えるインタフェースを取得
PUT /server/:serverid/keyboard - 該当IDのサーバのキーボードを押下
GET /server/:serverid/monitor - 該当IDのサーバのリソースモニタ情報を取得
PUT /server/:serverid/mouse/:mouseindex - 該当IDのサーバのマウスを操作
GET /server/:serverid/power - 該当IDのサーバの起動状態を取得
PUT /server/:serverid/power - 該当IDのサーバを起動
DELETE /server/:serverid/power - 該当IDのサーバを停止、または強制停止
PUT /server/:serverid/reset - 該当IDのサーバのリセットボタンを押下
GET /server/:serverid/tag - 該当IDのサーバに付けられたタグを取得
PUT /server/:serverid/tag - 該当IDのサーバに付けられるタグを変更
PUT /server/:serverid/to/plan/:planid - 該当IDのサーバのプランを変更
GET /server/:serverid/vnc/proxy - 該当IDのサーバのVNCプロクシ情報を取得
GET /server/:serverid/vnc/size - 該当IDのサーバの現在の画面サイズを取得
GET /server/:serverid/vnc/snapshot - 該当IDのサーバのVNCスナップショットを取得
GET /server/tag - サーバタグ一覧を取得

GET/server

サーバを検索・一覧を取得

サンプル
- リクエスト
- curl

リクエストボディ

// サーバープランを指定して検索する例
{
  "Filter":{
    "ServerPlan.ID":1
  }
}

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/
# サーバープランを指定して検索する例
curl  --user "Access Token":"Access Token Secret" \
    'https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server?\{"Filter":\{"ServerPlan.ID":1\}\}'

POST/server

サーバを作成

サンプル
- リクエスト
- curl

リクエストボディ

// インターネットに接続するサーバの例
{
  "Server":{
    "Name":"New Server",
    "Description":"Hello Sakura Cloud!",
    "Zone":{"ID":XXXXX},
    "ServerPlan":{"ID":X},
    "Icon":{"ID":"XXXXXXXXXXXX"},
    "Tags":["My Server"],
    "ConnectedSwitches":[{"Scope":"shared"}]
  },
  "Count":0
}

curl

# インターネットに接続するサーバの例
curl --user "Access Token":"Access Token Secret" -X POST \
    -d '{"Server":{"Name":"New Server","Description":"Hello Sakura Cloud!","ServerPlan":{"ID":X},"Icon":{"ID":"XXXXXXXXXXXX"},"Tags":["My Server"],"ConnectedSwitches":[{"Scope":"shared"}]},"Count":0}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server

パラメータ

名前	型	省略	説明
Server.Name	string	不可	サーバ名
[Server.Description]	string	可	説明
Server.ServerPlan.ID	int	不可	サーバプランID
[Server.Icon.ID]	int	可	アイコンID
[Server.Tags]	array	可	タグ（文字列の配列）
[Server.ConnectedSwitches]	array	可	接続するスイッチ。NICと同数の要素数を持つ配列で指定します。各要素は {"Scope":"shared"}（共有セグメント）、{"ID":"スイッチID"}（既存スイッチ）、null（未接続状態）のいずれかを指定しますが、共有セグメントへの接続は0番目の要素（eth0）のみ可能です。
[Server.InterfaceNum]	int	可	NIC数。すべて未接続のNICを作成する際、ConnectedSwitchesの代わりに指定します。

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○	○	○	Name : string	○		1~64文字
○	○	○	○	HostName : string			1~32文字
○		○	○	Description : string		空文字	512文字
○				ServiceClass : string
○	○	○	○	Icon.ID : int
○	○	○		ServerPlan.ID : int	○
○				ServerPlan.ServiceClass : string
○	○			ServerPlan.Availability : EAvailability
○				Zone.ID : int
○				Zone.Description : string
○				Zone.Region.Description : string
○				Zone.Region.NameServers : string
○				Instance.BeforeStatus : EServerInstanceStatus
○				Instance.StatusChangedAt : date
○				Instance.Host.Zone.Description : string
○				Instance.Host.Zone.Region.Description : string
○				Instance.Host.Zone.Region.NameServers : string
○				Instance.CDROM.Description : string
○	○			Instance.CDROM.Availability : EAvailability
○				Instance.CDROM.ServiceClass : string
○				Instance.CDROMStorage.Description : string
○				Instance.CDROMStorage.Zone.Description : string
○				Instance.CDROMStorage.Zone.Region.Description : string
○				Instance.CDROMStorage.Zone.Region.NameServers : string
○				Disks.Storage.MountIndex : int
○				Interfaces.IPAddress : ipaddress
○				Interfaces.UserIPAddress : ipaddress
○				Interfaces.HostName : string
○				Interfaces.Switch.ID : int
○				Interfaces.Switch.Name : string
○				Interfaces.Switch.Scope : EScope
○				Interfaces.Switch.Subnet.ID : int
○				Interfaces.Switch.Subnet.NetworkAddress : string
○				Interfaces.Switch.Subnet.NetworkMaskLen : int
○				Interfaces.Switch.Subnet.DefaultRoute : string
○				Interfaces.Switch.Subnet.Internet.BandWidthMbps : int
○				Interfaces.Switch.UserSubnet.DefaultRoute : string
○				Interfaces.Switch.UserSubnet.NetworkMaskLen : int
○				Interfaces.PacketFilter.ID : int
○				Interfaces.PacketFilter.Name : string
○				Interfaces.PacketFilter.Expression : json
○	○			Appliance.ID : int
		○		Password : string			8~64文字

GET/server/:serverid

該当IDのサーバ情報を取得

サンプル

レスポンスボディ

{
  "Server":{
    "ID":XXXXXXXXXXXX,
    "Icon":null,
  "Disks":[
    {
      "ReinstallCount":0,
      "ID":XXXXXXXXXXXX,
      "Availability":"available",
      "ConnectionOrder":1,
      "Connection":"ide",
      "SizeMB":20480,
      "Storage":{
        "ID":XXXXXXXXXXXX,
        "Class":"iscsi1204",
        "MountIndex":XXXXXXXXXX
      },
      "Name":"Disk Name"
    }
  ],
  "HostName":"localhost",
  "Interfaces":
    [
      {
        "PacketFilter":null,
        "ID":XXXXXXXXXXXX,
        "IPAddress":"XXX.XXX.XXX.XXX",
        "MACAddress":"XX:XX:XX:XX:XX:XX",
        "Switch":{
          "Scope":"shared",
          "ID":"XXXXXXXXXXXX",
          "Name":"Switch Name",
          "Subnet" :
            {
              "ID":null,
              "NetworkMaskLen":XX,
              "NetworkAddress":"XXX.XXX.XXX.XXX",
              "Internet":{"BandWidthMbps":100},
            "DefaultRoute":"XXX.XXX.XXX.XXX"
          }
        },
        "HostName":null
      }
    ],
    "Zone":{
      "ID":XXXXX,
      "FTPServer":{
        "IPAddress":"XXX.XXX.XXX.XXX",
        "HostName":"XXX.XXX.XXX.XXX"
      },
      "VNCProxy":{
        "IPAddress":"XXX.XXX.XXX.XXX",
        "HostName":"XXX.XXX.XXX.XXX"
      },
      "Region":{
        "ID":302,
        "NameServers":["XXX.XXX.XXX.XXX","XXX.XXX.XXX.XXX"],
        "Description":"リージョンの説明文",
        "Name":"リージョン名"
      },
      "Description":"ゾーンの説明文",
      "Name":"ゾーン名"
    },
  "Instance":{
    "Server":{
      "ID":XXXXXXXXXXXX
    },
    "MigrationSchedule":null,
    "BeforeStatus":null,
    "Status":"down",
    "ModifiedAt":"2012-10-05T11:20:31+09:00",
    "StatusChangedAt":null,
    "IsMigrating":null,
    "CDROM":{
      "ID":XXXXXXXXXXXX,
      "ServiceClass":null,
      "Availability":"available",
      "DisplayOrder":XXXXXXXXXXXX,
      "Scope":"shared",
      "CreatedAt":"2012-05-31T17:54:41+09:00",
      "SizeMB":5120,
      "StorageClass":"nfs1109",
      "Name":"debian-6.0.5-i386-netinst",
      "Description":""
    },
    "CDROMStorage":null,
    "MigrationAllowed":null,
    "Host":null,
    "MigrationProgress":null
  },
  "CreatedAt":"2012-10-05T11:02:26+09:00",
  "ServerPlan":{
    "ID":2,
    "ServiceClass":"cloud/plan/2",
    "Availability":"available",
    "CPU":1,
    "MemoryMB":3072,
    "Name":"プラン2"
  },
  "Tags":null,
  "Name":"サーバ名",
  "Description":"サーバ説明文"  
}

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid

Perl

#!/usr/bin/perl
use strict;
use LWP::UserAgent;
use LWP::Authen::Digest;
use Data::Dumper;
use JSON::XS;
my $apiurl = "https://secure.sakura.ad.jp/cloud/api/cloud/1.0/";
my $apikey = "API key";
my $secret = "API secret";
my $serverID = "";
my $ua = LWP::UserAgent->new;
my $url = $apiurl. "server/" . $serverID;
$ua->credentials('secure.sakura.ad.jp:443', 'SAKURA Internet API', $apikey, $secret);
my $res = $ua->get( $url );
my $json = decode_json($res->content);
print Dumper($json);

PUT/server/:serverid

サーバ情報を更新

サンプル
- curl

パラメータにあるもののみを上書き保存します。省略したパラメータは上書きされません。プラン変更、ディスク接続関連、シャットダウンなどはそれぞれ専用のAPIをご使用ください。

curl

# サーバ名を変更する例
curl --user "Access Token":"Access Token Secret" -X PUT \
    -d '{"Server":{"Name":"New Server Update"}}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid
# タグを変更する
# ※既に追加されているタグをそのまま利用する場合は、パラメータに含めてください
curl --user "Access Token":"Access Token Secret" -X PUT \
    -d '{"Server":{"Tags":["Tag1","Tag2"]}}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid

パラメータ

名前	型	省略	説明
[Server.Name]	string	可	サーバ名
[Server.Description]	string	可	説明
[Server.Tags]	array	可	タグ
[Server.Icon.ID]	int	可	アイコンID

DELETE/server/:serverid

該当IDのサーバを削除

{Force:true} を指定しない限りは、サーバが起動している間は削除できません。

パラメータ

名前	型	省略	説明
Force	boolean	不可	強制停止してから削除するときtrue
WithDisk	int\|array	不可	ディスクも一緒に削除するとき、ディスクIDまたはその配列

GET/server/:serverid/cdrom

該当IDのサーバに挿入されたISOイメージの状態を取得

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret"\
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/cdrom

URLパラメータ

Name	Comment
serverid	サーバID

PUT/server/:serverid/cdrom

該当IDのサーバにISOイメージを挿入

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret" -X PUT \
    -d '{"CDROM":{"ID":XXXXXXXXXXXX},"Count":0}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/cdrom

URLパラメータ

Name	Comment
serverid	サーバID

DELETE/server/:serverid/cdrom

該当IDのサーバからISOイメージを排出

サンプル
- curl

curl

curl --user "Access Token":"Access Token Secret" -X DELETE \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/cdrom

URLパラメータ

Name	Comment
serverid	サーバID

GET/server/:serverid/interface

該当IDのサーバが備えるインタフェースを取得

サンプル
- レスポンス
- curl

レスポンスボディ

{
  "From":0,
  "Count":1,
  "Total":1,
  "Interfaces":[{
    "Index":0,
    "ID":"XXXXXXXXXXXX",
    "MACAddress":"XX:XX:XX:XX:XX:XX",
    "IPAddress":"XXX.XXX.XXX.XXX",
    "CreatedAt":"2013-01-17T15:25:50+09:00",
    "Server":...
  }]
}

curl

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/interface

PUT/server/:serverid/keyboard

該当IDのサーバのキーボードを押下

サンプル
- レスポンス
- curl

複数キーを押す場合はKeysに配列を、単一キーを押す場合はKeyにスカラを指定してください。

レスポンスボディ

{
  "Success":true,
  "is_ok":true
}

curl

# Control + Alt + Deleteで再起動する例
curl --user "Access Token":"Access Token Secret" -X PUT \
    -d '{"Keys":["ctrl","alt","delete"]}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/keyboard

URLパラメータ

Name	Comment
serverid	サーバID

パラメータ

名前	型	省略	説明
[Keys]	array	可	押すキー（複数）
[Key]	string	可	押すキー

GET/server/:serverid/monitor

該当IDのサーバのリソースモニタ情報を取得

拡張子に .png を付加して直接imgタグで表示できます。

URLパラメータ

Name	Comment
serverid	サーバID

パラメータ

名前	型	省略	説明
[Start]	time	可	取得範囲の開始時刻（省略時は終了時刻の24時間前または現在時刻）
[End]	time	可	取得範囲の終了時刻（省略時は開始時刻の24時間後）
[NoLegend]	bool	可	凡例を非表示にするときtrue

PUT/server/:serverid/mouse/:mouseindex

該当IDのサーバのマウスを操作

URLパラメータ

Name	Comment
serverid	サーバID
mouseindex	マウスの番号

パラメータ

名前	型	省略	説明
[X]	int	可	X座標
[Y]	int	可	Y座標
[Z]	int	可	ホイール
[Buttons.L]	boolean	可	左ボタンの押下状態。Buttonsが指定されないときはボタンの状態は変化しない。
[Buttons.R]	boolean	可	右ボタンの押下状態。Buttonsが指定されないときはボタンの状態は変化しない。
[Buttons.M]	boolean	可	中ボタンの押下状態。Buttonsが指定されないときはボタンの状態は変化しない。

GET/server/:serverid/power

該当IDのサーバの起動状態を取得

サンプル
- レスポンス
- curl

レスポンスボディ

{
	"Instance":{
		"Server":{"ID":"XXXXXXXXXXXX"},
		"Status":"up",
		"BeforeStatus":"down",
		"StatusChangedAt":"2013-01-11T18:32:51+09:00",
		"MigrationProgress":null,
		"MigrationSchedule":null,
		"IsMigrating":null,
		"MigrationAllowed":null,
		"ModifiedAt":"2013-01-11T18:32:51+09:00",
		"Host":{"SystemVersion":"SAKURA Internet [CLOUD SERVICE 1.2]"},
		"CDROM":null,
		"CDROMStorage":null
	},
	"is_ok":true
}

curl

curl --user "Access Token":"Access Token Secret"\
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/power

URLパラメータ

Name	Comment
serverid	サーバID

PUT/server/:serverid/power

該当IDのサーバを起動

サンプル
- レスポンス
- curl

レスポンスボディ

{
	"Success":true
}

curl

curl --user "Access Token":"Access Token Secret" -X PUT -d '' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/power

URLパラメータ

Name	Comment
serverid	サーバID

DELETE/server/:serverid/power

該当IDのサーバを停止、または強制停止

サンプル
- レスポンス
- curl

レスポンスボディ

{
	"Success":true,
	"is_ok":true
}

curl

# シャットダウン
curl --user "Access Token":"Access Token Secret" -X DELETE -d '' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/power
# 強制停止
curl --user "Access Token":"Access Token Secret" -X DELETE -d '{Force:true}' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/power

URLパラメータ

Name	Comment
serverid	サーバID

パラメータ

名前	型	省略	説明
[Force]	boolean	可	強制停止するときtrue

PUT/server/:serverid/reset

該当IDのサーバのリセットボタンを押下

URLパラメータ

Name	Comment
serverid	サーバID

パラメータ

名前	型	省略	説明
RecycleProcess	boolean	不可	プロセスを最利用するときtrue

GET/server/:serverid/tag

該当IDのサーバに付けられたタグを取得

PUT/server/:serverid/tag

該当IDのサーバに付けられるタグを変更

PUT/server/:serverid/to/plan/:planid

該当IDのサーバのプランを変更

サンプル
- curl

起動中のサーバのプランを変更することはできません。 ※プラン変更を行うとServer.IDが変わります。

curl

curl --user "Access Token":"Access Token Secred" -X PUT \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/to/plan/:planid

URLパラメータ

Name	Comment
serverid	サーバID
planid	サーバプランID

GET/server/:serverid/vnc/proxy

該当IDのサーバのVNCプロクシ情報を取得

サンプル
- レスポンス
- curl

拡張子に .vnc を付加してVNCファイルをダウンロードできます。（VNCビューワと関連付けておくと便利です）。

レスポンスボディ

{
  "Success":true,
  "Status":"OK",
  "Host":"sac-is1a-ssl.sakura.ad.jp",
  "Port":"XXXXX",
  "Password":"...",
  "is_ok":true
}

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/api/cloud/zone/is1a/1.1/server/:serverid/vnc/proxy

URLパラメータ

Name	Comment
serverid	サーバID

GET/server/:serverid/vnc/size

該当IDのサーバの現在の画面サイズを取得

サンプル
- レスポンス
- curl

レスポンスボディ

{
	"Width":"720",
	"Height":"400",
	"is_ok":true
}

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/server/:serverid/vnc/size

URLパラメータ

Name	Comment
serverid	サーバID

GET/server/:serverid/vnc/snapshot

該当IDのサーバのVNCスナップショットを取得

拡張子に .gif を付加して画像ファイルをダウンロードできます。

URLパラメータ

Name	Comment
serverid	サーバID

パラメータ

名前	型	省略	説明
[ScreenSaverExitTimeMS]	int	可	CapsLockキーを2回押すことによりスクリーンセーバを中断する場合の待ち時間[ミリ秒]（ゲストOSの状態により復帰に時間がかかる場合は復帰後の画面を取得できないことに注意）

GET/server/tag

サーバタグ一覧を取得

サンプル
- レスポンス
- curl

レスポンスボディ

{
	"From":0,
	"Count":7,
	"Total":7,
	"Tags":[
		{"Index":0,"Name":"starred","Count":6},
		{"Index":1,"Name":"test","Count":3},
		{"Index":2,"Name":"FreeBSD","Count":1},
		{"Index":3,"Name":"Debian","Count":2},
		{"Index":4,"Name":"CentOS","Count":1},
		{"Index":5,"Name":"production","Count":1},
		{"Index":6,"Name":"development","Count":1}
	],
	"is_ok":true
}

curl

curl --user "Access Token":"Access Token Secret" \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.0/server/tag