ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.0.0 リファレンスガイド インフラ管理者編
第3部 APIリファレンス > 第7章 L-Platform API > 7.3 L-Platform APIリファレンス > 7.3.2 L-Platform操作
前次

7.3.2 L-Platform操作

ここでは、L-Platformの操作に関連するL-Platform APIについて説明します。

7.3.2.1 CreateLPlatform (L-Platformを作成)

テンプレートを元に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文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


コマンド

CreateLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformDescriptorId テンプレートID -lplatformName L-Platform名

レスポンス

《ステータスコード》

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

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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>

7.3.2.2 ListLPlatform (L-Platformの一覧を取得)

仮想データセンター内にある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

設定内容

固定。「ListLPlatform」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

[verbose]

説明

詳細情報表示の有無。

型

string ASCII

設定内容

以下から選択します。
・true ：詳細情報表示あり
・false：詳細情報表示なし

省略時は false を指定したものとして動作します。


コマンド

ListLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名  [-verbose 詳細情報表示の有無]

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatforms>
    <lplatform>
      <baseDescriptor>[L-Platformの元になったL-PlatformテンプレートID]</baseDescriptor>
      <creator>[L-Platform作成者のテナント名]</creator>
      <ownerUser>[L-Platformの所有者のユーザーID]</ownerUser>
      <description>[L-Platformの説明]</description>
      <firewalls>
        <firewall>
          <interfaces>
            <interface>
              <name>[インターフェース名]</name>
              <networkId>[ネットワークID]</networkId>
            </interface>
          </interfaces>
          <name>[ファイアーウォール名]</name>
          <ruleset>
            <description>[ルールセットの説明]</description>
            <name>[ルールセット名]</name>
            <parameters>
              <parameter>
                <description>[パラメーターの説明]</description>
                <name>[パラメーター名]</name>
                <value>[パラメーターの値]</value>
                <view>[パラメーターの表示の有無]</view>
              </parameter>
            </parameters>
          </ruleset>
        </firewall>
      </firewalls>
      <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>
              <attachedTo>[増設ディスクが取り付けられているサーバのID]</attachedTo>
              <creator>[増設ディスクの作成者のテナント名]</creator>
              <size>[増設ディスクのサイズ]</size>
              <diskId>[増設ディスクID]</diskId>
              <diskName>[増設ディスク名]</diskName>
              <resourceName>[既存ディスク名]</resourceName>
              <storagePool>[ストレージプールのリソース名]</storagePool>
            </disk>
          </disks>
          <hostName>[サーバのホスト名]</hostName>
          <memorySize>[メモリ量]</memorySize>
          <numOfCpu>「CPU数]</numOfCpu>
          <requestCpuPerf>[要求CPU性能]</requestCpuPerf>
          <requestMemorySize>[要求メモリ量]</requestMemorySize>
          <requestNumOfCpu>[要求CPU数]</requestNumOfCpu>
          <storagePool>[ストレージプールのリソース名]</storagePool>
          <pool>[VMプールまたはサーバプールのリソース名]</pool>
          <vmType>[VMw種別]</vmType>
          <nicgroups>
            <nicgroup>
              <nicgroupIndex>[NICグループのインデックス]</nicgroupIndex>
              <management>[制御NIC]</management>
              <networkId>[ネットワークID]</networkId>
              <privateIp>[IPアドレス]</privateIp>
            </nicgroup>
          </nicgroups>
          <nics>
            <nic>
              <management>[制御NIC]</management>
              <networkId>[ネットワークID]</networkId>
              <nicNo>[NIC連番]</nicNo>
              <privateIp>[IPアドレス]</privateIp>
              <nicgroupIndex>[所属するNICグループのインデックス]</nicgroupIndex>
            </nic>
          </nics>
          <lserverId>[サーバID]</lserverId>
          <lserverName>[サーバ名]</lserverName>
          <lserverStatus>[サーバの状態]</lserverStatus>
          <serverType>[サーバのタイプ]</serverType>
          <lserverType>[サーバタイプ]</lserverType>
          <priority>[一括電源制御時の起動優先度]</priority>
          <image>
            <cpuBit>[CPUビット数]</cpuBit>
            <id>[ID]</id>
            <numOfMaxDisk>[最大ディスク数]</numOfMaxDisk>
            <numOfMaxNic>[最大NIC数]</numOfMaxNic>
            <serverApplication>[サーバ用途]</serverApplication>
            <serverCategory>[サーバ種別]</serverCategory>
            <softwares>
              <software>
                <category>[ソフトウェア区分]</category>
                <softwareId>[ソフトウェアID]</softwareId>
                <license>[ライセンス情報]</license>
                <name>[ソフトウェア名]</name>
                <officialVersion>[正式バージョン]</officialVersion>
                <patch>[パッチ版数]</patch>
                <support>[サポート]</support>
                <version>[バージョン]</version>
                <patches>
                  <patch>
                    <softwareId>[ソフトウェアID]</softwareId>
                    <patchId>[パッチID]</patchId>
                    <componentName>[コンポーネント名]</componentName>
                    <description>[パッチの説明]</description>
                  </patch>
                </patches>
              </software>
            </softwares>
            <sysvolSize>20.0</sysvolSize>
          </image>
        </lserver>
      </lservers>
      <lplatformId>[L-Platform ID]</lplatformId>
      <lplatformName>[L-Platform名]</lplatformName>
      <lplatformStatus>[L-Platformの状態]</lplatformStatus>
    </lplatform>
  </lplatforms>
</ListLPlatformResponse>

《要素》

要素名

項目

項目説明

ListLPlatformResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lplatforms

説明

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

型

なし

出現回数

0または1

lplatform

説明

L-Platform情報の一式

型

なし

出現回数

0以上

baseDescriptor

説明

L-Platformの元になったL-PlatformテンプレートID

型

string ASCII

出現回数

lplatformの数分(それぞれに対して0または1)

creator

説明

L-Platform作成者のテナント名

型

string ASCII

出現回数

lplatformの数分(それぞれに対して0または1)

ownerUser

説明

L-Platformの所有者のユーザーID

型

string ASCII

出現回数

lplatformの数分(それぞれに対して0または1)

description

説明

L-Platformの説明

型

string UTF-8

出現回数

lplatformの数分(それぞれに対して0または1)

lplatformId

説明

L-Platform ID

型

string ASCII

出現回数

lplatformの数分(それぞれに対して0または1)

lplatformName

説明

L-Platform名

型

string UTF-8

出現回数

lplatformの数分(それぞれに対して0または1)

lplatformStatus

説明

L-Platformの状態を表します。以下のどれかになります。

・NORMAL: 正常稼動中
・RECONFIG_ING: 構成変更中
・DEPLOYING: 配備中
・ERROR: L-Platformエラー
この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lplatformの数分(それぞれに対して0または1)

networks

説明

VNet情報のレスポンス情報を持つ要素
この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0または1

network

説明

VNet情報の一式
この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

networkId

説明

VnetのID。
この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

networkCategory

説明

ネットワーク種別を表します。以下のどれかになります。
・MANAGEMENT：管理LAN
・BUSINESS：業務LAN
・空文字：登録なし

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

name

説明

ネットワーク名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

networkの数分(それぞれに対して0または1)

numOfMaxVm

説明

最大VM数。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

segmentType

説明

セグメント識別情報。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

firewalls

説明

ファイアーウォール情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

lplatformの数分(それぞれに対して0または1)

firewall

説明

L-Platform情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

name

説明

ファイアーウォールの名前

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

firewallの数分(それぞれに対して0または1)

interfaces

説明

インターフェース情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

firewallの数分(それぞれに対して0または1)

interface

説明

インターフェース情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

name

説明

インターフェースの名前。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

interfaceの数分(それぞれに対して0または1)

networkId

説明

ネットワークID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

interfaceの数分(それぞれに対して0または1)

ruleset

説明

ファイアーウォールのルールセット情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

firewallの数分(それぞれに対して0または1)

name

説明

ルールセットの名前。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

rulesetの数分(それぞれに対して0または1)

description

説明

ルールセットの説明。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

rulesetの数分(それぞれに対して0または1)

parameters

説明

ルールセットのパラメーター情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

rulesetの数分(それぞれに対して0または1)

parameter

説明

パラメーター情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

name

説明

パラメーター情報の名前。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

parameterの数分(それぞれに対して0または1)

view

説明

パラメーターの表示の有無。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

parametrの数分(それぞれに対して0または1)

value

説明

パラメーターの値。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

parametrの数分(それぞれに対して0または1)

description

説明

パラメーター情報の説明。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

parameterの数分(それぞれに対して0または1)

lservers

説明

サーバ情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

lplatformの数分(それぞれに対して0または1)

lserver

説明

サーバ情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

creator

説明

サーバの作成者のテナント名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

diskimageId

説明

ディスクイメージID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

diskimageName

説明

ディスクイメージの名前。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

disks

説明

増設ディスク情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

lplatformの数分(それぞれに対して0または1)

disk

説明

増設ディスク情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

attachedTo

説明

増設ディスクが取り付けられているサーバのID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

creator

説明

増設ディスクの作成者のテナント名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

size

説明

増設ディスクのサイズ。 [GB]

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

diskの数分(それぞれに対して0または1)

diskId

説明

増設ディスクID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

diskName

説明

増設ディスク名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

resourceName

説明

既存ディスクの名前。

この要素は既存ディスクだけに表示されます。

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

storagePool

説明

ストレージプールのリソース名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

nics

説明

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

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

lserverの数分(それぞれに対して0または1)

nic

説明

NIC情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

networkId

説明

ネットワークID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicの数分(それぞれに対して0または1)

nicNo

説明

NIC連番。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

nicの数分(それぞれに対して0または1)

privateIp

説明

IPアドレス。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicの数分(それぞれに対して0または1)

management

説明

制御NIC。以下のどちらかになります。
・制御NIC：1
・制御NIC以外：0

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicの数分(それぞれに対して0または1)

nicgroupIndex

説明

所属するNICグループのインデックス。

NICグループに含まれない場合は表示されません。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

nicの数分(それぞれに対して0または1)

nicgroups

説明

NICグループ情報のレスポンス情報を持つ要素。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

lserverの数分(それぞれに対して0または1)

nicgroup

説明

NICグループ情報の一式。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

なし

出現回数

0以上

nicgroupIndex

説明

NICグループインデックス。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

nicgroupの数分(それぞれに対して0または1)

networkId

説明

接続先ネットワークID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicgroupの数分(それぞれに対して0または1)

privateIp

説明

IPアドレス。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicgroupの数分(それぞれに対して0または1)

management

説明

制御NIC。以下のどちらかになります。
・制御NIC：1
・制御NIC以外：0

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

nicgroupの数分(それぞれに対して0または1)

lserverId

説明

サーバID。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

lserverName

説明

サーバの名前。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

lserverStatus

説明

サーバの状態は以下のどれかになります。

・DEPLOYING: 配備中
・RUNNING: 稼動
・STOPPING: 停止中
・STOPPED: 停止
・STARTING: 稼動中
・FAILOVER: フェイルオーバーした状態で稼動
・UNEXPECTED_STOP: 予期せずに停止
・RESTORING: リストア中
・BACKUP_ING: バックアップ中
・ERROR: サーバのエラー
・START_ERROR: サーバ起動時のエラー
・STOP_ERROR: サーバ停止時のエラー
この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

hostName

説明

サーバのホスト名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

vmType

説明

VM種別。以下のどれかになります。
・「VMware」:VMware
・「RHEL-Xen」: RHEL5-Xen
・「Hyper-V」:Hyper-V
・「RHEL-KVM」:RHEL-KVM

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

pool

説明

VMプールまたはサーバプールのリソース名。

サーバタイプがサーバの場合だけ出力されます。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

storagePool

説明

ストレージプールのリソース名。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

cpuPerf

説明

CPU性能。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

numOfCpu

説明

CPU数。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

cpuReserve

説明

CPU予約性能。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

cpuShare

説明

CPU配分比。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

memorySize

説明

メモリ量。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

memoryReserve

説明

メモリ予約容量。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

memoryShare

説明

メモリ配分比。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

requestCpuPerf

説明

要求CPU性能。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

requestNumOfCpu

説明

要求CPU数。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

requestMemorySize

説明

要求メモリ容量。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

lserverType

説明

サーバタイプ。次のどちらかになります。

・Physical:物理サーバ
・Virtual: サーバ
この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

serverType

説明

サーバのタイプ。

この要素はverboseにtrueを設定した場合だけ表示されます。

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

priority

説明

一括電源制御時の起動優先度。0～256になります。
この値が小さなサーバから起動されます。
ただし、起動優先度が「0」のサーバは一括電源操作の対象になりません。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

image

説明

イメージ情報の一式

型

なし

出現回数

lserverの数分(それぞれに対して0または1)

cpuBit

説明

CPUビット数。次のどちらかになります。

・32: 32ビット

・64: 64ビット

型

string ASCII

出現回数

imageの数分(それぞれに対して0または1)

id

説明

ID

型

string ASCII

出現回数

imageの数分(それぞれに対して0または1)

numOfMaxDisk

説明

最大ディスク数

型

int

出現回数

imageの数分(それぞれに対して0または1)

numOfMaxNic

説明

最大NIC数

型

int

出現回数

imageの数分(それぞれに対して0または1)

serverApplication

説明

サーバ用途。以下のどれかになります。
・WEB : WEBサーバ
・AP : APサーバ
・DB : DBサーバ
・FILE: FILEサーバ

型

string ASCII

出現回数

imageの数分(それぞれに対して0または1)

serverCategory

説明

サーバ種別。
・GENERAL: 汎用サーバ

型

string ASCII

出現回数

imageの数分(それぞれに対して0または1)

softwares

説明

ソフトウェア情報のレスポンス情報を持つ要素

型

なし

出現回数

imageの数分(それぞれに対して0または1)

software

説明

ソフトウェア情報の一式

型

なし

出現回数

0以上

category

説明

ソフトウェア区分。以下のどれかになります。
・OS : OS
・MIDDLE: ミドルウェア
・APP : アプリケーション

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

license

説明

ライセンス情報

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

name

説明

ソフトウェア名

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

officialVersion

説明

正式バージョン

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

patch

説明

パッチ版数

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

support

説明

サポート

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

version

説明

バージョン

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

patches

説明

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

型

なし

出現回数

imageの数分(それぞれに対して0または1)

patch

説明

パッチ情報の一式

型

なし

出現回数

0以上

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

patchId

説明

パッチID

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

componentName

説明

コンポーネント名

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

description

説明

パッチの説明

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

sysvolSize

説明

SYSVOLのサイズ

型

decimal

出現回数

imageの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatforms>
    <lplatform>
      <baseDescriptor>template-1325738ea5b</baseDescriptor>
      <creator>tenantA</creator>
      <ownerUser>user1</ownerUser>
      <description>firewallテスト</description>
      <firewalls>
        <firewall>
          <interfaces>
            <interface>
              <name>network-param-0001</name>
              <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
            </interface>
            <interface>
              <name>network-param-0002</name>
              <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
            </interface>
          </interfaces>
          <name>Firewall</name>
          <ruleset>
            <description>ルールセット(rule1)の説明（日本語）</description>
            <name>rule1</name>
            <parameters>
              <parameter>
                <description>パラメタ1の詳細説明（日本語）</description>
                <name>param_var_001</name>
                <value>200</value>
                <view>false</view>
              </parameter>
              <parameter>
                <description>パラメタ2の詳細説明（日本語）</description>
                <name>param_var_002</name>
                <value/>
                <view>true</view>
              </parameter>
              <parameter>
                <description>パラメタ3の詳細説明（日本語）</description>
                <name>param_var_003</name>
                <value>400</value>
                <view>true</view>
              </parameter>
            </parameters>
          </ruleset>
        </firewall>
      </firewalls>
      <networks>
        <network>
          <name>network-param-0002</name>
          <networkCategory>BUSINESS</networkCategory>
          <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
          <numOfMaxVm>10</numOfMaxVm>
        </network>
        <network>
          <name>network-param-0001</name>
          <networkCategory>BUSINESS</networkCategory>
          <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
          <numOfMaxVm>10</numOfMaxVm>
        </network>
      </networks>
      <lservers>
        <lserver>
          <cpuPerf>1.0</cpuPerf>
          <creator>tenantA</creator>
          <diskimageId>image-1324e093f4e</diskimageId>
          <diskimageName>g-physical-0001</diskimageName>
          <hostName>V8O0NW7TZV0001</hostName>
          <memorySize>2.0</memorySize>
          <numOfCpu>2</numOfCpu>
          <requestCpuPerf>1.4</requestCpuPerf>
          <requestMemorySize>2.0</requestMemorySize>
          <requestNumOfCpu>1</requestNumOfCpu>
          <storagePool>/StoragePool</storagePool>
          <lserverType>Physical</lserverType>
          <disks/>
          <image>
            <cpuBit>32</cpuBit>
            <id>image-132480039e8</id>
            <numOfMaxDisk>0</numOfMaxDisk>
            <numOfMaxNic>3</numOfMaxNic>
            <serverApplication>AP</serverApplication>
            <serverCategory>GENERAL</serverCategory>
            <softwares>
              <software>
                <category>OS</category>
                <license>1</license>
                <name>softNameA</name>
                <officialVersion/>
                <patch/>
                <softwareId>SW00000003</softwareId>
                <support>1</support>
                <version>6.0</version>
              </software>
            </softwares>
            <sysvolSize>20.0</sysvolSize>
          </image>
          <pool>/ServerPool</pool>
          <vmType>VMware</vmType>
          <nics>
            <nic>
              <management>0</management>
              <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
              <nicNo>2</nicNo>
              <privateIp>192.xxx.xxx.xxx4</privateIp>
            </nic>
            <nic>
              <management>1</management>
              <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
              <nicNo>1</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
          </nics>
          <lserverId>tenantA-8O0NW7TZV-S-0001</lserverId>
          <lserverName>物理サーバ-1</lserverName>
          <lserverStatus>RUNNING</lserverStatus>
          <serverType>Economy</serverType>
          <priority>10</priority>
        </lserver>
        <lserver>
          <cpuPerf>1.2</cpuPerf>
          <creator>tenantA</creator>
          <diskimageId>image-1324e09f82f</diskimageId>
          <diskimageName>g-vm-0002</diskimageName>
          <hostName>V8O0NW7TZV0002</hostName>
          <memorySize>1.6</memorySize>
          <numOfCpu>1</numOfCpu>
          <storagePool>/StoragePool</storagePool>
          <lserverType>Virtual</lserverType>
          <disks/>
          <vmPool>/VMHostPool</vmPool>
          <vmType>VMware</vmType>
          <nics>
            <nic>
              <management>0</management>
              <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
              <nicNo>3</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
            <nic>
              <management>0</management>
              <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
              <nicNo>2</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
            <nic>
              <management>1</management>
              <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
              <nicNo>1</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
          </nics>
          <lserverId>tenantA-8O0NW7TZV-S-0002</lserverId>
          <lserverName>仮想マシン-1</lserverName>
          <lserverStatus>RUNNING</lserverStatus>
          <serverType>over_commit</serverType>
          <priority>20</priority>
        </lserver>
      </lservers>
      <lplatformId>tenantA-8O0NW7TZV</lplatformId>
      <lplatformName>firewall-test</lplatformName>
      <lplatformStatus>NORMAL</lplatformStatus>
    </lplatform>
    <lplatform>
      <baseDescriptor>template-1324e0c2ac0</baseDescriptor>
      <creator>tenantA</creator>
      <ownerUser>user2</ownerUser>
      <description/>
      <networks>
       <network>
          <name>ServiceLan</name>
          <networkCategory>BUSINESS</networkCategory>
          <networkId>6MYJCS7MR-N-j8f0</networkId>
          <numOfMaxVm>10</numOfMaxVm>
        </network>
        <network>
          <name>AdminLan</name>
          <networkCategory>BUSINESS</networkCategory>
          <networkId>6MYJCS7MR-N-j61j</networkId>
          <numOfMaxVm>10</numOfMaxVm>
        </network>
      </networks>
      <lservers>
        <lserver>
          <cpuPerf>1.0</cpuPerf>
          <creator>tenantA</creator>
          <diskimageId>image-1324e093f4e</diskimageId>
          <diskimageName>g-physical-0001</diskimageName>
          <hostName>V6MYJCS7MR0001</hostName>
          <memorySize>2.0</memorySize>
          <numOfCpu>2</numOfCpu>
          <requestCpuPerf>0.1</requestCpuPerf>
          <requestMemorySize>0.1</requestMemorySize>
          <requestNumOfCpu>1</requestNumOfCpu>
          <storagePool>/StoragePool</storagePool>
          <lserverType>Physical</lserverType>
          <disks/>
          <pool>/ServerPool</pool>
          <vmType>VMware</vmType>
          <nics>
            <nic>
              <management>0</management>
              <networkId>6MYJCS7MR-N-j61j</networkId>
              <nicNo>2</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
            <nic>
              <management>1</management>
              <networkId>6MYJCS7MR-N-j61j</networkId>
              <nicNo>1</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
          </nics>
          <lserverId>tenantA-6MYJCS7MR-S-0001</lserverId>
          <lserverName>物理サーバ-1</lserverName>
          <lserverStatus>STOPPED</lserverStatus>
          <serverType>Economy</serverType>
          <priority>30</priority>
        </lserver>
        <lserver>
          <cpuPerf>1.2</cpuPerf>
          <creator>tenantA</creator>
          <diskimageId>image-1324e09f82f</diskimageId>
          <diskimageName>g-vm-0002</diskimageName>
          <hostName>V6MYJCS7MR0002</hostName>
          <memorySize>1.6</memorySize>
          <numOfCpu>1</numOfCpu>
          <storagePool>/StoragePool</storagePool>
          <lserverType>Virtual</lserverType>
          <disks/>
          <pool>/VMHostPool</pool>
          <vmType>VMware</vmType>
          <nics>
            <nic>
              <management>1</management>
              <networkId>6MYJCS7MR-N-j8f0</networkId>
              <nicNo>1</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
            <nic>
              <management>0</management>
              <networkId>6MYJCS7MR-N-j8f0</networkId>
              <nicNo>3</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
            <nic>
              <management>0</management>
              <networkId>6MYJCS7MR-N-j8f0</networkId>
              <nicNo>2</nicNo>
              <privateIp>192.xxx.xxx.xxx</privateIp>
            </nic>
          </nics>
          <lserverId>tenantA-6MYJCS7MR-S-0002</lserverId>
          <lserverName>仮想マシン-1</lserverName>
          <lserverStatus>STOPPED</lserverStatus>
          <serverType>over_commit</serverType>
          <priority>40</priority>
        </lserver>
      </lservers>
      <lplatformId>tenantA-6MYJCS7MR</lplatformId>
      <lplatformName>test-mix</lplatformName>
      <lplatformStatus>NORMAL</lplatformStatus>
    </lplatform>
  </lplatforms>
</ListLPlatformResponse>

7.3.2.3 MoveLPlatform (L-Platformの所有組織を変更)

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

設定内容

固定。「MoveLPlatform」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

31文字以内

[toUserId]

説明

変更後のユーザーID

型

string ASCII

設定内容

31文字以内

toOrgId

説明

変更後のテナント名

型

string ASCII

設定内容

32文字以内


コマンド

MoveLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID [-toUserId 変更後のユーザーID] -toOrgId 変更後のテナント名

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

MoveLPlatformResponse

説明

L-Platform APIのバージョンID

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.2.4 DestroyLPlatform (L-Platformを返却)

L-Platformを返却します。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

設定内容

固定。「DestroyLPlatform」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

返却するL-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

DestroyLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DestroyLPlatformResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.2.5 GetLPlatformStatus (L-Platformの状態を取得)

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

設定内容

固定。「GetLPlatformStatus」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

GetLPlatformStatus -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

GetLPlatformStatusResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lplatformStatus

説明

L-Platform の状態。以下のどれかになります。
・「NORMAL」: 正常稼動中
・「RECONFIG_ING」: 構成変更中
・「DEPLOYING」: 配備中
・「ERROR」: L-Platformエラー

型

string ASCII

出現回数

0または1


サンプルレスポンス

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

7.3.2.6 GetLPlatformConfiguration (L-Platformの構成情報を取得)

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

設定内容

固定。「GetLPlatformConfiguration」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

GetLPlatformConfiguration -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatform>
    <baseDescriptor>[L-Platformの元になったL-PlatformテンプレートID]</baseDescriptor>
    <creator>[L-Platform作成者のテナント名]</creator>
    <ownerUser>[L-Platformの所有者のユーザーID]</ownerUser>
    <description>[L-Platformの説明]</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>[インターフェース名]</name>
            <networkId>[ネットワークID]</networkId>
          </interface>
        </interfaces>
        <name>[ファイアーウォール名]</name>
        <ruleset>
          <description>[ルールセットの説明]</description>
          <name>[ルールセット名]</name>
          <parameters>
            <parameter>
              <description>[パラメーターの説明]</description>
              <name>[パラメーター名]</name>
              <value>[パラメーターの値]</value>
              <view>[パラメーターの表示の有無]</view>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <networks>
      <network>
        <name>[ネットワーク名]</name>
        <networkCategory>[ネットワーク種別]</networkCategory>
        <networkId>[ネットワークID]</networkId>
        <numOfMaxVm>[最大VM数]</numOfMaxVm>
        <segmentType>[セグメント識別情報]</segmentType>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>[CPU性能]</cpuPerf>
        <creator>[サーバ作成者のテナント名]</creator>
        <diskimageId>[ディスクイメージID]</diskimageId>
        <diskimageName>[ディスクイメージ名]</diskimageName>
        <disks>
          <disk>
            <attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
            <creator>[増設ディスク作成者のテナント名]</creator>
            <size>[増設ディスクサイズ]</size>
            <diskId>[増設ディスクID]</diskId>
            <diskName>[増設ディスク名]</diskName>
            <resourceName>[既存ディスク名]</resourceName>
          </disk>
        </disks>
        <hostName>[サーバのホスト名]</hostName>
        <memorySize>[メモリ量]</memorySize>
        <memoryReserve>[メモリ予約容量]</memoryReserve>
        <memoryShare>[メモリ配分比]</memoryShare>
        <cpuPerf>[CPU性能]</cpuPerf>
        <cpuReserve>[CPU予約性能]</cpuReserve>
        <cpuShare>[CPU配分比]</cpuShare>
        <numOfCpu>[CPU数]</numOfCpu>
        <requestCpuPerf>[要求CPU性能]</requestCpuPerf>
        <requestMemorySize>[要求メモリ容量]</requestMemorySize>
        <requestNumOfCpu>[供給CPU数]</requestNumOfCpu>
        <storagePool>[ストレージプールのリソース名]</storagePool>
        <type>[サーバタイプ]</type>
        <pool>[VMプールのリソース名]</pool>
        <vmType>[VM種別]</vmType>
        <nicgroups>
          <nicgroup>
            <nicgroupIndex>[NICグループのインデックス]</nicgroupIndex>
             <networkId>[ネットワークID]</networkId>
             <privateIp>[IPアドレス]</privateIp>
             <management>[制御NIC]</management>
          </nicgroup>
        </nicgroups>
        <nics>
          <nic>
            <management>[制御NIC]</management>
            <networkId>[ネットワークID]</networkId>
            <nicNo>[NIC連番]</nicNo>
            <privateIp>[IPアドレス]</privateIp>
            <nicgroupIndex>[所属するNICグループのインデックス]</nicgroupIndex>
          </nic>
        </nics>
        <lserverId>[サーバID]</lserverId>
        <lserverName>[サーバ名]</lserverName>
        <lserverStatus>[サーバの状態]</lserverStatus>
        <lserverType>[サーバタイプ]</lserverType>
        <serverType>[サーバのタイプ]</serverType>
        <priority>[一括電源制御時の起動優先度]</priority>
      </lserver>
    </lservers>
    <lplatformId>[L-Platform ID]</lplatformId>
    <lplatformName>[L-Platform名]</lplatformName>
  </lplatform>
</GetLPlatformConfigurationResponse>

《要素》

要素名

項目

項目説明

GetLPlatformConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lplatform

説明

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

型

なし

出現回数

0または1

baseDescriptor

説明

L-Platformの元になったL-PlatformテンプレートID

型

string ASCII

出現回数

0または1

creator

説明

L-Platform作成者のテナント名

型

string ASCII

出現回数

0または1

ownerUser

説明

L-Platformの所有者のユーザーID

型

string ASCII

出現回数

0または1

description

説明

L-Platformの説明

型

string UTF-8

出現回数

0または1

networks

説明

ネットワーク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

network

説明

ネットワーク情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

networkCategory

説明

ネットワーク種別。管理LANの場合は「MANAGEMENT」、業務LANの場合は「BUSINESS」です。登録されていない場合は空文字になります。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

name

説明

ネットワーク名

型

string UTF-8

出現回数

networkの数分(それぞれに対して0または1)

numOfMaxVm

説明

最大VM数

型

int

出現回数

networkの数分(それぞれに対して0または1)

segmentType

説明

セグメント識別情報

型

string UTF-8

出現回数

networkの数分(それぞれに対して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)

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)

lservers

説明

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

型

なし

出現回数

0または1

lserver

説明

サーバ情報の一式

型

なし

出現回数

0以上

creator

説明

サーバ作成者のテナント名

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

disks

説明

増設ディスク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

disk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

attachedTo

説明

増設ディスクが取り付けられている仮想マシンID

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

creator

説明

増設ディスク作成者のテナント名

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

size

説明

増設ディスクサイズ。「GB」単位で指定します。

型

decimal

出現回数

diskの数分(それぞれに対して0または1)

diskId

説明

増設ディスクID

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

diskName

説明

増設ディスク名

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

resourceName

説明

既存ディスクの名前。

この要素は既存ディスクだけに表示されます。

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

storagePool

説明

ストレージプールのリソース名

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

nics

説明

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

型

なし

出現回数

diskの数分(それぞれに対して0または1)

nic

説明

NIC情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

nicの数分(それぞれに対して0または1)

nicNo

説明

NIC連番

型

int

出現回数

nicの数分(それぞれに対して0または1)

privateIp

説明

IPアドレス

型

string ASCII

出現回数

nicの数分(それぞれに対して0または1)

management

説明

制御NIC。制御NICの場合は1、そうでない場合は0になります。

型

int

出現回数

nicの数分(それぞれに対して0または1)

nicgroupIndex

説明

所属するNICグループのインデックス。

NICグループに含まれない場合は表示されません。

型

int

出現回数

nicの数分(それぞれに対して0または1)

nicgroups

説明

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

型

なし

出現回数

lserverの数分(それぞれに対して0または1)

nicgroup

説明

NIC情報の一式

型

なし

出現回数

0以上

nicgroupIndex

説明

NICグループのインデックス。

型

int

出現回数

nicgroupの数分(それぞれに対して0または1)

networkId

説明

ネットワークID

型

string ASCII

出現回数

nicgroupの数分(それぞれに対して0または1)

privateIp

説明

IPアドレス

型

string ASCII

出現回数

nicgroupの数分(それぞれに対して0または1)

management

説明

制御NIC。制御NICの場合は1、そうでない場合は0になります。

型

int

出現回数

nicgroupの数分(それぞれに対して0または1)

lserverId

説明

サーバID

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

lserverName

説明

サーバ名

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

hostName

説明

サーバのホスト名

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

vmType

説明

VM種別。以下のどれかになります。
・「VMware」:VMware
・「RHEL-Xen」: RHEL5-Xen
・「Hyper-V」:Hyper-V
・「RHEL-KVM」:RHEL-KVM

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

pool

説明

VMプールのリソース名

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

storagePool

説明

ストレージプールのリソース名

型

string UTF-8

出現回数

lserverの数分(それぞれに対して0または1)

cpuPerf

説明

CPU性能

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

numOfCpu

説明

CPU数

型

int

出現回数

lserverの数分(それぞれに対して0または1)

cpuReserve

説明

CPU予約性能

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

cpuShare

説明

CPU配分比

型

int

出現回数

lserverの数分(それぞれに対して0または1)

memorySize

説明

メモリ量

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

memoryReserve

説明

メモリ予約容量

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

memoryShare

説明

メモリ配分比

型

int

出現回数

lserverの数分(それぞれに対して0または1)

requestCpuPerf

説明

要求CPU性能

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

requestNumOfCpu

説明

要求CPU数

型

int

出現回数

lserverの数分(それぞれに対して0または1)

requestMemorySize

説明

要求メモリ容量

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

lseverType

説明

サーバタイプ。次の値のどちらかです。

・Physical：物理サーバ。

・Virtual：仮想サーバ。

型

decimal

出現回数

lserverの数分(それぞれに対して0または1)

serverType

説明

サーバのタイプ

型

string ASCII

出現回数

lserverの数分(それぞれに対して0または1)

priority

説明

一括電源制御時の起動優先度。0～256になります。
この値が小さなサーバから起動されます。
ただし、起動優先度が「0」のサーバは一括電源操作の対象になりません。

型

int

出現回数

lserverの数分(それぞれに対して0または1)

lplatformId

説明

L-Platform ID

型

string ASCII

出現回数

0または1

lplatformName

説明

L-Platform名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatform>
    <baseDescriptor>template-1325738ea5b</baseDescriptor>
    <creator>tenantA</creator>
    <ownerUser>user1</ownerUser>
    <description>firewallテスト</description>
    <firewalls>
      <firewall>
        <interfaces>
          <interface>
            <name>network-param-0001</name>
            <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
          </interface>
          <interface>
            <name>network-param-0002</name>
            <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
          </interface>
        </interfaces>
        <name>Firewall</name>
        <ruleset>
          <description>ルールセット(rule1)の説明（日本語）</description>
          <name>rule1</name>
          <parameters>
            <parameter>
              <description>パラメタ1の詳細説明（日本語）</description>
              <name>param_var_001</name>
              <value>200</value>
              <view>false</view>
            </parameter>
            <parameter>
              <description>パラメタ2の詳細説明（日本語）</description>
              <name>param_var_002</name>
              <value/>
              <view>true</view>
            </parameter>
            <parameter>
              <description>パラメタ3の詳細説明（日本語）</description>
              <name>param_var_003</name>
              <value>400</value>
              <view>true</view>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <networks>
      <network>
        <name>network-param-0001</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
      </network>
      <network>
        <name>network-param-0002</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
        <numOfMaxVm>10</numOfMaxVm>
      </network>
    </networks>
    <lservers>
      <lserver>
        <cpuPerf>1.0</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e093f4e</diskimageId>
        <diskimageName>g-physical-0001</diskimageName>
        <hostName>V8O0NW7TZV0001</hostName>
        <memorySize>2.0</memorySize>
        <numOfCpu>2</numOfCpu>
        <requestCpuPerf>1.4</requestCpuPerf>
        <requestMemorySize>2.0</requestMemorySize>
        <requestNumOfCpu>1</requestNumOfCpu>
        <storagePool>/StoragePool</storagePool>
        <lserverType>Physical</lserverType>
        <disks/>
        <vmPool>/ServerPool</vmPool>
        <vmType>VMware</vmType>
        <nics>
          <nic>
            <management>0</management>
            <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.168.0.4</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>8O0NW7TZV-N-1ot2#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.168.0.3</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-8O0NW7TZV-S-0001</lserverId>
        <lserverName>物理サーバ-1</lserverName>
        <lserverStatus>RUNNING</lserverStatus>
        <serverType>Economy</serverType>
        <priority>10</priority>
      </lserver>
      <lserver>
        <cpuPerf>1.2</cpuPerf>
        <creator>tenantA</creator>
        <diskimageId>image-1324e09f82f</diskimageId>
        <diskimageName>g-vm-0002</diskimageName>
        <hostName>V8O0NW7TZV0002</hostName>
        <memorySize>1.6</memorySize>
        <numOfCpu>1</numOfCpu>
        <storagePool>/StoragePool</storagePool>
        <lserverType>Virtual</lserverType>
        <disks/>
        <vmPool>/VMHostPool</vmPool>
        <vmType>VMware</vmType>
        <nics>
          <nic>
            <management>0</management>
            <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
            <nicNo>3</nicNo>
            <privateIp>192.168.0.2</privateIp>
          </nic>
          <nic>
            <management>0</management>
            <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
            <nicNo>2</nicNo>
            <privateIp>192.168.0.1</privateIp>
          </nic>
          <nic>
            <management>1</management>
            <networkId>8O0NW7TZV-N-1ot4#FWS#</networkId>
            <nicNo>1</nicNo>
            <privateIp>192.168.0.0</privateIp>
          </nic>
        </nics>
        <lserverId>tenantA-8O0NW7TZV-S-0002</lserverId>
        <lserverName>仮想マシン-1</lserverName>
        <lserverStatus>RUNNING</lserverStatus>
        <serverType>over_commit</serverType>
        <priority>20</priority>
      </lserver>
    </lservers>
    <lplatformId>tenantA-8O0NW7TZV</lplatformId>
    <lplatformName>firewall-test</lplatformName>
  </lplatform>
</GetLPlatformConfigurationResponse>

7.3.2.7 GetLPlatformAttributes (L-Platformの属性を取得)

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

設定内容

固定。「GetLPlatformAttributes」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

GetLPlatformAttributes -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatform>
    <baseDescriptor>[L-Platformの元になったテンプレートID]</baseDescriptor>
    <creator>[L-Platform作成者のテナント名]</creator>
    <ownerUser>[L-Platformの所有者のユーザーID]</ownerUser>
    <description>[L-Platformの説明]</description>
    <lplatformId>[L-Platform ID]</lplatformId>
    <lplatformName>[L-Platform名]</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>

《要素》

要素名

項目

項目説明

GetLPlatformAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lplatform

説明

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

型

なし

出現回数

0または1

baseDescriptor

説明

L-Platformの元になったテンプレートID

型

string ASCII

出現回数

0または1

creator

説明

L-Platform作成者のテナント名

型

string ASCII

出現回数

0または1

ownerUser

説明

L-Platformの所有者のユーザーID

型

string ASCII

出現回数

0または1

description

説明

L-Platformの説明

型

string UTF-8

出現回数

0または1

lplatformId

説明

L-Platform ID

型

string ASCII

出現回数

0または1

lplatformName

説明

L-Platform名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatform>
    <baseDescriptor>template-132149ef229</baseDescriptor>
    <creator>tenantA</creator>
    <ownerUser>user1</ownerUser>
    <description>desc</description>
    <lplatformId>tenantA-VBMS7X11R</lplatformId>
    <lplatformName>testTemplateA</lplatformName>
  </lplatform>
</GetLPlatformAttributesResponse>

7.3.2.8 ListNetworkInfo (L-Platformのネットワーク情報を取得)

対象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

設定内容

固定。「ListNetworkInfo」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

ListNetworkInfo -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <networks>
    <network>
      <networkId>[ネットワークID]</networkId>
      <name>[ネットワーク名]</name>
      <networkCategory>[ネットワーク種別]</networkCategory>
      <numOfMaxVm>[最大VM数]</numOfMaxVm>
      <segmentType>[セグメント識別情報]</segmentType>
      <addressSet>
        <name>[アドレスセット名]</name>
        <subnet>[アドレスセットのサブネットアドレス]</subnet>
        <mask>[アドレスセットのネットマスク]</mask>
        <start>[アドレスセットの開始アドレス]</start>
        <end>[アドレスセットの終了アドレス]</end>
      </addressSet>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>[除外アドレスの開始アドレス]</start>
          <end>[除外アドレスの終了アドレス]</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <addressSetStatus>
        <num>[アドレスセットのアドレス総数]</num>
        <used>[アドレスセットの予約済みアドレス個数]</used>
        <avail>[アドレスセットの空きアドレス個数]</avail>
      </addressSetStatus>
    </network>
  </networks>
</ListNetworkInfoResponse>

《要素》

要素名

項目

項目説明

ListNetworkInfoResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

networks

説明

ネットワーク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

network

説明

ネットワーク情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

name

説明

L-Platform名

型

string UTF-8

出現回数

networkの数分(それぞれに対して0または1)

networkCategory

説明

ネットワーク種別。管理LANの場合は「MANAGEMENT」、業務LANの場合は「BUSINESS」です。登録されていない場合は空文字になります。

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

numOfMaxVm

説明

最大VM数

型

int

出現回数

networkの数分(それぞれに対して0または1)

segmentType

説明

セグメント識別情報

型

string UTF-8

出現回数

networkの数分(それぞれに対して0または1)

addressSet

説明

アドレスセット情報の一式

型

なし

出現回数

networkの数分(それぞれに対して0または1)

name

説明

アドレスセット名

型

string UTF-8

出現回数

addressSetの数分(それぞれに対して0または1)

subnet

説明

アドレスセットのサブネットアドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

mask

説明

アドレスセットのネットマスク

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

start

説明

アドレスセットの開始アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

end

説明

アドレスセットの終了アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

excludeaddressranges

説明

除外アドレス情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

excludeaddressrange

説明

除外アドレス情報の一式

型

なし

出現回数

0以上

start

説明

除外アドレスの開始アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

end

説明

除外アドレスの終了アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

addressSetStatus

説明

アドレスセットのステータス情報の一式

型

なし

出現回数

0または1

num

説明

アドレスセットのアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)

used

説明

アドレスセットの予約済みアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)

avail

説明

アドレスセットの空きアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version=”1.0” encoding=”UTF-8”?>
<ListNetworkInfoResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set10</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>138</avail>
        <num>140</num>
        <used>2</used>
      </addressSetStatus>
      <networkCategory>BUSINESS</networkCategory>
      <networkId>testorg-lplatform-3-N-INTRANET</networkId>
      <numOfMaxVm>10</numOfMaxVm>
      <segmentType>DMZ</segmentType>
    </network>
    <network>
      <addressSet>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set20</name>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>116</avail>
        <num>120</num>
        <used>4</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <end>192.xxx.xxx.xxx</end>
          <start>192.xxx.xxx.xxx</start>
        </excludeaddressrange>
      </excludeaddressranges>
      <networkCategory>MANAGEMENT</networkCategory>
      <networkId>testorg-lplatform-3-N-INTERNET</networkId>
    </network>
  </networks>
</ListNetworkInfoResponse>

7.3.2.9 StartLPlatform (L-Platformに含まれるサーバを一括電源ON)

L-Platformに含まれるサーバを一括電源ONします。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「StartLPlatform」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

StartLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StartLPlatformResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.2.10 StopLPlatform (L-Platformに含まれるサーバを一括電源OFF)

L-Platformに含まれるサーバを一括電源OFFします。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「StopLPlatform」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


コマンド

StopLPlatform -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StopLPlatformResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.2.11 StartTenantLServers (テナントに含まれるサーバを一括電源ON)

テナントに含まれるすべてのサーバを一括電源ONします。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「StartTenantLServers」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

StartTenantLServers -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StartTenantLServersResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.2.12 StopTenantLServers (テナントに含まれるサーバを一括電源OFF)

テナントに含まれるすべてのサーバを一括電源OFFします。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「StopTenantLServers」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

StopTenantLServers -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StopTenantLServersResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

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

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

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

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

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

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

リクエストパラメーター

パラメーター名

項目

項目説明

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」の「L-Platformテンプレートの最大接続数の設定」を参照してください。

[networkCategory]

説明

ネットワーク種別。指定したネットワーク種別のネットワークセグメントを追加します。

型

string ASCII

設定内容

以下のどちらかを指定してください。

・MANAGEMENT:管理セグメント。

・BUSINESS: 業務セグメント。

resourceIdを指定しない場合は、必ず指定してください。

[segmentType]

説明

セグメント識別情報。一致するネットワークリソースのネットワークセグメントを追加します。

型

string ASCII

設定内容

32文字以内。
resourceIdを省略した場合に指定可能です。

[name]

説明

ネットワーク名。ネットワークに設定する名前を指定してください。

型

string ASCII

設定内容

20文字以内。
省略した場合は以下の名前を設定します。
・resourceIdを指定した場合：ネットワークリソースの名前
・networkCategoryを指定した場合：AUTOX。Xには1から始まる連番を設定します。


コマンド

CreateNetwork -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID [-resourceId リソースID] -numOfMaxNic 最大NIC数 [-networkCategory ネットワーク種別] [-segmentType セグメント識別情報] [-name ネットワーク名]

レスポンス

《ステータスコード》

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

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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>


7.3.2.14 DestroyNetwork (指定したネットワークセグメントをL-Platformから削除)

指定したネットワークセグメントを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

設定内容

固定。「DestroyNetwork」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

networkId

説明

削除するネットワークID

型

string ASCII

設定内容

32文字以内


コマンド

DestroyNetwork -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -networkId ネットワークID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DestroyNetworkResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

前次
Copyright 2011-2012 FUJITSU LIMITED