ディスク関連API

GET/bundle

バンドル一覧を取得

GET/bundle/:bundleid

該当IDのバンドルを取得

URLパラメータ

Name Comment
bundleid バンドルID

GET/disk

ディスク一覧を取得

POST/disk

ディスクを作成

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

パラメータ

名前 省略 説明
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

オブジェクト構造

アクセス キー バリデーション
読取 検索 書込 更新 必須 デフォルト 範囲
ID : int  
Name : string 1~64文字
Description : string   空文字 512文字
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  
BundleInfo.ID : int  
BundleInfo.ServiceClass : string  
BundleInfo.Attr : json  
Storage.ID : int  
Storage.Description : string  
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

ディスク情報を更新

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

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|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] ipaddr eth0のネットワークマスク長(UserIPAddressと同時指定時のみ有効)
[Notes] array インストールするスクリプト。各要素には {"ID":"スクリプトID"} を指定します。

PUT/disk/:diskid/install

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

URLパラメータ

Name Comment
diskid ディスクID

GET/disk/:diskid/monitor

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

URLパラメータ

Name Comment
diskid ディスクID

パラメータ

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

PUT/disk/:diskid/resize-partition

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

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

URLパラメータ

Name Comment
diskid ディスクID

GET/disk/:diskid/tag

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

PUT/disk/:diskid/tag

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

PUT/disk/:diskid/to/blank

ディスクを空にする

URLパラメータ

Name Comment
diskid ディスクID

DELETE/disk/:diskid/to/server

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

URLパラメータ

Name Comment
diskid ディスクID

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

ディスクとサーバを接続

URLパラメータ

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

GET/disk/tag

ディスクタグ一覧を取得