イメージ登録

URL

/v1/imageimport

Method

POST

リクエストヘッダー

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

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

リクエストボディ

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

表 2. リクエストパラメーター一覧
パラメーター名 説明
name String イメージ名を指定する。(*1)
location String 移行元VMイメージファイルを配置したオブジェクトストレージのURLの一部。以下の形式で指定する。

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

オブジェクト名は、イメージファイルの拡張子(.vmdk)を含んだ形式である必要がある。

形式が間違っている場合(上記形式ではない、オブジェクト名が.vmdkで終わらない)、存在しないオブジェクトを指定した場合はエラーとなる。

checksum(省略可) String 移行元VMイメージファイルのSHA1チェックサム値を指定する。

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

id(省略可) String パラメーター省略時は IaaS サービス基盤にてイメージのID が自動で採番される。

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

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

min_ram(省略可) int イメージを使用するために必要な最小RAM(MB)を指定する。未指定時は0となる。(*1)
min_disk(省略可) int イメージを使用するために必要な最小ディスク容量(GB)を指定する。未指定時は0となる。(*1)
os_type String
移行元VMイメージ内のOS種別。以下のいずれかを指定する。
キーワード
意味
win2016SE_ja:
Windows Server 2016 SE(日本語版)
win2016SE_en:
Windows Server 2016 SE(英語版)
win2016SE_SQL2016SE:

Windows Server 2016 SE

SQL Server 2016 SE

rhel7:
Red Hat Enterprise Linux 7
rocky:
Rocky Linux
ubuntu:
Ubuntu
※本操作で指定するOS種別はインポートするOSの実態に合ったものを指定する必要がある。実態と異なっている場合は以下の問題が発生する場合がある。
  • 仮想サーバが正常に起動しない。
  • FJcloud-OのサポートやOSサポートが正しく受けられない。
  • 実態と異なるOSサポート費用が請求される。
kms(省略可) hash KMSライセンス認証設定を指定する。省略時は設定処理が行われない。

os_typeにWindows系以外を指定した場合、kmsの値は無視される。

指定する場合、"kms": "{"server_info": "<FQDN>:<ポート番号>", "activate": true}"の形式で記載する。

server_info,activateのどちらも指定しない場合には、この項目も指定しない。

server_info(省略可) String KMSライセンスサーバのFQDNとポート番号を以下の形式で指定する。

"FQDN:ポート番号"

省略時はユーザーズマニュアル表記のリージョン別FQDN+ポート番号(1688)が設定される。

activate boolean KMSライセンス認証のアクティベーションを指定する。trueを指定すること。

(boolean型のため、指定時『"』でくくらないこと)

true:アクティベートする。

*1:サービスに登録されるパラメーター。

*2:vmdk形式のイメージを、FJcloud-Oで処理可能な形式(raw形式)に変換する。

conversion, user_name, password, domain_nameは指定不要となった。

レスポンスボディ

本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"}