Systemwalker Software Configuration Manager V14g リファレンスガイド API編

4.5.6 GetPoolList

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

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	CFMG APIのバージョンID
	型	string ASCII
	設定内容	固定。「1.0」を指定してください。
Locale	説明	CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。 ・「ja」: 日本語 ・「en」: 英語
Action	説明	実行するCFMG APIの名称
	型	string ASCII
	設定内容	固定。「GetPoolList」を指定してください。
userId	説明	CFMG APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	CFMG APIを実行するユーザーの組織ID
	型	string ASCII
	設定内容	8文字以内
[type]	説明	リソースプールの種別。省略時はすべての種別のリソースプールを取得します。
	型	string ASCII
	設定内容	以下から選択します。 ・「vm」: VMプール ・「storage」: ストレージプール ・「mac」:MACアドレスセット

レスポンス

《ステータスコード》

正常に終了した場合に「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>
        <priority>[優先順位]</priolity>
        <cpuTotal>[CPU総容量]</cpuTotal>
        <cpuFree>[CPU空き容量]</cpuFree>
        <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
        <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
        <memoryTotal>[メモリ総容量]</memoryTotal>
        <memoryFree>[メモリ空き容量]</memoryFree>
        <maxMemorySize>[最大メモリ量]</maxMemorySize>
      </vmpool>
    </vmpools>
    <storagepools>
      <storagepool>
        <name>[ストレージプールのリソース名]</name>
        <priority>[優先順位]</priolity>
        <total>[ストレージ総容量]</total>
        <free>[ストレージ空き容量]</free>
        <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      </storagepool>
    </storagepools>
    <macaddresses>
      <macaddress>
        <name>[MACアドレスセットのリソース名]</name>
        <total>[MACアドレス総数]</total>
        <free>[空きMACアドレス数]</free>
      </macaddress>
    </macaddresses>
  </resourcepools>
</DetachVDiskResponse>

《要素》

要素名	項目	項目説明
GetPoolListResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 エラーコードの詳細については、「付録B レスポンスステータス・エラーコード一覧」を参照してください。
	型	string ASCII
	出現回数	1
resourcepools	説明	リソースプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	1
vmpools	説明	VMプール情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
vmpool	説明	VMプール情報の一式
	型	なし
	出現回数	0以上
name	説明	VMプールのリソース名
	型	string UTF-8
	出現回数	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)
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)
total	説明	MACアドレス総数
	型	int
	出現回数	macaddressの数分(それぞれに対して0または1)
free	説明	空きMACアドレス数
	型	int
	出現回数	macaddressの数分(それぞれに対して0または1)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <resourcepools>
    <macaddresses />
    <storagepools>
      <storagepool>
        <free>584.4</free>
        <maxDiskSize>298.9</maxDiskSize>
        <name>/StoragePool</name>
        <priority>5</priority>
        <total>1199.4</total>
      </storagepool>
    </storagepools>
    <vmpools>
      <vmpool>
        <cpuFree>36.8</cpuFree>
        <cpuTotal>46.8</cpuTotal>
        <maxCpuPerf>2.4</maxCpuPerf>
        <maxMemorySize>61.6</maxMemorySize>
        <memoryFree>121.2</memoryFree>
        <memoryTotal>131.2</memoryTotal>
        <name>/VMPool</name>
        <numOfMaxCpu>8</numOfMaxCpu>
        <priority>5</priority>
      </vmpool>
      <vmpool>
        <cpuFree>12.2</cpuFree>
        <cpuTotal>46.8</cpuTotal>
        <maxCpuPerf>1.1</maxCpuPerf>
        <maxMemorySize>55.6</maxMemorySize>
        <memoryFree>107.1</memoryFree>
        <memoryTotal>131.1</memoryTotal>
        <name>/test_resource/TEST_VMPool</name>
        <numOfMaxCpu>8</numOfMaxCpu>
        <priority>5</priority>
      </vmpool>
    </vmpools>
  </resourcepools>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</GetPoolListResponse>