2.2.13 CreateNetwork (L-Platformにネットワークセグメントを追加)

L-Platformにネットワークセグメントを追加します。

追加するネットワークセグメントは事前に登録しておく必要があります。

resourceIdを省略した場合は、自動選択のネットワークセグメントを追加します。

resourceIdを省略した場合は、networkCategoryは必ず指定してください。segmentTypeは省略可能です。

resourceIdを指定した場合は、networkCategoryおよびsegmentTypeは指定しないでください。

対象のL-Platform内にSolarisコンテナのサーバが存在する、かつ、BladeLogicが存在しない場合、本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
	設定内容	固定。"CreateNetwork"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
lplatformId	説明	ネットワークを追加するL-Platform ID
	型	string ASCII
	設定内容	32文字以内
[resourceId]	説明	追加するネットワークのリソースID
	型	string ASCII
	設定内容	31文字以内。 networkCategoryを指定しない場合は、必ず指定してください。
numOfMaxNic	説明	最大NIC数
	型	string ASCII
	設定内容	ネットワークセグメントに追加できる最大NIC数を指定してください。セグメントの最大NIC数(デフォルト30)以下の値を指定することを推奨します。セグメントの最大NIC数については、「運用ガイド CE」の「8.5.10 L-Platformテンプレートの最大接続数の設定」を参照してください。
[networkCategory]	説明	ネットワーク種別。指定したネットワーク種別のネットワークセグメントを追加します。
	型	string ASCII
	設定内容	以下のどちらかを指定してください。・MANAGEMENT:管理セグメント・BUSINESS: 業務セグメント resourceIdを指定しない場合は、必ず指定してください。
[segmentType]	説明	セグメント識別情報。一致するネットワークリソースのネットワークセグメントを追加します。
	型	string ASCII
	設定内容	32文字以内。 resourceIdを省略した場合に指定可能です。
[name]	説明	ネットワーク名。ネットワークに設定する名前を指定してください。
	型	string ASCII
	設定内容	20文字以内。省略した場合は以下の名前を設定します。・resourceIdを指定した場合：ネットワークリソースの名前・networkCategoryを指定した場合：AUTOX。Xには1から始まる連番を設定します。

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateNetworkResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <networkId>[追加されたネットワークID]</networkId>
</CreateNetworkResponse>

《要素》

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

サンプルレスポンス

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