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

7.3.1 L-Platformテンプレートの操作

L-Platformテンプレートの操作に関連するL-Platform APIについて説明します。

7.3.1.1 ListLPlatformDescriptor (テンプレート一覧を取得)

仮想データセンター内のテンプレート一覧を取得します。

同時にテンプレートの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

[keyword]

説明

一覧に表示するテンプレートを絞り込むためのキーワード。指定した場合は、同じキーワードを含むテンプレートだけがレスポンスに含まれます。

型

string UTF-8

設定内容

85文字以内


コマンド

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

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>[L-Platformテンプレート作成者のテナント名]</creatorName>
      <description>[L-Platformテンプレートの説明]</description>
      <registrant>[L-Platformテンプレート登録者のID]</registrant>
      <lplatformdescriptorId>[L-PlatformテンプレートID]</lplatformdescriptorId>
      <lplatformdescriptorName>[L-Platformテンプレート名]</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

《要素》

要素名

項目

項目説明

ListLPlatformDescriptorResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lplatformdescriptors

説明

L-Platformテンプレート一覧のレスポンス情報を持つ要素

型

なし

出現回数

0または1

lplatformdescriptor

説明

L-Platformテンプレート情報の一式

型

なし

出現回数

0以上

creatorName

説明

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

型

string ASCII

出現回数

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

description

説明

L-Platformテンプレートの説明

型

string UTF-8

出現回数

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

registrant

説明

L-Platformテンプレート登録者のID

型

string ASCII

出現回数

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

lplatformdescriptorId

説明

L-PlatformテンプレートID

型

string ASCII

出現回数

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

lplatformdescriptorName

説明

L-Platformテンプレート名

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_GL</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826</lplatformdescriptorName>
    </lplatformdescriptor>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_net</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826_net</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

7.3.1.2 ListDiskImage (マスターイメージの一覧を取得)

仮想データセンター内にあるディスクイメージのIDを取得します。ディスクイメージのコンテンツに対応するProduct IDは、ディスクイメージを登録する際に指定します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

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

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <diskimages>
    <diskimage>
      <creatorName>[ディスクイメージの作成者のテナント名]</creatorName>
      <name>[ディスクイメージ情報の名称]</name>
      <diskimageId>[ディスクイメージID]</diskimageId>
      <diskimageName>[ディスクイメージ名]</diskimageName>
      <registrant>[ディスクイメージの登録者のID]</registrant>
      <size>[ディスクイメージのサイズ]</size>
      <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
      <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
      <maxMemorySize>[最大メモリ量]</maxMemorySize>
      <numOfMaxDisk>[最大ディスク数]</numOfMaxDisk>
      <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      <numOfMaxNic>[最大NIC数]</numOfMaxNic>
      <softwares>
        <software>
          <license>[ライセンス]</license>
          <name>[ソフトウェア名称]</name>
          <softwareId>[ソフトウェアID]</softwareId>
          <category>[ソフトウェア区分]</category>
          <osCategory>[OS区分]</osCategory>
          <version>[バージョン]</version>
          <officialVersion>[正式バージョン]</officialVersion>
          <patch>[パッチ版数]</patch>
          <support>[サポート]</support>
        </software>
      </softwares>
      <patches>
        <patch>
          <softwareId>[ソフトウェアID]</softwareId>
          <patchId>[パッチID]</patchId>
          <componentName>[コンポーネント名]</componentName>
          <description>[パッチの説明]</description>
        </patch>
      </patches>
    </diskimage>
  </diskimages>
</ListDiskImageResponse>

《要素》

要素名

項目

項目説明

ListDiskImageResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

diskimages

説明

ディスクイメージ情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

diskimage

説明

ディスクイメージ情報の一式

型

なし

出現回数

0以上

creatorName

説明

ディスクイメージ作成者のテナント名

型

string ASCII

出現回数

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

name

説明

ディスクイメージ情報の名称

型

string ASCII

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

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

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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

registrant

説明

ディスクイメージの登録者のID

型

string ASCII

出現回数

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

size

説明

ディスクイメージのサイズ。単位は「GB」です。

型

decimal

出現回数

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

maxCpuPerf

説明

最大CPU性能

型

decimal

出現回数

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

numOfMaxCpu

説明

最大CPU数

型

int

出現回数

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

maxMemorySize

説明

最大メモリ量

型

decimal

出現回数

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

numOfMaxDisk

説明

最大ディスク数

型

int

出現回数

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

maxDiskSize

説明

最大ディスク容量

型

decimal

出現回数

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

numOfMaxNic

説明

最大NIC数

型

int

出現回数

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

softwares

説明

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

型

なし

出現回数

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

software

説明

ソフトウェア情報の一式

型

なし

出現回数

0以上

license

説明

ライセンス

型

string UTF-8

出現回数

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

name

説明

ソフトウェア名

型

string UTF-8

出現回数

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

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

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

category

説明

ソフトウェア区分

型

string UTF-8

出現回数

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

osCategory

説明

OS区分

型

string UTF-8

出現回数

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

version

説明

バージョン

型

string UTF-8

出現回数

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

officialVersion

説明

正式バージョン

型

string UTF-8

出現回数

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

patch

説明

パッチ版数

型

string UTF-8

出現回数

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

support

説明

サポート

型

string UTF-8

出現回数

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

patches

説明

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

型

なし

出現回数

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

patch

説明

パッチ情報の一式

型

なし

出現回数

0以上

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

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

patchId

説明

パッチID

型

string ASCII

出現回数

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

componentName

説明

コンポーネント名

型

string UTF-8

出現回数

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

description

説明

パッチの説明

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
 <ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <diskimages>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image_id_1</diskimageId>
      <diskimageName>image-1</diskimageName>
      <maxCpuPerf>3.0</maxCpuPerf>
      <maxDiskSize>500.0</maxDiskSize>
      <maxMemorySize>4.0</maxMemorySize>
      <numOfMaxCpu>4</numOfMaxCpu>
      <numOfMaxDisk>3</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <patches>
        <patch>
          <componentName>INSERVEE</componentName>
          <description>JServlet緊急修正</description>
          <patchId>T000519WP-04</patchId>
          <softwareId>SW00000004</softwareId>
        </patch>
      </patches>
      <registrant>cfmgadm</registrant>
      <size>15.0</size>
      <softwares>
        <software>
          <category>APP</category>
          <license>Fujitsu</license>
          <name>Interstage Application Server(日本語版)</name>
          <officialVersion />
          <osCategory>windows</osCategory>
          <patch />
          <softwareId>SW00000004</softwareId>
          <support>SDK基本</support>
          <version>6.1</version>
        </software>
      </softwares>
    </diskimage>
  </diskimages>
</ListDiskImageResponse>

7.3.1.3 ListServerType (L-Serverテンプレート一覧を取得)

仮想データセンター内にあるサーバイメージタイプの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

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

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <servertypes>
    <servertype>
      <comment>[コメント]</comment>
      <cpu>
        <cpuArch>[CPUアーキテクチャー]</cpuArch>
        <cpuPerf>[CPU性能]</cpuPerf>
        <numOfCpu>[CPU数]</numOfCpu>
        <cpuReserve>[CPU予約性能]</cpuReserve>
        <cpuShare>[CPU配分比]</cpuShare>
      </cpu>
      <disks>
        <disk>
          <diskSize>[ディスク容量]</diskSize>
          <diskIndex>[ディスクインデックス]</diskIndex>
        </disk>
      </disks>
      <id>[ID]</id>
      <label>[ラベル]</label>
      <memory>
        <memorySize>[メモリサイズ]</memorySize>
        <memoryReserve>[メモリ予約容量]</memoryReserve>
        <memoryShare>[メモリ配分比]</memoryShare>
      </memory>
      <name>[L-Serverテンプレート名]</name>
      <nics>
        <numOfNIC>[NIC数]</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>[運用位置]</positioning>
        <redundancy>[冗長性]</redundancy>
      </serverPolicy>
      <lserverType>[サーバタイプ]</lserverType>
      <vmType>[VM種別]</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

《要素》

要素名

項目

項目説明

ListServerTypeResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

servertypes

説明

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

型

なし

出現回数

0または1

servertype

説明

サーバタイプ情報の一式

型

なし

出現回数

0以上

comment

説明

コメント

型

string UTF-8

出現回数

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

cpu

説明

CPU情報の一式

型

なし

出現回数

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

cpuArch

説明

CPUアーキテクチャー。以下のどちらかになります。
・「IA」: IA
・「SPARC」: SPARC

型

string ASCII

出現回数

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

cpuPerf

説明

CPU性能

型

decimal

出現回数

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

numOfCpu

説明

CPU数

型

int

出現回数

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

cpuReserve

説明

CPU予約性能

型

decimal

出現回数

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

cpuShare

説明

CPU配分比

型

int

出現回数

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

disks

説明

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

型

なし

出現回数

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

disk

説明

ディスク情報の一式

型

なし

出現回数

0以上

diskSize

説明

ディスク容量

型

decimal

出現回数

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

diskIndex

説明

ディスクインデックス

型

int

出現回数

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

id

説明

サーバID

型

string ASCII

出現回数

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

label

説明

サーバラベル

型

string UTF-8

出現回数

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

memory

説明

メモリ情報の一式

型

なし

出現回数

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

memorySize

説明

メモリサイズ

型

decimal

出現回数

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

memoryReserve

説明

メモリ予約容量

型

decimal

出現回数

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

memoryShare

説明

メモリ配分比

型

int

出現回数

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

name

説明

L-Serverテンプレート名

型

string UTF-8

出現回数

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

nics

説明

NIC情報の一式

型

なし

出現回数

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

numOfNIC

説明

NIC数

型

int

出現回数

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

serverPolicy

説明

サーバポリシー情報の一式

型

なし

出現回数

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

positioning

説明

運用位置。以下のどれかになります。
・「Fixed」: 位置固定
・「AttachAtBoot」: 起動ごとに可変
・「Flexible」:運用中も可変

型

string ASCII

出現回数

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

redundancy

説明

冗長性

型

string UTF-8

出現回数

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

lservertype

説明

サーバタイプ。以下のどちらかになります。
・「Physical」: 物理サーバ
・「Virtual」: 仮想サーバ

型

string ASCII

出現回数

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

vmType

説明

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

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <servertypes>
    <servertype>
      <comment>コメント1</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.6</cpuPerf>
        <numOfCpu>4</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>1</id>
      <label>ラベル1</label>
      <memory>
        <memorySize>8</memorySize>
      </memory>
      <name>High Performance</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <vmType>VMware</vmType>
    </servertype>
    <servertype>
      <comment>コメント2</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.0</cpuPerf>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <numOfCpu>2</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>2</id>
      <label>ラベル2</label>
      <memory>
        <memorySize>4</memorySize>
        <memoryReserve>0.5</memoryReserve>
        <memoryShare>1000</memoryShare>
      </memory>
      <name>Middle Spec</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <vmType>RHEL-Xen</vmType>
    </servertype>
    <servertype>
      <comment>コメント3</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>1.4</cpuPerf>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <numOfCpu>1</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>3</id>
      <label>ラベル3</label>
      <memory>
        <memorySize>2</memorySize>
      </memory>
      <name>Economy</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <vmType>VMware</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

7.3.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文字以内


コマンド

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

レスポンス

《ステータスコード》

正常に終了した場合に「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>
          <parameters>
            <parameter>
              <description>[パラメーター情報の説明]</description>
              <name>[パラメーター情報名]</name>
              <value>[パラメーターの値]</value>
              <view>[パラメーターの表示の有無]</view>
            </parameter>
          </parameters>
        </ruleset>
      </firewall>
    </firewalls>
    <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>
            <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

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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)

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)

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)

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

7.3.1.5 GetLPlatformDescriptorAttributes (テンプレートの属性を取得)

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformDescriptorId

説明

L-PlatformテンプレートID

型

string ASCII

設定内容

32文字以内


コマンド

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

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatformdescriptor>
    <creatorName>[L-Platformテンプレートの作成者のテナント名]</creatorName>
    <description>[L-Platformテンプレートの説明]</description>
    <registrant>[L-Platformテンプレートの登録者]</registrant>
    <lplatformdescriptorId>[L-PlatformテンプレートID]</lplatformdescriptorId>
    <lplatformDescriptorName>[L-Platformテンプレート名]</lplatformDescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorAttributesResponse>

《要素》

要素名

項目

項目説明

GetLPlatformDescriptorAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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

lplatformdescriptorId

説明

L-PlatformテンプレートID

型

string ASCII

出現回数

0または1

lplatformdescriptorName

説明

L-Platformテンプレート名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLPlatformDescriptorAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptor>
    <creatorName>cfmgadm</creatorName>
    <description>desc</description>
    <registrant>cfmgadm</registrant>
    <lplatformdescriptorId>TMPL_Win2k8x86_0826_net</lplatformdescriptorId>
    <lplatformdescriptorName>Win2k8x86_0826_net</lplatformdescriptorName>
  </lplatformdescriptor>
</GetLPlatformDescriptorAttributesResponse>

7.3.1.6 GetPoolList (リソースプールの一覧を取得)

リソースプールの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

[type]

説明

リソースプールの種別。省略時はすべての種別のリソースプールを取得します。

型

string ASCII

設定内容

以下のどれかを選択します。
・「vm」：VMプール
・「storage」：ストレージプール
・「mac」：MACアドレスセット
・「server」：サーバプール
・「image」：イメージプール


コマンド

GetPoolList -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名
 [-type リソースプールの種別]

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <resourcepools>
    <vmpools>
      <vmpool>
        <name>[VMプールのリソース名]</name>
        <vmpoolResourceId>[VMプールのリソースID]</vmpoolResourceId>
        <priority>[優先順位]</priority>
        <cpuTotal>[CPU総容量]</cpuTotal>
        <cpuFree>[CPU空き容量]</cpuFree>
        <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
        <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
        <memoryTotal>[メモリ総容量]</memoryTotal>
        <memoryFree>[メモリ空き容量]</memoryFree>
        <maxMemorySize>[最大メモリ量]</maxMemorySize>
      </vmpool>
    </vmpools>
    <storagepools>
      <storagepool>
        <name>[ストレージプールのリソース名]</name>
        <storagepoolResourceId>[ストレージプールのリソースID]</storagepoolResourceId>
        <priority>[優先順位]</priority>
        <total>[ストレージ総容量]</total>
        <free>[ストレージ空き容量]</free>
        <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      </storagepool>
    </storagepools>
    <macaddresses>
      <macaddress>
        <name>[MACアドレスセットのリソース名]</name>
        <macaddresspoolResourceId>[MACアドレスセットのリソースID]</macaddresspoolResourceId>
        <total>[MACアドレス総数]</total>
        <free>[空きMACアドレス数]</free>
      </macaddress>
    </macaddresses>
    <serverPools>
      <serverpool>
        <free>[未使用物理サーバ数]</free>
        <name>[サーバプールのリソース名]</name>
        <serverpoolResourceId>[サーバプールのリソースID]</serverpoolResourceId>
        <total>[物理サーバ総数]</total>
      </serverpool>
    </serverPools>
    <imagePools>
      <imagepool>
        <imagepoolResourceId>[イメージプールのリソースID]</imagepoolResourceId>
        <name>[イメージプールのリソース名]</name>
        <priority>[優先順位]</priority>
        <num>[イメージ数]</num>
      </imagepool>
    </imagePools>
  </resourcepools>
</GetPoolListResponse>

《要素》

要素名

項目

項目説明

GetPoolListResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

resourcepools

説明

リソースプール情報のレスポンス情報を持つ要素

型

なし

出現回数

1

vmpools

説明

VMプール情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vmpool

説明

VMプール情報の一式

型

なし

出現回数

0以上

name

説明

VMプールのリソース名

型

string UTF-8

出現回数

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

vmpoolResourceId

説明

VMプールのリソースID

型

string ASCII

出現回数

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

priority

説明

優先順位

型

int

出現回数

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

cpuTotal

説明

CPU総容量

型

decimal

出現回数

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

cpuFree

説明

CPU空き容量

型

decimal

出現回数

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

maxCpuPerf

説明

最大CPU性能

型

decimal

出現回数

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

numOfMaxCpu

説明

最大CPU数

型

int

出現回数

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

memoryTotal

説明

メモリ総容量

型

decimal

出現回数

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

memoryFree

説明

メモリ空き容量

型

decimal

出現回数

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

maxMemorySize

説明

最大メモリ量

型

decimal

出現回数

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

storagepools

説明

ストレージプール情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

storagepool

説明

ストレージプール情報の一式

型

なし

出現回数

0以上

name

説明

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

型

string UTF-8

出現回数

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

storagepoolResrouceId

説明

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

型

string ASCII

出現回数

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

priority

説明

優先順位

型

int

出現回数

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

total

説明

ストレージ総容量

型

decimal

出現回数

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

free

説明

ストレージ空き容量

型

decimal

出現回数

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

maxDiskSize

説明

最大ディスク容量

型

decimal

出現回数

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

macaddresses

説明

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

型

なし

出現回数

0または1

macaddress

説明

MACアドレス情報の一式

型

なし

出現回数

0以上

name

説明

MACアドレスセットのリソース名

型

string UTF-8

出現回数

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

macaddresspoolResourceId

説明

MACアドレスセットのリソースID

型

string ASCII

出現回数

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

total

説明

MACアドレス総数

型

int

出現回数

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

free

説明

空きMACアドレス数

型

int

出現回数

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

serverPools

説明

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

型

なし

出現回数

0または1

serverPool

説明

サーバプール情報の一式

型

なし

出現回数

0以上

name

説明

サーバプールのリソース名

型

string UTF-8

出現回数

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

serverpoolResourceId

説明

サーバプールのリソースID

型

string ASCII

出現回数

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

total

説明

物理サーバ総数

型

int

出現回数

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

free

説明

未使用物理サーバ総数

型

int

出現回数

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

imagePools

説明

イメージプール情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

imagePool

説明

イメージプール情報の一式

型

なし

出現回数

0以上

name

説明

イメージプールのリソース名

型

string UTF-8

出現回数

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

imagepoolResourceId

説明

イメージプールのリソースID

型

string ASCII

出現回数

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

priority

説明

優先順位

型

int

出現回数

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

num

説明

イメージ数

型

int

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <resourcepools>
    <imagePools>
      <imagepool>
        <imagepoolResourceId>WIN-5EGJBQPP4SJ_9</imagepoolResourceId>
        <name>/ImagePool</name>
      </imagepool>
      <imagepool>
        <imagepoolResourceId>WIN-5EGJBQPP4SJ_3429</imagepoolResourceId>
        <name>/tenantA/ImagePool</name>
      </imagepool>
    </imagePools>
    <serverPools>
      <serverpool>
        <free>8</free>
        <name>/ServerPool</name>
        <serverpoolResourceId>WIN-5EGJBQPP4SJ_5</serverpoolResourceId>
        <total>9</total>
      </serverpool>
      <serverpool>
        <free>3</free>
        <name>/tenantA/ServerPool</name>
        <serverpoolResourceId>WIN-5EGJBQPP4SJ_5</serverpoolResourceId>
        <total>4</total>
      </serverpool>
    </serverPools>
    <storagepools>
      <storagepool>
        <free>99.2</free>
        <maxDiskSize>99.7</maxDiskSize>
        <name>/StoragePool</name>
        <storagepoolResourceId>WIN-5EGJBQPP4SJ_6</storagepoolResourceId>
        <total>99.7</total>
      </storagepool>
    </storagepools>
    <vmpools>
      <vmpool>
        <cpuFree>63.8</cpuFree>
        <cpuTotal>63.8</cpuTotal>
        <maxCpuPerf>2.6</maxCpuPerf>
        <maxMemorySize>13.7</maxMemorySize>
        <memoryFree>27.4</memoryFree>
        <memoryTotal>27.4</memoryTotal>
        <name>/VMHostPool</name>
        <numOfMaxCpu>12.0</numOfMaxCpu>
        <vmpoolResourceId>WIN-5EGJBQPP4SJ_4</vmpoolResourceId>
      </vmpool>
    </vmpools>
  </resourcepools>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</GetPoolListResponse>

7.3.1.7 ListNetworkResource (ネットワークリソースの一覧を取得)

ネットワークリソースの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

networkCategory

説明

ネットワーク種別。指定したネットワーク種別のネットワークリソースを取得します。

型

string ASCII

設定内容

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

・MANAGEMENT: ネットワーク種別にMANAGEMENTが設定されているネットワークリソースを取得します。
・BUSINESS: ネットワーク種別にBUSINESSが設定されているネットワークリソースを取得します。

省略時は、すべてのネットワークリソースを取得します。

segmentType

説明

セグメント識別情報。登録されているセグメント識別情報が一致するネットワークリソースを取得します。

型

string ASCII

設定内容

32文字以内

showTenant

説明

テナント名表示オプション。

型

string ASCII

設定内容

「true」または「false」のどちらかを指定してください。

省略時は「false」が指定されたものとして動作します。

コマンド

ListNetworkResource -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名 [-networkCategory ネットワーク種別] [-segmentType セグメント識別情報] [-showTenant テナント名表示]

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>[アドレスセットの終了アドレス]</end>
        <mask>[アドレスセットのネットマスク]</mask>
        <name>[アドレスセットの名前]</name>
        <start>[アドレスセットの開始アドレス]</start>
        <subnet>[アドレスセットのサブネットアドレス]</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>[アドレスセットの空きアドレス個数]</avail>
        <num>[アドレスセットのアドレス個数]</num>
        <used>[アドレスセットの予約済みアドレス個数]</used>
      </addressSetStatus>
      <networkCategory>[ネットワーク種別]</networkCategory>
      <vlanId>[VLANID]</vlanId>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>[除外アドレスの開始アドレス]</start>
          <end>[除外アドレスの終了アドレス]</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <vlanId>12</vlanId>
      <resourceId>[ネットワークリソースID]</resourceId>
      <resourceName>[ネットワークリソース名]</resourceName>
      <resourceType>[ネットワークリソースの種別]</resourceType>
      <tenantName>[ネットワークプールのリソースプールのテナント名]</tenantName>
      <comment>[コメント]</comment>
      <gateway>[デフォルトゲートウェイ]</gateway>
    </network>
  </networks>
</ListNetworkResourceResponse>

《要素》

要素名

項目

項目説明

ListNetworkResourceResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

networks

説明

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

型

なし

出現回数

0または1

network

説明

ネットワークリソース情報の一式

型

なし

出現回数

0以上

resourceId

説明

ネットワークリソースID

型

string ASCII

出現回数

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

resourceName

説明

ネットワークリソース名

型

string ASCII

出現回数

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

tenantName

説明

ネットワークプールのリソースプールのテナント名

型

string ASCII

出現回数

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

networkCategory

説明

ネットワーク種別

型

string ASCII

出現回数

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

vlanId

説明

VLANID

型

string ASCII

出現回数

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

resourceType

説明

ネットワークリソースの種別

型

string ASCII

出現回数

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

segmentType

説明

セグメント識別情報

型

string ASCII

出現回数

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

comment

説明

コメント

型

string ASCII

出現回数

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

gateway

説明

デフォルトゲートウェイ

型

string ASCII

出現回数

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

addressSet

説明

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

型

なし

出現回数

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

name

説明

アドレスセットの名前

型

string ASCII

出現回数

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

説明

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

型

なし

出現回数

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

excludeaddressrange

説明

除外アドレス情報の一式

型

なし

出現回数

0以上

start

説明

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

型

string ASCII

出現回数

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

end

説明

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

型

string ASCII

出現回数

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

addressSetStatus

説明

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

型

なし

出現回数

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

num

説明

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

型

string ASCII

出現回数

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

used

説明

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

型

string ASCII

出現回数

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

avail

説明

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

型

string ASCII

出現回数

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

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse 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>
      <vlanId>11</vlanId>
      <resourceId>network-t-0001</resourceId>
      <resourceName>tenantA-DMZ</resourceName>
      <segmentType>SECURE</segmentType>
    </network>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>Global-Secure</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>254</avail>
        <num>254</num>
        <used>254</used>
      </addressSetStatus>
      <networkCategory>MANAGEMENT</networkCategory>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>192.xxx.xxx.xxx</start>
          <end>192.xxx.xxx.xxx</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <vlanId>12</vlanId>
      <resourceId>network-t-0002</resourceId>
      <resourceName>tenantA-Secure</resourceName>
    </network>
  </networks>
</ListNetworkResourceResponse>

前次
Copyright 2011-2012 FUJITSU LIMITED