2.1.3 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 ：イメージプール

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名	項目	項目説明
GetPoolListResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
resourcepools	説明	リソースプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	1
imagepools	説明	イメージプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
imagepool	説明	イメージプール情報の一式
	型	なし
	出現回数	imagepoolの数分(それぞれに対して0以上)
imagepoolResourceId	説明	イメージプールのリソースID
	型	string ASCII
	出現回数	imagepoolの数分(それぞれに対して0または1)
name	説明	イメージプールのリソース名
	型	string UTF-8
	出現回数	imagepoolの数分(それぞれに対して0または1)
num	説明	イメージ数
	型	int
	出現回数	imagepoolの数分(それぞれに対して0または1)
priority	説明	優先順位
	型	int
	出現回数	imagepoolの数分(それぞれに対して0または1)
macaddresses	説明	MACアドレス情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
macaddress	説明	MACアドレス情報の一式
	型	なし
	出現回数	macaddressesの数分(それぞれに対して0以上)
free	説明	空きMACアドレス数
	型	int
	出現回数	macaddressの数分(それぞれに対して0または1)
macaddresspoolResourceId	説明	MACアドレスセットのリソースID
	型	string ASCII
	出現回数	macaddressの数分(それぞれに対して0または1)
name	説明	MACアドレスセットのリソース名
	型	string UTF-8
	出現回数	macaddressの数分(それぞれに対して0または1)
total	説明	MACアドレス総数
	型	int
	出現回数	macaddressの数分(それぞれに対して0または1)
serverpools	説明	サーバプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
serverpool	説明	サーバプール情報の一式
	型	なし
	出現回数	serverpoolsの数分(それぞれに対して0以上)
free	説明	未使用物理サーバ総数
	型	int
	出現回数	serverpoolの数分(それぞれに対して0または1)
name	説明	サーバプールのリソース名
	型	string UTF-8
	出現回数	serverpoolの数分(それぞれに対して0または1)
serverpoolResourceId	説明	サーバプールのリソースID
	型	string ASCII
	出現回数	serverpoolの数分(それぞれに対して0または1)
total	説明	物理サーバ総数
	型	int
	出現回数	serverpoolの数分(それぞれに対して0または1)
storagepools	説明	ストレージプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
storagepool	説明	ストレージプール情報の一式
	型	なし
	出現回数	storagepoolsの数分(それぞれに対して0以上)
free	説明	ストレージ空き容量
	型	decimal
	出現回数	storagepoolの数分(それぞれに対して0または1)
maxDiskSize	説明	最大ディスク容量
	型	decimal
	出現回数	storagepoolの数分(それぞれに対して0または1)
name	説明	ストレージプールのリソース名
	型	string UTF-8
	出現回数	storagepoolの数分(それぞれに対して0または1)
priority	説明	優先順位
	型	int
	出現回数	storagepoolの数分(それぞれに対して0または1)
storagepoolResrouceId	説明	ストレージプールのリソースID
	型	string ASCII
	出現回数	storagepoolの数分(それぞれに対して0または1)
total	説明	ストレージ総容量
	型	decimal
	出現回数	storagepoolの数分(それぞれに対して0または1)
vmpools	説明	VMプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
vmpool	説明	VMプール情報の一式
	型	なし
	出現回数	vmpoolsの数分(それぞれに対して0以上)
cpuFree	説明	CPU空き容量
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
cpuTotal	説明	CPU総容量
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
maxCpuPerf	説明	最大CPU性能
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
maxMemorySize	説明	最大メモリ量
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
memoryFree	説明	メモリ空き容量
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
memoryTotal	説明	メモリ総容量
	型	decimal
	出現回数	vmpoolの数分(それぞれに対して0または1)
name	説明	VMプールのリソース名
	型	string UTF-8
	出現回数	vmpoolの数分(それぞれに対して0または1)
numOfMaxCpu	説明	最大CPU数
	型	int
	出現回数	vmpoolの数分(それぞれに対して0または1)
priority	説明	優先順位
	型	int
	出現回数	vmpoolの数分(それぞれに対して0または1)
vmpoolResourceId	説明	VMプールのリソースID
	型	string ASCII
	出現回数	vmpoolの数分(それぞれに対して0または1)
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第15章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	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>