Register an Image#

イメージを登録します。

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/imageimport

HTTPステータスコード#

正常時：201

エラー時：400, 401, 403, 500, 503

リクエストパラメータの説明#

名前

In

Type

デフォルト値
/必須指定

Description

X-Auth-Token

header

string

必須

Identityサービスを使用して取得したトークン

name

body

string

必須

イメージ名を指定します。(*1)

location

body

string

任意

移行元イメージファイルを配置したオブジェクトストレージ[Swift互換]のURLの一部
以下の形式で指定します。
"/v2/AUTH_<プロジェクトID>/<コンテナ名>/<オブジェクト名>"
オブジェクト名は、イメージファイルの拡張子を含んだ形式です。
利用可能なイメージ形式、拡張子は、パラメータ：detailsの指定（image_from）によって切り替わります。

「image_from」の値	利用可能なイメージ形式(拡張子)
vmware	vmdk形式(.vmdk)
kvm	qcow2形式(.qcow2)

形式が間違っている場合（上記形式ではない、オブジェクト名が指定拡張子で終わらない）、または存在しないオブジェクトを指定した場合はエラーが発生します。
s3_locationを省略する場合は必須です。

s3_location

body

string

任意

移行元イメージファイルを配置したオブジェクトストレージ[S3互換]のURLの一部
以下の形式で指定します。
"/<バケット名>/<オブジェクト名>"
オブジェクト名は、イメージファイルの拡張子を含んだ形式です。
利用可能なイメージ形式、拡張子は、パラメータ：detailsの指定（image_from）によって切り替わります。

「image_from」の値	利用可能なイメージ形式(拡張子)
vmware	vmdk形式(.vmdk)
kvm	qcow2形式(.qcow2)

形式が間違っている場合（上記形式ではない、オブジェクト名が指定拡張子で終わらない）、または存在しないオブジェクトを指定した場合はエラーが発生します。
locationを省略する場合は必須です。

checksum

body

string

任意

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

id

body

string

任意

イメージのID
パラメーター省略時はイメージのIDが自動で採番されます。
利用者が独自で取得したイメージのIDを利用したい場合は、本パラメーターにuuidを指定してください。
指定するイメージのIDは、必ず「uuidgen」などのuuid 作成用のコマンドで作成したものを使用してください。

min_ram

body

integer

任意

イメージを使用するために必要な最小RAM（MB）
未指定時は0です。(*1)

min_disk

body

integer

任意

イメージを使用するために必要な最小ディスク容量（GB）
未指定時は0です。(*1)

os_type

body

string

必須

移行元イメージ内のOS種別
以下のどれかを指定してください。

キーワード	意味
win2016SE_ja	Windows Server 2016 SE（日本語版）
win2016SE_en	Windows Server 2016 SE（英語版）
win2019SE	Windows Server 2019 SE
win2016SE_SQL2016SE	Windows Server 2016 SESQL Server 2016 SE
win2019SE_SQL2019SE	Windows Server 2019 SESQL Server 2019 SE
rhel7	Red Hat Enterprise Linux 7
rhel8	Red Hat Enterprise Linux 8
rocky	Rocky Linux
ubuntu	Ubuntu

本操作で指定するOS種別はインポートするOSの実態に合ったものを指定する必要があります。実態と異なる場合は以下の問題が発生する場合があります。

仮想サーバが正常に起動しない。
IaaSのサポートやOSサポートが正しく受けられない。
実態と異なるOSサポート費用が請求される。

kms

body

string

任意

KMSライセンス認証設定
省略すると設定処理はおこわなれません。
os_typeにWindows系OS以外を指定した場合、kmsの値は無視されます。
本パラメータを指定する場合、"kms": "{"server_info": "<FQDN>:<ポート番号>", "activate": true}"の形式で記載します。
server_info、activateのどちらも指定しない場合は、この項目も指定しないでください。

server_info

body

string

任意

KMSライセンスサーバのFQDNとポート番号を以下の形式で指定します。
"FQDN：ポート番号"
省略時はユーザーズマニュアル表記のリージョン別FQDN＋ポート番号（1688）が設定されます。

activate

boolean

必須

KMSライセンス認証のアクティベーション
「true」を指定してください。
（boolean型のため、指定時「"」でくくらない）
true：アクティベートします。

details

body

object

任意

インポート方式の詳細を設定します。
本パラメータを指定する場合、"details": {"image_from": "<image_fromパラメータの値>"}の形式で記載します。

image_from

body

string

任意

移行元仮想環境を指定します。
省略時は"vmware"が指定されます。
以下のどちらかの値が指定できます。

キーワード	意味
vmware	VMware（ESXi）環境
kvm	KVM環境

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

レスポンスボディ（正常系）の説明#

名前	Type	Description
import_id	string	インポート処理のID 変換状況を取得する場合に使用します。

レスポンス例#

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