イメージ登録状況取得

URL

/v1/imageimport/{import_id}/status

※{import_id}は仮想サーバインポート要求APIが返却するインポート処理のID。

Method

GET

リクエストヘッダー

本APIが受け取るリクエストヘッダーの一覧をリクエストヘッダー一覧に示す。

表 1. リクエストヘッダー一覧
リクエストヘッダー名 値 説明
X-Auth-Token String Identityサービスを使用して取得したトークン。

リクエストボディ

本APIはリクエストパラメーターを受け取らない。指定した場合は無視される。

レスポンスボディ

本APIが返却するパラメーターの一覧をレスポンスパラメーター一覧、インポート失敗時のレスポンスパラメーター一覧、インポート失敗時の詳細エラーメッセージ一覧、失敗時のレスポンスパラメーター一覧に示す。レスポンスボディはJSON形式で出力される。

import_statusがsucceededまたはprocessingの場合、レスポンスパラメーター一覧の内容が返却される。

import_statusがfailedの場合、レスポンスパラメーター一覧、インポート失敗時のレスポンスパラメーター一覧、インポート失敗時の詳細エラーメッセージ一覧の内容が返却される。

API失敗時には、失敗時のレスポンスパラメーター一覧の内容が返却される。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示す。

表 2. レスポンスパラメーター一覧
パラメーター名 値 説明
import_status String インポート処理状況。以下のいずれかの値をとる。

キーワード
意味
succeeded:
インポート処理が正常終了したことを示す。
failed:
インポート処理が失敗したことを示す。
processing:
インポート処理中であることを示す。
queued:
インポート処理実行開始待ちであることを示す。

processingとqueuedの状態を繰り返すことがある。
progress int インポート処理の進捗状況。0～100の範囲の値をとる。
name String イメージ名。
disk_format String サービスに格納するディスク形式。
container_format String サービスに格納するコンテナ形式。
location String 移行元VMイメージファイルを配置したオブジェクトストレージのURL。
id String サービスに登録したイメージの一意なID。
min_ram int イメージを使用するために必要な最小RAM（MB）。
min_disk int イメージを使用するために必要な最小ディスク容量（GB）。
properties String 使用しない値のため""(空値)で表示される。
ovf_location String 使用しない値のため""(空値)で表示される。
conversion boolean イメージ変換を行うか否か。
os_type String 移行元VMイメージ内のOS種別。
user_name String ユーザー名。(*1)
password String *(*1)(*2)
domain_name String ドメイン名。(*1)
kms hash KMSライセンス認証設定。
server_info String KMSライセンスサーバのFQDNとポート番号。
activate boolean KMSライセンス認証のアクティベーション指定。

*1：新バージョンでは本項目は使用しないが、イメージ登録APIのリクエストボディに設定されていた場合のみ、旧バージョンどおり出力される。

*2：イメージ登録APIにて入力値を*に変換し、Base64エンコード済みのパスワード文字列は保存しない。

表 3. リージョン間移行イメージ登録の場合のレスポンスパラメーター一覧
パラメーター名 値 説明
import_status String

インポート処理状況

以下のいずれかの値をとる。

キーワード
意味
succeeded:
インポート処理が正常終了したことを示す。
failed:
インポート処理が失敗したことを示す。
processing:
インポート処理中であることを示す。
queued:
インポート処理実行開始待ちであることを示す。

processingとqueuedの状態を繰り返すことがある。
progress int

インポート処理の進捗状況

0～100の範囲の値をとる。
name String イメージ名
disk_format String サービスに格納するディスク形式
container_format String サービスに格納するコンテナ形式
location String 移行元VMイメージファイルを配置したオブジェクトストレージのURL
id String サービスに登録したイメージの一意なID
min_ram int イメージを使用するために必要な最小RAM（MB）
min_disk int イメージを使用するために必要な最小ディスク容量（GB）
billing_info object 課金情報
  base_image_id String 移行元イメージのベースイメージID
os_type String 移行元イメージのOS種別
表 4. インポート失敗時のレスポンスパラメーター一覧
パラメーター名 値 説明
message String 詳細エラーメッセージ。

表 5. インポート失敗時の詳細エラーメッセージ一覧
メッセージ 発生原因 対処方法
Specified image is not found. locationに指定したイメージがオブジェクトストレージに存在しない。 locationパラメーターで指定したパスにファイルが存在することを確認する。
Specified id already exists. 既に、インポート登録を受け付けたIDを指定した。 再生成したUUIDを使ってイメージ登録APIを実行する。
Import process has stopped unexpectedly. インポート処理が停止した。 サポートに連絡する。
Import process takes too long time. インポート処理開始から、7日間が経っても処理が終わらなかった。 インポートする仮想サーバイメージサイズを縮小する。現象が解決しない場合は、サポートに連絡する。
VMimport process is failed (補足情報) 補足情報が"fail to convert image"の場合

インポートする仮想サーバイメージに誤りがある。

 インポートする仮想サーバイメージを見直す。
VMimport process is failed (補足情報) 補足情報が"fail to download image"の場合

インポートする仮想サーバイメージの取得中にタイムアウトが発生。

 イメージ登録APIを再実行する。
VMimport process is failed (補足情報) 補足情報が" fail to upload image"の場合

progress = 85未満:
イメージ登録処理中にタイムアウトが発生。
progress = 85以上:
イメージ登録APIで指定したパラメーターに誤りがある。

progress = 85未満:
イメージ登録APIを再実行する 。
progress = 85以上:
イメージ登録APIのパラメーターを修正して、再実行する 。
VMimport process is failed (補足情報) 補足情報が上記以外の場合 サポートに連絡する。

表 6. 失敗時のレスポンスパラメーター一覧
パラメーター名 値 説明
error_code String 詳細エラーコード。
message String 詳細エラーメッセージ。

表 7. 詳細エラー情報一覧
ステータスコード 詳細エラーコード 詳細エラーメッセージ 対処方法
403 40301 You cannot execute this API. アカウントの権限を管理者に確認する。
404 40401 Invalid import_id. リクエストのURLを修正する。
500 50001 Internal server error. サポートに連絡する。
500 50002 Internal server error. サポートに連絡する。

ステータスコード

本APIが返却するステータスコードの一覧をステータスコード一覧に示す。

表 8. ステータスコード一覧
ステータスコード 説明
200 仮想サーバインポート処理状況の取得が成功したことを示す。
401 トークンが不正であることを示す。
403 仮想サーバインポートの実行権限が存在しないことを示す。
404 URLで指定したimport_idが不正であることを示す。

処理状況は、インポート処理完了後7日間保持する。7日経過後に本APIを実行した場合、本ステータスコードを返却する。
500 内部エラーにより仮想サーバインポート処理状況の取得が失敗したことを示す。

レスポンスボディ例

レスポンスボディの例を以下に示す。

{
  "import_status":"succeeded",
  "progress":100,"name":"sample_image",
  "disk_format":"raw",
  "container_format":"bare",
  "location":"/v1/AUTH_100f1c092038413a8dd6771a455b17f5/test_container/test_image.vmdk",
  "id":"14294f46-d9fe-45bb-ba5f-0b93a69c4416",
  "min_ram":0,
  "min_disk":0,
  "properties":{},
  "ovf_location":"",
  "conversion":true,
  "os_type":"rocky",
  "user_name":"testuser",
  "password":"*",
  "domain_name":"testdomain",
  "kms":{"server_info":"kms.jp-east-1.cloud.global.fujitsu.com:1688","activate":true}
}

リージョン間移行イメージ登録APIで登録したイメージの登録状況例

{
  "import_status":"succeeded",
  "progress":100,
  "name":"sample_image",
  "disk_format":"raw",
  "container_format":"bare",
  "location":"/v1/AUTH_100f1c092038413a8dd6771a455b17f5/test_container/test_image.img.gz",
  "id":"14294f46-d9fe-45bb-ba5f-0b93a69c4416",
  "min_ram":0,
  "min_disk":0,
  "billing_info": {
    "os_type": "rocky",
    "base_image_id": "b163e880e533f28a9cbc72a1fd7189f2"
  }
}