ニフクラAPI (コンピューティング: DetachVolume)

DetachVolume

処理概要

指定したディスクとサーバーの接続を解除します。

ディスクを指定するためには、ディスク名が必要です。

また、サーバーを指定するためにはサーバー名が必要です。サーバー名を指定せずに解除すると、指定したディスクのすべての接続情報を解除します。

起動中のサーバーからディスクを解除する場合、OS上で必ず対象ディスクの認識を外してから実行してください。
OSが対象ディスクを認識したまま解除すると、サーバーが異常な状態になります。

ディスクの認識を外すには、下記ページの手順をご確認ください。

ユーザーガイド：ディスクの認識を外す設定方法（アンマウント手順）：Linux系OSの場合

指定するパラメーター

パラメーター	型	説明	必須
VolumeId	string	ディスク名	○
InstanceId	string	サーバー名 Default: 指定ディスクに接続済みかつ解除可能なすべてのサーバー
Device	string	※指定不可
Force	boolean	※指定不可
Agreement	boolean	起動中のサーバーを指定した場合の処理続行フラグ 値: True (解除実施) False (解除中断) Default: False

応答フィールド

フィールド (項目)	型	説明
DetachVolumeResponse	-	DetachVolumeレスポンス Ancestor: なし Children: requestId | volumeId | instanceId | instanceUniqueId | device | status | attachTime
requestId	string	リクエスト識別子 Ancestor: DetachVolumeResponse Children: なし
volumeId	string	ディスク名 Ancestor: DetachVolumeResponse Children: なし
instanceId	string	サーバー名 Ancestor: DetachVolumeResponse Children: なし
instanceUniqueId	string	サーバーユニークID Ancestor: DetachVolumeResponse Children: なし
device	string	ディスクの接続デバイス 値: SCSI(xx:xx) Ancestor: DetachVolumeResponse Children: なし
status	string	接続ステータス 値: attaching (接続中) attached (接続済み) detaching (接続解除中) detached (未接続) Ancestor: DetachVolumeResponse Children: なし
attachTime	timestamp	接続日時 値: yyyy-mm-ddThh:mi:ss.sssZ Ancestor: DetachVolumeResponse Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DetachVolume
  &VolumeId=disk02
  &InstanceId=server04
  &Agreement=true
  &CommonParams

  

応答サンプル

    <DetachVolumeResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <volumeId>disk02</volumeId>
  <instanceId>server04</instanceId>
  <instanceUniqueId>i-efgj1234</instanceUniqueId>
  <device>SCSI(0:1)</device>
  <status>detaching</status>
  <attachTime>2010-05-17T11:22:33.456+09:00</attachTime>
</DetachVolumeResponse>