本文へジャンプします。

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

CreateImage

処理概要

指定したサーバーをイメージ化し、カスタマイズイメージとして保存します。

サーバーをイメージ化するためには、サーバーが停止中もしくは起動中である必要があります。

カスタマイズイメージの作成には、時間がかかることがあります。このAPIのレスポンス「imageState」を確認し「pending」が返ってきた、タイムアウトした場合は、API「DescribeImages」のレスポンス値「imageState」でカスタマイズイメージのステータスを確認できます。

処理が失敗した場合、カスタマイズイメージは保存されず、エラーが返されます。
ディスクが接続しているサーバーのイメージ化は、指定したサーバーと同一ゾーンでのみ実行可能です。

イメージ化元サーバーを残さない場合は、関連する付替IPアドレス設定もあわせて解除します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId イメージ化元サーバー
Type : String
Default : なし
server01
Name イメージ名
Type : String
customimage
Description メモ
Type : String
   
NoReboot ※指定不可
Type : Boolean
   
LeftInstance イメージ化元サーバーを残す
Type : Boolean
値: true (サーバーを残す) | false (サーバーを残さない)
Default : true (サーバーを残す)
   
Placement.RegionName リージョン情報
Type: String
Default: リクエスト先エンドポイントのリージョン
   
Placement.AvailabilityZone ゾーン情報
Type: String
Default: サーバーのゾーン(リージョン指定なし)またはリージョン内のゾーンからニフティクラウドが決定(リージョン指定あり)
   

応答フィールド

フィールド(項目) 説明 サンプル値
CreateImageResponse CreateImageレスポンス
Type : CreateImageResponseType
Ancestor : なし
Children : requestId, imageId, imageState
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CreateImageResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
imageId イメージID
Type : xsd:string
Ancestor : CreateImageResponse
Children : なし
10021
imageState イメージのステータス
Type : xsd:string
値 : available (利用可能) | pending (処理中)
Ancestor : CreateImageResponse
Children : なし
pending

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CreateImage&InstanceId=server01&Name=customimage
&CommonParams

応答サンプル

<CreateImageResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
 <imageId>10021</imageId>
 <imageState>pending</imageState>
</CreateImageResponse>

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

APIメニュー

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

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