2.3.21 DestroyNic (指定したNICをサーバから削除)

指定したNICをサーバから削除します。

サーバ仮想化ソフトウェアが、VMware、Hyper-V、およびRHEL-KVMのサーバにだけ実行可能です。

対象のサーバにスナップショットが存在する場合、NICの削除はできません。

以下の場合、本APIは実行できません。

対象のL-Platform内にBladeLogicで管理されていないSolarisゾーンのサーバが存在する場合
対象のL-Platform内にOVM for SPARC管理のサーバが存在する場合

注意

ゲストOSにNICの設定が実施されている状態で、NICの削除操作をしても、ゲストOS上のNICの設定は削除されません。NICの削除操作をする前に、ゲストOSでNICの設定を削除してください。

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	L-Platform APIのバージョンID
	型	string ASCII
	設定内容	固定。"2.0"を指定してください。
Locale	説明	L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。・"ja": 日本語・"en": 英語
Action	説明	実行するL-Platform APIの名称
	型	string ASCII
	設定内容	固定。"DestroyNic"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
lplatformId	説明	ネットワークを削除するL-PlatformのID
	型	string ASCII
	設定内容	32文字以内
lserverId	説明	サーバID
	型	string ASCII
	設定内容	32文字以内
nicNo	説明	NIC番号
	型	string ASCII
	設定内容	削除するNICの番号を指定してください。1以上の値を指定してください。
[force]	説明	サーバロードバランサーの分散対象になっているNICを強制的に削除するかを表します。
	型	string ASCII
	設定内容	以下のどちらかを指定します。・true: 強制削除する・false: 強制削除しない省略した場合の既定値は、"false" です。

レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<DestroyNicResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</DestroyNicResponse>

《要素》

要素名	項目	項目説明
DestroyNicResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<DestroyNicResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroyNicResponse>