増設ストレージイメージ登録

URL

/v1/expansionstorageimageimport

Method

POST

リクエストヘッダー

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

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

リクエストボディ

本APIが受け取るリクエストパラメーターの一覧をリクエストパラメーター一覧に示す。各パラメーターはリクエストボディにJSON形式で指定する。

表 2. リクエストパラメーター一覧
パラメーター名 説明
name String イメージ名を指定する。
location String

移行元増設ストレージイメージファイルを配置したオブジェクトストレージのURLのパス

以下の形式で指定する。

"/v1/AUTH_<プロジェクトID>/<コンテナ名>/<オブジェクト名>"

checksum String 移行元増設ストレージイメージファイルのSHA1チェックサム値を指定する。

本パラメータを指定することで、オブジェクトストレージにアップロードされた増設ストレージイメージファイルが破損していないかSHA1チェックサム値で検証できる。

id String パラメーター省略時はイメージのIDが自動で採番される。

ユーザーが独自で取得したイメージのIDを利用したい場合は、本パラメータにuuidを指定することが可能。

指定するイメージのIDは、必ず「uuidgen」等のuuid作成用のコマンドで作成したものを使用する必要がある。

レスポンスボディ

本APIが返却するパラメーターの一覧を正常時のレスポンスパラメーター一覧および異常時のレスポンスパラメーター一覧に示す。レスポンスボディはJSON形式で出力される。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示す。

表 3. 正常時のレスポンスパラメーター一覧
パラメーター名 説明
import_id String

インポート処理のID

イメージ登録状況取得を行う場合に用いる。

表 4. 異常時のレスポンスパラメーター一覧
パラメーター名 説明
error_code String 詳細エラーコード
message String 詳細エラーメッセージ

表 5. 詳細エラー情報一覧
ステータスコード 詳細エラーコード 詳細エラーメッセージ 対処方法
400 40001 Required parameter 'name' is not specified. リクエスト内容を修正する。
400 40002 Required parameter 'location' is not specified. リクエスト内容を修正する。
400 40005 Required parameter 'os_type' is not specified. リクエスト内容を修正する。
400 40006 Parameter 'os_type' has invalid value. リクエスト内容を修正する。
400 40011 Project_id does not exist. 認証トークンよりプロジェクトが取得できなかった。認証トークンの見直しを行う。
400 40014 Request body is not a json format. リクエスト内容を修正する。
400 40025 Parameter 'location' has invalid value. リクエスト内容を修正する。
400 40026 Parameter 'conversion' has invalid value. リクエスト内容を修正する。
400 40027 Parameter 'id' has invalid value. リクエスト内容を修正する。
400 40028 Parameter 'name' has invalid value. リクエスト内容を修正する。
400 40031 Parameter 'checksum' has invalid value. リクエスト内容を修正する。
400 40032 Parameter 'min_ram' has invalid value. リクエスト内容を修正する。
400 40033 Parameter 'min_disk' has invalid value. リクエスト内容を修正する。
400 40034 Parameter 'kms' has invalid value. リクエスト内容を修正する。
400 40037 The size of the import image is too large. インポート対象イメージをサイズが小さくなるよう作成しなおす。
403 40301 You cannot execute this API. アカウントの権限を管理者に確認する。
500 50001 Internal server error. サポートに連絡する。
500 50002 Internal server error. サポートに連絡する。
500 50003 Internal server error. サポートに連絡する。
503 50301 Too many requests. 実行したインポート要求の数を確認し、契約あたり100件であれば、他のインポート要求完了後に再実行する。それ以外の場合はサポートに連絡する。

ステータスコード

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

表 6. ステータスコード一覧
ステータスコード 説明
201 インポート処理を正常に開始したことを示す。
400 リクエストが不正であることを示す。
401 トークンが不正であることを示す。
403 インポートの実行権限が存在しないことを示す。
500 内部エラーによりインポート処理が失敗したことを示す。
503 インポート処理の同時実行上限を超える要求であったため失敗したことを示す。

レスポンスボディ例

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

{"import_id":"6bf65660-70ee-4a75-b61a-36ac040c289c"}