ディスク関連API

GET /disk - ディスク一覧を取得
POST /disk - ディスクを作成
GET /disk/:diskid - 該当IDのディスク情報を取得
PUT /disk/:diskid - ディスク情報を更新
DELETE /disk/:diskid - 該当IDのディスクを削除
PUT /disk/:diskid/config - ディスクの内容を書き換える
PUT /disk/:diskid/install - ディスクを再インストール
GET /disk/:diskid/monitor - ディスクのリソースモニタ情報を取得
PUT /disk/:diskid/to/blank - ディスクを空にする
DELETE /disk/:diskid/to/server - ディスクとサーバの接続を解除
PUT /disk/:diskid/to/server/:serverid - ディスクとサーバを接続

GET/disk

ディスク一覧を取得

POST/disk

ディスクを作成

サンプル

ディスクは作成処理受け付け後にHTTPステータスコード201 Createdを返します。作成直後はStatusがavailableになるまで利用できません。

レスポンスボディ

{
  "Disk":{
    "ID":"XXXXXXXXXXXXX",
    "Name":"New Disk",
    "Description":"Creating an empty disk",
    "Connection":"virtio",
    "ConnectionOrder":null,
    "ReinstallCount":0,
    "Availability":"available",
    "SizeMB":20480,
    "MigratedMB":null,
    "WaitingJobCount":null,
    "ServiceClass":"cloud/disk/iscsi/20g",
    "CreatedAt":"2013-01-16T13:00:38+09:00",
    "Plan":{
      "ID":2,
      "StorageClass":"iscsi1204",
      "Name":"ディスク"
    },
    "SourceDisk":null,
    "SourceDiskSnapshot":null,
    "SourceArchive":null,
    "SourceDiskTemplate":null,
    "DiskTemplate":null,
    "Storage":{
      "ID":XXXXXXXXXXXXX,
      "Class":"iscsi1204",
      "Name":"Storage Name",
      "Description":"",
      "Zone":{
        "ID":XXXXX,
        "Name":"ゾーン名",
        "Description":"石狩",
        "VNCProxy":{
          "HostName":"XXX.XXX.XXX.XXX",
          "IPAddress":"XXX.XXX.XXX.XXX"
        },
        "FTPServer":{
          "HostName":"XXX.XXX.XXX.XXX",
          "IPAddress":"XXX.XXX.XXX.XXX"
        },
        "Region":{
          "ID":XXX,
          "Name":"石狩",
          "Description":"石狩",
          "NameServers":["XXX.XXX.XXX.XXX","XXX.XXX.XXX.XXX"]
        }
      },
      "DiskPlan":{
        "ID":"2 ",
        "StorageClass":"iscsi1204",
        "Name":"ディスク"
      },
      "Capacity":[]
    },
    "Server":null
  },
  "Success":"Created",
  "is_ok":true
}

リクエストボディ

// 空ディスク(20GB)の作成例
{
	"Disk":{
		"Name":"New Disk",
		"Description":"Creating an empty disk",
		"Zone":{"ID":31001},
		"Plan":{"ID":2},
		"SizeMB":20480,
		"Connection":"virtio"
	}
}
// ディスクをソースとしてディスクを作成する
{
	"Disk":{
		"Name":"Copied disk",
		"SourceDisk":{"ID":XXXXXXXXXXXX},
		""
	}
}

curl

# 20GBの空ディスクを作成する例
curl --user "Access Token":"Access Token Secret" -X POST \
     -d '{"Disk":{"Name":"New Disk","Zone":{"ID":31001},"Plan":{"ID":2},"SizeMB":20480}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/disk

パラメータ

名前	型	省略	説明
Disk.Name	string	不可	ディスク名
[Disk.Description]	string	可	説明
Disk.Plan.ID	int	不可	ディスクプランID
[Disk.Connection]	EDiskConnection	可	接続タイプ
[Disk.SizeMB]	int	可	空ディスクを作成する場合に、ディスク作成容量(GET /product/disk 参照)
[Disk.SourceDisk.ID]	int	可	ディスクをソースとする場合に、ソースとなるディスクのDisk.ID
[Disk.SourceArchive.ID]	int	可	アーカイブをソースとする場合に、ソースとなるアーカイブのArchive.ID
[Disk.SourceDiskTemplate.ID]	int	可	テンプレートをソースとする場合に、ソースとなるテンプレートのTemplate.ID
[Disk.SourceDiskSnapshot.ID]	int	可	スナップショットをソースとする場合に、ソースとなるスナップショットのSnapshot.ID

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○	○	○	Name : string	○		1~64文字
○		○	○	Description : string		空文字	512文字
○	○	○	○	Connection : EDiskConnection		100
○	○			Availability : EAvailability
○	○	○		SizeMB : int
○	○			MigratedMB : int
○	○			WaitingJobCount : int
○	○			JobStatus : json
○				ServiceClass : string
○	○	○		Plan.ID : int
○	○	○		SourceDisk.ID : int
○	○	○		SourceDiskSnapshot.ID : int
○	○	○		SourceArchive.ID : int
○	○	○		SourceDiskTemplate.ID : int
○	○	○		DiskTemplate.ID : int
○	○			DiskTemplate.Availability : EAvailability
○				DiskTemplate.ServiceClass : string
○	○	○		Storage.ID : int
○				Storage.Description : string
○				Storage.Zone.Description : string
○				Storage.Zone.Region.Description : string
○				Storage.Zone.Region.NameServers : string
○	○			Appliance.ID : int
○				Server.ServerPlan.ServiceClass : string
○	○			Server.ServerPlan.Availability : EAvailability
○				Server.Instance.BeforeStatus : EServerInstanceStatus
○				Server.Instance.StatusChangedAt : date
○				Server.Instance.Host.Zone.Description : string
○				Server.Instance.Host.Zone.Region.Description : string
○				Server.Instance.Host.Zone.Region.NameServers : string
○				Server.Instance.CDROM.Description : string
○	○			Server.Instance.CDROM.Availability : EAvailability
○				Server.Instance.CDROM.ServiceClass : string
○				Server.Instance.CDROMStorage.Description : string
○				Server.Instance.CDROMStorage.Zone.Description : string
○				Server.Instance.CDROMStorage.Zone.Region.Description : string
○				Server.Instance.CDROMStorage.Zone.Region.NameServers : string

GET/disk/:diskid

該当IDのディスク情報を取得

URLパラメータ

Name	Comment
diskid	ディスクID

PUT/disk/:diskid

ディスク情報を更新

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

パラメータを指定したものだけが上書き更新されます。ディスク名、説明文、接続タイプの変更などにお使いいただけます。 ※サーバに接続されているディスクは接続タイプを変更できません。

リクエストボディ

{
	"Disk":{
    "Name":"Disk Name",
    "Description":null,
    "Connection":"virtio"
  }
}

curl

# 接続タイプをvirtioに変更するサンプル
curl --user "Access Token":"Access Token Secret" -X PUT \
		 -d '{"Disk":{"Connection":"virtio"}}' \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/disk/:diskid

URLパラメータ

Name	Comment
diskid	ディスクID

パラメータ

名前	型	省略	説明
[Disk.Name]	string	可	ディスク名
[Disk.Description]	string	可	説明
[Disk.Connection]	EDiskConnection	可	接続タイプ(ide\|virtio)

DELETE/disk/:diskid

該当IDのディスクを削除

URLパラメータ

Name	Comment
diskid	ディスクID

PUT/disk/:diskid/config

ディスクの内容を書き換える

※起動中のサーバのディスクの書き換えはできません。

URLパラメータ

Name	Comment
diskid	ディスクID

パラメータ

名前	型	省略	説明
Password	string	不可	ログインパスワード
[SSHKey.ID]	string	可	登録済みSSHキーのID
[SSHKey.PublicKey]	string	可	新しく登録するSSHキー
[HostName]	string	可	ホスト名（変更しない場合は省略）
[UserIPAddress]	ipaddr	可	eth0のIPアドレス（変更しない場合は省略）
[UserSubnet.DefaultRoute]	ipaddr	可	eth0のデフォルトゲートウェイ（UserIPAddressと同時指定時のみ有効）
[UserSubnet.NetworkMaskLen]	ipaddr	可	eth0のネットワークマスク長（UserIPAddressと同時指定時のみ有効）

PUT/disk/:diskid/install

ディスクを再インストール

URLパラメータ

Name	Comment
diskid	ディスクID

GET/disk/:diskid/monitor

ディスクのリソースモニタ情報を取得

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

URLパラメータ

Name	Comment
diskid	ディスクID

パラメータ

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

PUT/disk/:diskid/to/blank

ディスクを空にする

URLパラメータ

Name	Comment
diskid	ディスクID

DELETE/disk/:diskid/to/server

ディスクとサーバの接続を解除

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

レスポンスボディ

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

curl

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

URLパラメータ

Name	Comment
diskid	ディスクID

PUT/disk/:diskid/to/server/:serverid

ディスクとサーバを接続

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

レスポンスボディ

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

curl

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

URLパラメータ

Name	Comment
diskid	ディスクID
serverid	サーバID