ディスク関連API

GET

/disk

-

ディスク一覧を取得
POST

/disk

-

ディスクを作成
GET

/disk/:diskid

-

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

/disk/:diskid

-

ディスク情報を更新
DELETE

/disk/:diskid

-

該当IDのディスクを削除
PUT

/disk/:diskid/config

-

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

/disk/:diskid/monitor

-

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

/disk/:diskid/plan

-

該当IDのディスクのプランを変更
PUT

/disk/:diskid/resize-partition

-

ディスクのパーティションサイズを最適化する
GET

/disk/:diskid/tag

-

該当IDのディスクに付けられたタグを取得
PUT

/disk/:diskid/tag

-

該当IDのディスクに付けられるタグを変更
DELETE

/disk/:diskid/to/server

-

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

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

-

ディスクとサーバを接続
GET

/disk/tag

-

ディスクタグ一覧を取得

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",
    "Plan":{"ID":2},
    "SizeMB":20480,
    "Connection":"virtio"
  }
}

// ディスクをソースとしてディスクを作成する
{
  "Disk":{
    "Name":"Copied disk",
    "SourceDisk":{"ID":XXXXXXXXXXXX},
    ""
  }
}

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

# 20GBの空ディスクを作成する例
curl -k --user "Access Token":"Access Token Secret" -X POST ^
     -d "{\"Disk\":{\"Name\":\"New Disk\",\"Plan\":{\"ID\":2},\"SizeMB\":20480}}" ^
     -H "Content-type: application/json" ^
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
[Config]	object	可	ディスク作成時にディスク修正をする場合に、ディスク修正のパラメータ
[BootAtAvailable]	bool	可	tureの場合、ディスク作成後、ディスクの接続先のサーバを起動します

オブジェクト構造

アクセス				キー	バリデーション
読取	検索	書込	更新	キー	必須	デフォルト	範囲
○	○			ID : int
○	○	○	○	Name : string	○		1~64文字
○		○	○	Description : string		空文字	512文字
○	○	○		EncryptionAlgorithm : EDiskEncryptionAlgorithm
○	○	○	○	Connection : EDiskConnection		300
○	○			Availability : EAvailability
○	○	○		SizeMB : int
○	○			MigratedMB : int
○	○			WaitingJobCount : int
○	○			JobStatus : json
○				ServiceClass : string
○	○			BundleID : int
○	○	○	○	Icon.ID : int
○	○	○		Plan.ID : int
○	○	○		SourceDisk.ID : int
○	○	○		SourceArchive.ID : int
○	○	○		CryptoKey.ID : int
○	○			CryptoKey.Availability : EAvailability
○	○			BundleInfo.ID : int
○				BundleInfo.ServiceClass : string
○				BundleInfo.Attr : json
○	○	○		Storage.ID : int
○				Storage.Zone.Description : string
○				Storage.Zone.IsDummy : bool
○				Storage.Zone.Region.Description : string
○				Storage.Zone.Region.NameServers : string
○	○			Appliance.ID : int
○				Server.ServerPlan.ServiceClass : string

GET/disk/:diskid

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

URLパラメータ

Name	Comment
diskid	ディスクID

PUT/disk/:diskid

ディスク情報を更新

パラメータを指定したものだけが上書き更新されます。
ディスク名、説明文、接続タイプの変更などにお使いいただけます。
※サーバに接続されているディスクは接続タイプを変更できません。
ディスク修正のエラーを確認後に消去したい場合には ClearJobStatus をご利用ください。

サンプル

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

# 接続タイプを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

# 接続タイプをvirtioに変更するサンプル
curl -k --user "Access Token":"Access Token Secret" -X PUT ^
		 -d "{\"Disk\":{\"Connection\":\"virtio\"}}" ^
     -H "Content-type: application/json" ^
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)
[ClearJobStatus]	bool	可	JobStatus を null に更新（Availability が available の場合のみ指定可能）

DELETE/disk/:diskid

該当IDのディスクを削除

URLパラメータ

Name	Comment
diskid	ディスクID

PUT/disk/:diskid/config

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

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

サンプル
- curl(Linux)
- curl(Windows)

# パブリックのスタートアップスクリプト（Ruby on Rails）を用いてディスク修正をする例
# 使用するスタートアップスクリプト：https://github.com/sakura-internet/cloud-startupscripts/blob/master/publicscript/ruby_on_rails/ruby_on_rails.sh

curl --user "Access Token":"Access Token Secret" \　
    -X PUT \
    -H'Content-Type:application/json' \
    -d '{
      "Background": true,
      "UserSubnet": {
        "NetworkMaskLen": 24
      },
      "Notes": [
        {
          "ID": "112600163620",
          "Variables": {
            "user": "rbenv",
            "ruby_version": "2.6.5",
            "create_gemrc": true
          }
        }
      ],
    }' \
    https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/disk/:diskid/config

# パブリックのスタートアップスクリプト（Ruby on Rails）を用いてディスク修正をする例
# 使用するスタートアップスクリプト：https://github.com/sakura-internet/cloud-startupscripts/blob/master/publicscript/ruby_on_rails/ruby_on_rails.sh

curl -k --user "Access Token":"Access Token Secret" \　
    -X PUT ^
    -H'Content-Type:application/json' ^
    -d "{
      "Background": true,
      "UserSubnet": {
        "NetworkMaskLen": 24
      },
      "Notes": [
        {
          "ID": "112600163620",
          "Variables": {
            "user": "rbenv",
            "ruby_version": "2.6.5",
            "create_gemrc": true
          }
        }
      ],
    }' ^
    -H "Content-type: application/json" ^
https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1/disk/:diskid/config

URLパラメータ

Name	Comment
diskid	ディスクID

パラメータ

名前	型	省略	説明
[Password]	string	可	ログインパスワード（変更しない場合は省略）
[SSHKey.ID\|SSHKeys[i].ID]	string	可	登録済みSSHキーのID
[SSHKey.PublicKey\|SSHKeys[i].PublicKey]	string[]	可	新しく登録するSSHキー
[DisablePWAuth]	bool	可	パスワード/チャレンジレスポンスでのSSHログインを許可しない場合はtrue
[HostName]	string	可	ホスト名（変更しない場合は省略）
[UserIPAddress]	ipaddr	可	eth0のIPアドレス（変更しない場合は省略）
[UserSubnet.DefaultRoute]	ipaddr	可	eth0のデフォルトゲートウェイ（UserIPAddressと同時指定時のみ有効）
[UserSubnet.NetworkMaskLen]	int	可	eth0のネットワークマスク長（UserIPAddressと同時指定時のみ有効、1〜32 の整数）
[EnableDHCP]	bool	可	DHCPを利用する場合にはtrue（UserIPAddressとUserSubnetの値は無視されます）
[ChangePartitionUUID]	bool	可	パーティションのUUIDを変更する場合にはtrue（ディスク作成時にのみ有効）
[Notes]	array	可	インストールするスクリプト。各要素には {"ID":"スクリプトID","Variables":{"変数名": "値"}} を指定します。スクリプト内に変数が存在しない場合はVariablesを省略可。

GET/disk/:diskid/monitor

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

URLパラメータ

Name	Comment
diskid	ディスクID

パラメータ

名前	型	省略	説明
[Start]	time	可	取得範囲の開始時刻（省略時は終了時刻の24時間前または現在時刻）
[End]	time	可	取得範囲の終了時刻（省略時は開始時刻の24時間後）

PUT/disk/:diskid/plan

該当IDのディスクのプランを変更

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

URLパラメータ

Name	Comment
diskid	サーバID

PUT/disk/:diskid/resize-partition

ディスクのパーティションサイズを最適化する

※起動中のサーバのディスクのパーティションサイズの最適化はできません。

URLパラメータ

Name	Comment
diskid	ディスクID

GET/disk/:diskid/tag

該当IDのディスクに付けられたタグを取得

PUT/disk/:diskid/tag

該当IDのディスクに付けられるタグを変更

DELETE/disk/:diskid/to/server

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

サンプル

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

curl -k --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 --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

curl -k --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

GET/disk/tag

ディスクタグ一覧を取得