本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/CreateImage.htmへ移行しました。 今後は新ページをご参照ください。

CreateImage

処理概要

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

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

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

ディスクが接続しているサーバーのイメージ化は、指定したサーバーと同一ゾーンでのみ実行可能です。 イメージ化元サーバーを残さない場合は、関連する付替IPアドレス設定もあわせて解除します。

指定するパラメーター

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

応答フィールド

フィールド (項目) 説明
CreateImageResponse - CreateImageレスポンス
requestId string リクエスト識別子
imageId string イメージID
imageState string イメージのステータス
値:
  • available (利用可能)
  • pending (処理中)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=CreateImage
  &InstanceId=server01
  &Name=customimage
  &CommonParams

  

応答サンプル

    <CreateImageResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <imageId>10021</imageId>
  <imageState>pending</imageState>
</CreateImageResponse>
  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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