ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView

2.3.12 CreateImage (サーバのクローニングイメージを採取)

サーバのクローニングイメージを採取します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

L-Platform APIのバージョンID

string ASCII

設定内容

固定。"2.0"を指定してください。

Locale

説明

L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

string ASCII

設定内容

以下から選択します。
・"ja": 日本語
・"en": 英語

Action

説明

実行するL-Platform APIの名称

string ASCII

設定内容

固定。"CreateImage"を指定してください。

userId

説明

L-Platform APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

string ASCII

設定内容

32文字以内

name

説明

作成するイメージにつけるイメージ名。既存のイメージと同じ名前を指定した場合、そのイメージが更新されます。

string ASCII

設定内容

32文字以内

imagePool

説明

イメージプール名

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。

例:/tenantA/pool

comment

説明

コメント

string UTF-8

設定内容

128文字以内

[allDisk]

説明

拡張ディスク込でクローニングマスタを採取するかどうかを指定します。

string ASCII

設定内容

以下のどちらかを選択します。

・true: 拡張ディスク込みでクローニングマスタを採取する

・false: 拡張ディスク込みでクローニングマスタを採取しない

省略した場合は"false"です。

VMwareまたはHyper-Vのサーバにだけ指定可能です。
VMwareのサーバの場合、"false"を指定してイメージを採取しても、実際に採取されるイメージは、拡張ディスクが含まれたイメージとなります。
ただし、イメージ採取後に登録されるイメージ情報は、拡張ディスクが含まれないイメージ情報となりますので、このイメージ情報を利用してサーバを配備した場合、システムディスクだけで配備されます。


レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</CreateImageResponse>

《要素》

要素名

項目

項目説明

CreateImageResponse

説明

レスポンスの情報を持つ要素

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧(L-Platform API)」を参照してください。

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CreateImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CreateImageResponse>