Export an Image for Migration between Regions#
リージョン間移行対象のイメージをエクスポートします。
本APIでは、リージョン間移行に必要なファイルを、オブジェクトストレージに格納します。
エクスポート状況は、本APIのレスポンスに出力される「export_id」をキーに、「Retrieve image export status」、「Retrieve the status of the image export list」を使用して確認します。また、エクスポートを中止する場合は「Cancel image export」を使用します。
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#
POST
/v1/regionmigrationexport
HTTPステータスコード#
正常時：202
エラー時：400, 401, 403, 405, 500, 503
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値/必須指定 | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| X-Auth-Token | header | string | 必須 | Identityサービスを使用して取得したトークン | ||||||
| image_id | body | string | 必須 | エクスポート対象イメージに割り当てられたIDを指定します。 存在しないイメージのIDを指定した場合はエラーになります。 |
||||||
| storage_container | body | string | 必須 | エクスポートしたイメージファイル(raw+gzip形式)が格納されるオブジェクトストレージのURLのパス 以下の形式で指定します。 "/v2/AUTH_<プロジェクトID>/<コンテナ名>" |
||||||
| details | body | object | 任意 | エクスポート方式の詳細を設定します。 本パラメータを指定する場合、"details": {"file_type": "<file_typeパラメータの値>"}の形式で記載します。 |
||||||
| file_type | body | string | 任意 | エクスポートするファイル形式を指定します。 省略時は".qcow2.gz"が指定されます。以下のどちらかの値が指定できます。
|
レスポンスボディ#
本APIが返却するパラメーターの一覧を正常時のレスポンスパラメーター一覧および失敗時のレスポンスパラメーター一覧に示します。レスポンスボディはJSON形式で出力されます。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示します。
表 1. 正常時のレスポンスパラメーター一覧
| 名前 | Type | Description |
|---|---|---|
| export_id | string | エクスポート処理のIDが出力されます。状況取得を行う場合に使用します。 |
表 2. 失敗時のレスポンスパラメーター一覧
| パラメーター名 | 値 | 説明 |
|---|---|---|
| error_code | string | 詳細エラーコード |
| error_message | string | 詳細エラーメッセージ |
表 3. 詳細エラー情報一覧
| ステータスコード | 詳細エラーコード | 詳細エラーメッセージ | 対処方法 |
|---|---|---|---|
| 400 | 40001 | Required parameter 'image_id' is not specified. | リクエスト内容を修正します。 |
| 400 | 40002 | Parameter 'image_id' has invalid value. | リクエスト内容を修正します。 |
| 400 | 40003 | Required parameter 'storage_container' is not specified. | リクエスト内容を修正します。 |
| 400 | 40004 | Parameter 'storage_container' has invalid value. | リクエスト内容を修正します。 |
| 400 | 40005 | Project id does not exist. | 認証スコープ省略またはプロジェクト指定で取得したトークンを設定します。 |
| 400 | 40007 | Request body does not exist. | リクエスト内容を修正します。 |
| 400 | 40008 | Request body is not a json format. | リクエスト内容を修正します。 |
| 400 | 40011 | The size of the export image is too large. | エクスポート対象イメージをサイズが小さくなるよう作成しなおします。 |
| 400 | 40015 | The same request already exists. | リクエスト内容を修正します。 |
| 400 | 40016 | The exported file already exists. | リクエスト内容を修正します。 |
| 400 | 40062 | Invalid parameter.(item='%s') | 指定されたパラメータの形式、値に誤りがあります(対象パラメータ名)。リクエスト内容を修正します。 |
| 403 | 40301 | You cannot execute this API. | アカウントの権限を管理者に確認します。 |
| 500 | 50001 | Internal server error. | サポートに連絡してください。 |
| 500 | 50002 | Internal server error. | サポートに連絡してください。 |
| 503 | 50301 | Too many requests. | 時間を置いてから本APIを再実行してください。 |
リクエスト例#
{"image_id":"6bf65660-70ee-4a75-b61a-36ac040c289c","storage_container":"/v2/AUTH_790f1c092038413a8dd6771a033b17f5/container1"}
レスポンス例#
{"export_id":"6bf65660-70ee-4a75-b61a-36ac040c289c"}