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

2.2.1 CreateLPlatform (L-Platformを作成)

テンプレートを元にL-Platformを作成します。

注意

テンプレートに物理サーバが含まれる場合、設定するハードウェア装置の制約により、本APIは同時に2つまで実行できます。
物理サーバを含むL-Platformを2つ以上作成する場合は、時間間隔をあけて本APIを実行してください。

リクエストパラメーター

パラメーター名

項目

項目説明

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文字以内。ただし、< > &‘“ および改行は指定できません。


レスポンス

《ステータスコード》

正常に終了した場合に"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

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 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>