イメージエクスポート状況取得

URL

/v1/imageexport/{export_id}/status

※{export_id}はイメージエクスポートAPIが返却するエクスポート処理のID。

Method

GET

リクエストヘッダー

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

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

リクエストボディ

本APIはリクエストボディを受け取らない。指定した場合は無視される。

レスポンスボディ

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

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

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

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

表 2. レスポンスパラメーター一覧
パラメーター名	値	説明
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	エクスポート処理の受付日時。

表 3. エクスポート失敗時のレスポンスパラメーター一覧
パラメーター名	値	説明
error_message	String	詳細エラーメッセージ。

表 4. エクスポート失敗時の詳細エラーメッセージ一覧
メッセージ	発生理由	対処方法
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 (補足情報)	補足情報が上記以外の場合	サポートに連絡する。

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

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

ステータスコード

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

表 7. ステータスコード一覧
ステータスコード	説明
200	イメージエクスポート状況の取得が成功したことを示す。
401	トークンが不正であることを示す。
403	イメージエクスポート状況取得APIの実行権限がないことを示す。
404	URLで指定したexport_idが不正であることを示す。処理状況は、エクスポート処理完了後7日間保持される。7日経過後に本APIを実行した場合、本ステータスコードが返却される。
500	内部エラーによりイメージエクスポート状況の取得が失敗したことを示す。

レスポンスボディ例

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


       {
        "export_status":"succeeded",
        "progress":100,",
        "image_id":"14294f46-d9fe-45bb-ba5f-0b93a69c4416",
        "image_name":"Rocky",
        "storage_container":"/v1/AUTH_100f1c092038413a8dd6771a455b17f5/test_container",
        "request_time":"2016-04-22T00:10:24Z"
       }