リージョン間移行イメージエクスポート
リージョン間移行対象のイメージをエクスポートします。
本APIでは、リージョン間移行に必要なファイルを、オブジェクトストレージに格納します。
エクスポート状況は、本APIのレスポンスに出力される「export_id」をキーに、「イメージエクスポート状況取得」、「イメージエクスポート状況一覧取得」を使用して確認します。また、エクスポートを中止する場合は「イメージエクスポート中止」を使用します。
URL
/v1/regionmigrationexport
Method
POST
リクエストヘッダー
本APIが受け取るリクエストヘッダーの一覧をリクエストヘッダー一覧に示す。
| リクエストヘッダー名 | 値 | 説明 |
|---|---|---|
| X-Auth-Token | String | Identityサービスを使用して取得したトークン |
リクエストボディ
本APIが受け取るリクエストパラメーターの一覧をリクエストパラメーター一覧に示す。各パラメーターはリクエストボディにJSON形式で指定する。
| パラメーター名 | 値 | 説明 |
|---|---|---|
| image_id | String | エクスポート対象イメージに割り当てられたIDを指定する。 存在しないイメージのIDを指定した場合はエラーとなる。 |
| storage_container | String |
エクスポートしたイメージファイルが格納されるオブジェクトストレージのURLのパス 以下の形式で指定する。 "/v1/AUTH_<プロジェクトID>/<コンテナ名>" |
レスポンスボディ
本APIが返却するパラメーターの一覧を正常時のレスポンスパラメーター一覧および異常時のレスポンスパラメーター一覧に示す。レスポンスボディはJSON形式で出力される。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示す。
| パラメーター名 | 値 | 説明 |
|---|---|---|
| export_id | String |
エクスポート処理のID 状況取得を行う場合に用いる。 |
| パラメーター名 | 値 | 説明 |
|---|---|---|
| error_code | String | 詳細エラーコード |
| error_message | String | 詳細エラーメッセージ |
| ステータスコード | 詳細エラーコード | 詳細エラーメッセージ | 対処方法 |
|---|---|---|---|
| 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. | リクエスト内容を修正する。 |
| 403 | 40301 | You cannot execute this API. | アカウントの権限を管理者に確認する。 |
| 500 | 50001 | Internal server error. | サポートに連絡する。 |
| 500 | 50002 | Internal server error. | サポートに連絡する。 |
ステータスコード
本APIが返却するステータスコードの一覧をステータスコード一覧に示す。
| ステータスコード | 説明 |
|---|---|
| 202 | イメージエクスポート処理が正常に開始したことを示す。 |
| 400 | リクエストが不正であることを示す。 |
| 401 | トークンが不正であることを示す。 |
| 403 | イメージエクスポートAPIの実行権限がないことを示す。 |
| 405 | 不正なメソッドによるアクセスであることを示す。 |
| 500 | 内部エラーによりイメージエクスポート処理が失敗したことを示す。 |
| 503 | イメージエクスポート処理の同時実行上限を超える要求であったため失敗したことを示す。 |
リクエストボディ例
リクエストボディの例を以下に示す。
{
"image_id":"6bf65660-70ee-4a75-b61a-36ac040c289c",
"storage_container":"/v1/AUTH_790f1c092038413a8dd6771a033b17f5/container1"
}レスポンスボディ例
レスポンスボディの例を以下に示す。
{"export_id":"6bf65660-70ee-4a75-b61a-36ac040c289c"}