本文へジャンプします。

ニフティクラウド APIリファレンス

DetachVolume

処理概要

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

ディスクを指定するためには、ディスク名が必要です。解除済み・削除済みのディスクを指定した、管理外のディスクを指定した、起動中・停止中以外のサーバーを指定したなど、無効なディスクを指定した場合は、エラーが返されます。

またサーバーを指定するためには、サーバー名が必要です。解除済み・削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。サーバー名を指定せずに解除すると、指定したディスクのすべての接続情報を解除します。

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
VolumeId ディスク名
Type : String
disk02
InstanceId サーバー名
Type : String
Default : 指定ディスクに接続済みかつ解除可能なすべてのサーバー
   
Device ※指定不可
Type : String
   
Force ※指定不可
Type : Boolean
   
Agreement 起動中のサーバーを指定した場合の処理続行フラグ
Type : Boolean
値 : true (解除実施) | false (解除中断)
Default : false
   

応答フィールド

フィールド(項目) 説明 サンプル値
DetachVolumeResponse DetachVolumeレスポンス
Type : DetachVolumeResponseType
Ancestor : なし
Children : requestId, volumeId, instanceId, instanceUniqueId, device, status, attachTime
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DetachVolumeResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
volumeId ディスク名
Type : xsd:string
Ancestor : DetachVolumeResponse
Children : なし
disk02
instanceId サーバー名
Type : xsd:string
Ancestor : DetachVolumeResponse
Children : なし
server04
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : DetachVolumeResponse
Children : なし
i-efgj1234
device ディスクの接続デバイス
Type : xsd:string
値 : SCSI(xx:xx)
Ancestor : DetachVolumeResponse
Children : なし
SCSI(0:1)
status 接続ステータス
Type : xsd:string
値 : attaching (接続中) | attached (接続済み) | detaching (接続解除中) | detached (未接続)
Ancestor : DetachVolumeResponse
Children : なし
detaching
attachTime 接続日時(表示形式:yyyy-mm-ddThh:mi:ss.sssZ)
Type : xsd:dateTime
Ancestor : DetachVolumeResponse
Children : なし
2010-05-17T11:22:33.456Z

リクエストサンプル

 https://cp.cloud.nifty.com/api/?Action=DetachVolume&VolumeId=disk02&InstanceId=server04&Agreement=true&CommonParams

応答サンプル

 <DetachVolumeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</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.456Z</attachTime>
 </DetachVolumeResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上