2.2.1 CreateLPlatform (L-Platformを作成)

テンプレートを元にL-Platformを作成します。
テンプレート内に同名のサーバが複数存在する場合は、サーバ名の末尾に1から始まる連番を追加します。

本APIは、非同期で実行されます。配備中は、L-Platformの状態が配備中(DEPLOYING)、ソフトウェア設定中(SETUP)に遷移し、配備が完了すると、L-Platformの状態が正常稼働中(NORMAL)になります。
L-Platformの状態が正常稼働中に遷移するまでは、L-Platformに対する操作ができません。
L-Platformの状態をGetLPlatformStatusで監視し、正常稼働中に遷移するのを待ってから次の操作を行ってください。

注意

テンプレートに物理サーバが含まれる場合、設定するハードウェア装置の制約により、本APIは同時に2つまで実行できます。
物理サーバを含むL-Platformを2つ以上作成する場合は、時間間隔をあけて本APIを実行してください。
自動選択を指定したセグメントを含むL-Platformテンプレートを指定した場合、本APIの同時実行数は、同時に配備するすべてのL-Platformで必要となるIPアドレス数が、自動選択対象のセグメントのうち最も多い空きIPアドレス数以下となるようにしてください。
例えば、自動選択対象となるセグメントが2つあり、それぞれ空きIPアドレス数が5つと4つだった場合、1つのL-Platformで必要とするIPアドレスが1つであれば、本APIは5つまで同時に実行することができます。
対象のL-Platformテンプレート内に、2台以上VDI連携を使用するサーバが含まれている場合、本APIではL-Platformの作成ができません。

リクエストパラメーター

パラメーター名	項目	項目説明
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
	設定内容	固定。"CreateLPlatform"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
lplatformDescriptorId	説明	L-PlatformテンプレートID
	型	string ASCII
	設定内容	32文字以内
lplatformName	説明	L-Platform名
	型	string UTF-8
	設定内容	85文字以内。ただし、< > &‘“ および改行は指定できません。
vdiUser	説明	VDIユーザー名
	型	string UTF-8
	設定内容	配備するL-Platform内にVDI連携を使用するサーバが含まれていて、VDIを利用するユーザーが“userId”で指定するユーザーと異なる場合に指定してください。 VDI連携を使用するサーバが含まれていない場合に指定しても無視されます。

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名	項目	項目説明
CreateLPlatformResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第15章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
lplatformId	説明	L-Platform ID
	型	string ASCII
	出現回数	0または1

サンプルレスポンス

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