Retrieve image export status#

イメージエクスポートの状況を取得します。

APIエンドポイント#

リージョン	APIエンドポイント
西日本リージョン3の場合	https://import-export.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://import-export.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/imageexport/{export_id}/status

HTTPステータスコード#

正常時：200

エラー時：401, 403, 404, 500

リクエストパラメータの説明#

名前	In	Type	デフォルト値 /必須指定	Description
X-Auth-Token	header	string	必須	Identityサービスを使用して取得したトークン
export_id	path	string	必須	イメージエクスポートAPIが返却するエクスポート処理のID

レスポンスボディの説明#

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

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

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

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

表 1. レスポンスパラメーター一覧

名前

Type

Description

export_status

string

エクスポート処理状況
以下のいずれかの値をとります。

キーワード	意味
succeeded	エクスポート処理が正常終了したことを示す。
failed	エクスポート処理が失敗したことを示す。
processing	エクスポート処理中であることを示す。
queued	エクスポート処理が実行開始待ちであることを示す。
cancelling	エクスポート処理が中止途中であることを示す。
canceled	エクスポート処理が中止したことを示す。 processingとqueuedの状態を繰り返すことがあります。

progress

int

エクスポート処理の進捗状況
0～100の範囲の値をとります。

image_id

string

エクスポート対象イメージに割り当てられたID

image_name

string

エクスポート対象イメージの名称

storage_container

string

エクスポートしたイメージファイルが配置されるオブジェクトストレージのURLのパス

request_time

string

エクスポート処理の受付日時

details

object

エクスポート方式の詳細

image_from

string

移行元仮想環境

image_to

string

移行先仮想環境

file_type

string

エクスポート対象イメージのファイル形式

表 2. エクスポート失敗時のレスポンスパラメーター一覧

パラメーター名	値	説明
error_message	string	詳細エラーメッセージ

表 3. エクスポート失敗時の詳細エラーメッセージ一覧

メッセージ	発生理由	対処方法
Specified id is not found.	指定したIDのイメージが存在しない。	指定したIDのイメージが存在することを確認します。
Specified id is not valid image.	指定したIDがエクスポート処理で有効なイメージでない。	指定したIDのイメージがエクスポート処理の対象イメージであることを確認します。
Export process has stopped unexpectedly.	エクスポート処理が停止した。	サポートに連絡してください。
Cancel process has stopped unexpectedly.	中止処理が停止した。	サポートに連絡してください。
Export process takes too long time.	エクスポート処理開始から、7日間が経っても処理が終わらなかった。	サポートに連絡してください。
VMexport process is failed (補足情報)	補足情報が"fail to download image"または"fail to upload image"の場合	イメージエクスポートAPIを再実行してください。再度同様のメッセージが出力される場合は、サポートに連絡してください。
VMexport process is failed (補足情報)	補足情報が上記以外の場合	サポートに連絡してください。

表 4. 失敗時のレスポンスパラメーター一覧

パラメーター名	値	説明
error_code	string	詳細エラーコード
error_message	string	詳細エラーメッセージ

表 5. 詳細エラー情報一覧

ステータスコード	詳細エラーコード	詳細エラーメッセージ	対処方法
403	40301	You cannot execute this API.	アカウントの権限を管理者に確認します。
404	40401	Invalid export_id.	リクエストのURLを修正します。
500	50001	Internal server error.	サポートに連絡してください。
500	50002	Internal server error.	サポートに連絡してください。

レスポンス例#

       {
        "export_status":"succeeded",
        "progress":100,
        "image_id":"14294f46-d9fe-45bb-ba5f-0b93a69c4416",
        "image_name":"Rocky",
        "storage_container":"/v2/AUTH_100f1c092038413a8dd6771a455b17f5/test_container",
        "request_time":"2016-04-22T00:10:24Z",
        "details":{"image_from":"fj_cloud","image_to":"vmware","file_type":".vmdk"}
       }