ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)

2.1.4 GetLPlatformDescriptorConfiguration (テンプレートの構成情報を取得)

テンプレートの構成情報を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
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
	設定内容	固定。"GetLPlatformDescriptorConfiguration"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
lplatformDescriptorId	説明	L-PlatformテンプレートID
	型	string ASCII
	設定内容	32文字以内

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatformdescriptor>
    <creatorName>[L-Platformテンプレート作成者のテナント名]</creatorName>
    <description>[L-Platformテンプレートの説明]</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>[インターフェース名]</name>
            <networkId>[ネットワークID]</networkId>
          </interface>
        </interfaces>
        <name>[ファイアーウォール名]</name>
        <ruleset>
          <description>[ルールセットの説明]</description>
          <name>[ルールセット名]</name>
          <lplatformModel>[L-Platformのモデル]</lplatformModel>
          <parameters>
            <parameter>
              <description>[パラメーター情報の説明]</description>
              <name>[パラメーター情報名]</name>
              <value>[パラメーターの値]</value>
              <view>[パラメーターの表示の有無]</view>
              <syntax>[パラメーターの書式]</syntax>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <slbs>
      <slb>
        <interfaces>
          <interface>
            <name>[インターフェース名]</name>
            <networkId>[ネットワークID]</networkId>
          </interface>
        </interfaces>
        <name>[サーバロードバランサー名]</name>
        <ruleset>
          <description>[ルールセットの説明]</description>
          <name>[ルールセット名]</name>
          <lplatformModel>[L-Platformのモデル]</lplatformModel>
          <parameters>
            <parameter>
              <description>[パラメーター情報の説明]</description>
              <name>[パラメーター情報名]</name>
              <value>[パラメーターの値]</value>
              <view>[パラメーターの表示の有無]</view>
              <syntax>[パラメーターの書式]</syntax>
            </parameter>
          </parameters>
        </ruleset>
      </slb>
    </slbs>
    <registrant>[L-Platformテンプレート登録者]</registrant>
    <networks>
      <network>
        <name>[ネットワーク名]</name>
        <networkCategory>[ネットワーク種別]</networkCategory>
        <networkId>[ネットワークID]</networkId>
        <numOfMaxVm>[最大VM数]</numOfMaxVm>
        <segmentType>[セグメント識別子]</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <creator>[仮想マシン作成者のテナント名]</creator>
        <diskimageId>[ディスクイメージID]</diskimageId>
        <diskimageName>[ディスクイメージ名]</diskimageName>
        <disks>
          <disk>
            <diskNo>[増設ディスク連番]</diskNo>
            <size>[増設ディスクサイズ]</size>
            <storagePool>[ストレージプールのリソース名]</storagePool>
            <contained>[イメージに含まれるデータディスクかどうかを表すフラグ]</contained>
            <diskLink>
              <lserverNo>[共有ディスクを持つサーバ連番]</lserverNo>
              <diskNo>[共有ディスクのディスク連番]</diskNo>
            </diskLink>
          </disk>
        </disks>
        <sparePool>[予備設定プールのリソース名]</sparePool>
        <storagePool>[ストレージプールのリソース名] </storagePool>
        <pool>[VMプールまたはサーバプールのリソース名]</pool>
        <priority>[一括電源制御時の起動優先度]</priority>
        <nicgroups>
          <nicgroup>
            <nicgroupIndex>[NICグループインデックス]</nicgroupIndex>
            <networkId>[接続先ネットワークID]</networkId>
          </nicgroup>
        </nicgroups>
        <nics>
          <nic>
            <management>[制御NIC]</management>
            <networkId>[接続先ネットワークID]</networkId>
            <nicNo>[NIC連番]</nicNo>
          </nic>
        </nics>
        <lserverName>[サーバ名]</lserverName>
        <lserverNo>[サーバ連番]</lserverNo>
        <serverType>[サーバタイプ]</serverType>
      </lserver>
    </lservers>
    <lplatformdescriptorId>[L-PlatformテンプレートID</lplatformdescriptorId>
    <lplatformdescriptorName>[L-Platformテンプレート名]</lplatformdescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorConfigurationResponse>

《要素》

要素名	項目	項目説明
GetLPlatformDescriptorConfigurationResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。 メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
lplatformdescriptor	説明	L-Platformテンプレート情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
creatorName	説明	L-Platformテンプレートの作成者のテナント名
	型	string ASCII
	出現回数	0または1
description	説明	L-Platformテンプレートの説明
	型	string UTF-8
	出現回数	0または1
registrant	説明	L-Platformテンプレートの登録者
	型	string UTF-8
	出現回数	0または1
networks	説明	ネットワーク情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
network	説明	ネットワーク情報の一式
	型	なし
	出現回数	0以上
networkId	説明	ネットワークID
	型	string ASCII
	出現回数	vnetの数分(それぞれに対して0または1)
name	説明	ネットワーク名
	型	string UTF-8
	出現回数	vnetの数分(それぞれに対して0または1)
numOfMaxVm	説明	最大VM数
	型	int
	出現回数	vnetの数分(それぞれに対して0または1)
networkCategory	説明	ネットワーク種別
	型	string ASCII
	出現回数	vnetの数分(それぞれに対して0または1)
segmentType	説明	セグメント識別子
	型	string ASCII
	出現回数	vnetの数分(それぞれに対して0または1)
firewalls	説明	ファイアーウォール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
firewall	説明	ファイアーウォール情報の一式
	型	なし
	出現回数	0以上
name	説明	ファイアーウォール名
	型	string UTF-8
	出現回数	firewallの数分(それぞれに対して0または1)
interfaces	説明	インターフェース情報のレスポンス情報を持つ要素
	型	なし
	出現回数	firewallの数分(それぞれに対して0または1)
interface	説明	インターフェース情報の一式
	型	なし
	出現回数	interfacesの数分(それぞれに対して0以上)
name	説明	インターフェース名
	型	string UTF-8
	出現回数	interfaceの数分(それぞれに対して0または1)
networkId	説明	ネットワークID
	型	string ASCII
	出現回数	interfaceの数分(それぞれに対して0または1)
ruleset	説明	ファイアーウォールのルールセット
	型	なし
	出現回数	firewallの数分(それぞれに対して0または1)
name	説明	ルールセット名
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
description	説明	ルールセットの説明
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
lplatformModel	説明	L-Platformのモデル。以下のどちらかとなります。 "Firewall+SLB"：ファイアーウォールとサーバロードバランサー "Firewall only"：ファイアーウォールだけ
	型	string ASCII
	出現回数	rulesetの数分(それぞれに対して0または1)
parameters	説明	ルールセットのパラメーター情報のレスポンス情報を持つ要素
	型	なし
	出現回数	rulesetの数分(それぞれに対して0または1)
parameter	説明	ルールセットのパラメーター情報の一式
	型	なし
	出現回数	parametersの数分(それぞれに対して0または1)
name	説明	パラメーター情報名
	型	string UTF-8
	出現回数	parameterの数分(それぞれに対して0または1)
view	説明	パラメーターの表示の有無
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
value	説明	パラメーターの値
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
description	説明	パラメーター情報の説明
	型	string UTF-8
	出現回数	parameterの数分(それぞれに対して0または1)
syntax	説明	パラメーターの書式
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
slbs	説明	サーバロードバランサー情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
slb	説明	サーバロードバランサー情報の一式
	型	なし
	出現回数	0以上
name	説明	サーバロードバランサー名
	型	string UTF-8
	出現回数	slbの数分(それぞれに対して0または1)
interfaces	説明	インターフェース情報のレスポンス情報を持つ要素
	型	なし
	出現回数	slbの数分(それぞれに対して0または1)
interface	説明	インターフェース情報の一式
	型	なし
	出現回数	interfacesの数分(それぞれに対して0以上)
name	説明	インターフェース名
	型	string UTF-8
	出現回数	interfaceの数分(それぞれに対して0または1)
networkId	説明	ネットワークID
	型	string ASCII
	出現回数	interfaceの数分(それぞれに対して0または1)
ruleset	説明	サーバロードバランサーのルールセット
	型	なし
	出現回数	slbの数分(それぞれに対して0または1)
name	説明	ルールセット名
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
description	説明	ルールセットの説明
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
lplatformModel	説明	L-Platformのモデル。以下のどちらかとなります。 "Firewall+SLB"：ファイアーウォールとサーバロードバランサー "SLB only"：サーバロードバランサーだけ
	型	string ASCII
	出現回数	rulesetの数分(それぞれに対して0または1)
parameters	説明	ルールセットのパラメーター情報のレスポンス情報を持つ要素
	型	なし
	出現回数	rulesetの数分(それぞれに対して0または1)
parameter	説明	ルールセットのパラメーター情報の一式
	型	なし
	出現回数	parametersの数分(それぞれに対して0または1)
name	説明	パラメーター情報名
	型	string UTF-8
	出現回数	parameterの数分(それぞれに対して0または1)
view	説明	パラメーターの表示の有無
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
value	説明	パラメーターの値
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
description	説明	パラメーター情報の説明
	型	string UTF-8
	出現回数	parameterの数分(それぞれに対して0または1)
syntax	説明	パラメーターの書式
	型	string ASCII
	出現回数	parameterの数分(それぞれに対して0または1)
lservers	説明	仮想マシン情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
lserver	説明	仮想マシン情報の一式
	型	なし
	出現回数	0以上
creator	説明	仮想マシン作成者のテナント名
	型	string ASCII
	出現回数	lserverの数分(それぞれに対して0または1)
lserverNo	説明	サーバ連番
	型	int
	出現回数	lserverの数分(それぞれに対して0または1)
diskimageId	説明	ディスクイメージID
	型	string ASCII
	出現回数	lserverの数分(それぞれに対して0または1)
diskimageName	説明	ディスクイメージ名
	型	string ASCII
	出現回数	lserverの数分(それぞれに対して0または1)
disks	説明	増設ディスク情報のレスポンス情報を持つ要素
	型	なし
	出現回数	lserverの数分(それぞれに対して0または1)
disk	説明	増設ディスク情報の一式
	型	なし
	出現回数	0以上
diskNo	説明	増設ディスク連番
	型	int
	出現回数	diskの数分(それぞれに対して0または1)
size	説明	増設ディスクサイズ。単位は"GB"になります。
	型	decimal
	出現回数	diskの数分(それぞれに対して0または1)
diskLink	説明	共有ディスクのリンク情報の一式
	型	なし
	出現回数	diskの数分(それぞれに対して0または1)
lserverNo	説明	共有ディスクを持つサーバ連番
	型	int
	出現回数	diskLinkの数分(それぞれに対して0または1)
diskNo	説明	共有ディスクのディスク連番
	型	int
	出現回数	diskLinkの数分(それぞれに対して0または1)
storagePool	説明	ストレージプールのリソース名
	型	string ASCII
	出現回数	diskの数分(それぞれに対して0または1)
contained	説明	イメージに含まれるデータディスクかどうかを表すフラグ。 イメージに含まれるデータディスクの場合は"true"、そうでない場合は"false"となります。
	型	string ASCII
	出現回数	diskの数分(それぞれに対して0または1)
lserverName	説明	サーバ名
	型	string UTF-8
	出現回数	lserverの数分(それぞれに対して0または1)
serverType	説明	サーバタイプ
	型	string ASCII
	出現回数	lserverの数分(それぞれに対して0または1)
pool	説明	VMプールまたはサーバプールのリソース名
	型	string UTF-8
	出現回数	lserverの数分(それぞれに対して0または1)
sparePool	説明	予備設定プールのリソース名
	型	string UTF-8
	出現回数	lserverの数分(それぞれに対して0または1)
storagePool	説明	ストレージプールのリソース名
	型	string UTF-8
	出現回数	lserverの数分(それぞれに対して0または1)
priority	説明	一括電源制御時の起動優先度。1～256になります。 この値が小さなサーバから起動されます。
	型	int
	出現回数	lserverの数分(それぞれに対して0または1)
nicgroups	説明	NICグループ情報のレスポンス情報を持つ要素
	型	なし
	出現回数	lserverの数分(それぞれに対して0または1)
nicgroup	説明	NICグループ情報の一式
	型	なし
	出現回数	nicgroupsの数分(それぞれに対して0または1)
nicgroupIndex	説明	NICグループインデックス
	型	int
	出現回数	nicgroupの数分(それぞれに対して0または1)
networkId	説明	接続先ネットワークID
	型	string ASCII
	出現回数	nicgroupの数分(それぞれに対して0または1)
management	説明	制御NIC。制御NICの場合は1、そうでない場合は0になります。
	型	int
	出現回数	nicgroupの数分(それぞれに対して0または1)
nics	説明	VNIC情報のレスポンス情報を持つ要素
	型	なし
	出現回数	lserverの数分(それぞれに対して0または1)
nic	説明	NIC情報の一式
	型	なし
	出現回数	0以上
nicNo	説明	NIC連番
	型	int
	出現回数	nicの数分(それぞれに対して0または1)
networkId	説明	接続先ネットワーク
	型	string ASCII
	出現回数	nicの数分(それぞれに対して0または1)
nicgroupIndex	説明	所属するNICグループインデックス
	型	int
	出現回数	nicの数分(それぞれに対して0または1)
management	説明	制御NIC。制御NICの場合は1、そうでない場合は0になります。
	型	int
	出現回数	nicの数分(それぞれに対して0または1)
lplatformdescriptorId	説明	L-PlatformテンプレートID
	型	string ASCII
	出現回数	0または1
lplatformdescriptorName	説明	L-Platformテンプレート名
	型	string UTF-8
	出現回数	0または1

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptor>
    <creatorName>cfmgadm</creatorName>
    <description>firewallテスト</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <description>ルールセット(rule1)の説明（日本語）</description>
          <name>rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>パラメタ1の詳細説明（日本語）</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(1..255)</syntax>
            </parameter>
            <parameter>
              <description>パラメタ2の詳細説明（日本語）</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..255))</syntax>
            </parameter>
            <parameter>
              <description>パラメタ3の詳細説明（日本語）</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(1..65535)</syntax>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <slbs>
      <slb>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>SLB</name>
        <ruleset>
          <description>ルールセット(slb_rule1)の説明（日本語）</description>
          <name>slb_rule1</name>
          <lplatformModel>Firewall+SLB</lplatformModel>
          <parameters>
            <parameter>
              <description>パラメタ1の詳細説明（日本語）</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
              <syntax>INTEGER(1..255)</syntax>
            </parameter>
            <parameter>
              <description>パラメタ2の詳細説明（日本語）</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
              <syntax>DisplayString(SIZE(0..255))</syntax>
            </parameter>
            <parameter>
              <description>パラメタ3の詳細説明（日本語）</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
              <syntax>INTEGER(1..65535)</syntax>
            </parameter>
          </parameters>
        </ruleset>
      </slb>
    </slbs>
    <registrant>tpladm1</registrant>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <segmentType>DMZ</segmentType>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
        <segmentType>SECURE</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <disks>
          <disk>
            <diskNo>1</diskNo>
            <size>30.0</size>
            <storagePool>/StoragePool</storagePool>
            <contained>false</contained>
          </disk>
        </disks>
        <priority>10</priority>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
        </nics>
        <lserverName>物理サーバ-1</lserverName>
        <lserverNo>0</lserverNo>
        <serverType>Economy</serverType>
      </lserver>
      <lserver>
        <creator>cfmgadm</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <sparePool/>
        <storagePool>/StoragePool</storagePool>
        <pool>/VMHostPool</pool>
        <priority>20</priority>
        <nics>
          <nic>
            <management>1</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
          </nic>
          <nic>
            <management>0</management>
            <networkId>1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
          </nic>
        </nics>
        <lserverName>仮想マシン-1</lserverName>
        <lserverNo>1</lserverNo>
        <serverType>over_commit</serverType>
      </lserver>
    </lservers>
    <lplatformdescriptorId>template-1325738ea5b</lplatformdescriptorId>
    <lplatformdescriptorName>firewall-test</lplatformdescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorConfigurationResponse>