2.1.3 GetPoolList (Gets a List of Resource Pools)

This API gets a list of resource pools.

Request parameters

Parameter name	Item	Item description
Version	Description	The version ID of the L-Platform API
	Type	string
	Value	Fixed. Specify "2.0".
Locale	Description	The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.
	Type	string
	Value	Select one of the following: - en: English - zh: Chinese
Action	Description	The name of the L-Platform API to be executed
	Type	string
	Value	Fixed. Specify "GetPoolList".
userId	Description	The user ID of the user that executes the L-Platform API
	Type	string
	Value	No more than 31 characters
orgId	Description	The tenant name of the user that executes the L-Platform API
	Type	string
	Value	No more than 32 characters
[type]	Description	Resource pool type. If this element is omitted, the API will return a list of all resource pools, regardless of their type.
	Type	string
	Value	Select one of the following values: - vm: VM pool - storage: Storage pool - mac: MAC address set - server: Server pool - image: Image pool

Response

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <resourcepools>
    <imagepools>
      <imagepool>
        <imagepoolResourceId>[The resource ID of the image pool]</imagepoolResourceId>
        <name>[The resource name of the image pool]</name>
        <num>[Number of images]</num>
        <priority>[Priority order]</priority>
      </imagepool>
    </imagepools>
    <macaddresses>
      <macaddress>
        <free>[Number of vacant MAC addresses]</free>
        <macaddresspoolResourceId>[The resource ID of the MAC address set]</macaddresspoolResourceId>
        <name>[The resource name of the MAC address set]</name>
        <total>[Total number of MAC addresses]</total>
      </macaddress>
    </macaddresses>
    <serverpools>
      <serverpool>
        <free>[Total number of unused physical servers]</free>
        <name>[The resource name of the server pool]</name>
        <serverpoolResourceId>[The resource ID of the server pool]</serverpoolResourceId>
        <total>[Total number of physical servers]</total>
      </serverpool>
    </serverpools>
    <storagepools>
      <storagepool>
        <free>[Amount of free storage]</free>
        <maxDiskSize>[Maximum amount of disk space]</maxDiskSize>
        <name>[The resource name of the storage pool]</name>
        <priority>[Priority order]</priority>
        <storagepoolResourceId>[The resource ID of the storage pool]</storagepoolResourceId>
        <total>[Total amount of storage]</total>
      </storagepool>
    </storagepools>
    <vmpools>
      <vmpool>
        <cpuFree>[Free CPU capacity]</cpuFree>
        <cpuTotal>[Total CPU capacity]</cpuTotal>
        <maxCpuPerf>[Maximum CPU performance]</maxCpuPerf>
        <maxMemorySize>[Maximum amount of memory]</maxMemorySize>
        <memoryFree>[Amount of free memory]</memoryFree>
        <memoryTotal>[Total amount of memory]</memoryTotal>
        <name>[The resource name of the VM pool]</name>
        <numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu>
        <priority>[Priority order]</priority>
        <vmpoolResourceId>[The resource ID of the VM pool]</vmpoolResourceId>
      </vmpool>
    </vmpools>
  </resourcepools>
</GetPoolListResponse>

Element name	Item	Item description
GetPoolListResponse	Description	Element holding the response information
	Type	None
	Number of occurrences	1
resourcepools	Description	Element holding the response information for the resource pool information.
	Type	None
	Number of occurrences	1
imagepools	Description	Element holding the response information for the image pool information.
	Type	None
	Number of occurrences	0 or 1
imagepool	Description	Set of image pool information
	Type	None
	Number of occurrences	As many as there are imagepools elements (0 or more elements for each imagepools element).
imagepoolResourceId	Description	The resource ID of the image pool
	Type	string
	Number of occurrences	As many as there are imagepool elements (0 or 1 element for each imagepool element).
name	Description	The resource name of the image pool
	Type	string
	Number of occurrences	As many as there are imagepool elements (0 or 1 element for each imagepool element).
num	Description	Number of images
	Type	int
	Number of occurrences	As many as there are imagepool elements (0 or 1 element for each imagepool element).
priority	Description	Priority order
	Type	int
	Number of occurrences	As many as there are imagepool elements (0 or 1 element for each i imagepool element).
macaddresses	Description	Element holding the response information for the MAC address information.
	Type	None
	Number of occurrences	0 or 1
macaddress	Description	Set of MAC address information
	Type	None
	Number of occurrences	As many as there are macaddresses elements (0 or more elements for each macaddresses element).
free	Description	Number of vacant MAC addresses
	Type	int
	Number of occurrences	As many as there are macaddress elements (0 or 1 element for each macaddress element).
macaddresspoolResourceId	Description	The resource ID of the MAC address set
	Type	string
	Number of occurrences	As many as there are macaddress elements (0 or 1 element for each macaddress element).
name	Description	The resource name of the MAC address set
	Type	string
	Number of occurrences	As many as there are macaddress elements (0 or 1 element for each macaddress element).
total	Description	Total number of MAC addresses
	Type	int
	Number of occurrences	As many as there are macaddress elements (0 or 1 element for each macaddress element).
serverpools	Description	Element holding the response information for the server pool information
	Type	None
	Number of occurrences	0 or 1
serverpool	Description	Set of server pool information
	Type	None
	Number of occurrences	As many as there are serverpools elements (0 or more elements for each serverpools element).
free	Description	Total number of unused physical servers
	Type	int
	Number of occurrences	As many as there are serverpool elements (0 or 1 element for each serverpool element).
name	Description	The resource name of the server pool
	Type	string
	Number of occurrences	As many as there are serverpool elements (0 or 1 element for each serverpool element).
serverpoolResourceId	Description	The resource ID of the server pool
	Type	string
	Number of occurrences	As many as there are serverpool elements (0 or 1 element for each serverpool element).
total	Description	Total number of physical servers
	Type	int
	Number of occurrences	As many as there are serverpool elements (0 or 1 element for each serverpool element).
storagepools	Description	Element holding the response information for the storage pool information
	Type	None
	Number of occurrences	0 or 1
storagepool	Description	Set of storage pool information
	Type	None
	Number of occurrences	As many as there are storagepools elements (0 or more elements for each storagepools element).
free	Description	Amount of free storage
	Type	decimal
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
maxDiskSize	Description	Maximum amount of disk space
	Type	decimal
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
name	Description	The resource name of the storage pool
	Type	string
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
priority	Description	Priority order
	Type	int
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
storagepoolResrouceId	Description	The resource ID of the storage pool
	Type	string
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
total	Description	Total amount of storage
	Type	decimal
	Number of occurrences	As many as there are storagepool elements (0 or 1 element for each storagepool element).
vmpools	Description	Element holding the response information for the VM pool information
	Type	None
	Number of occurrences	0 or 1
vmpool	Description	Set of VM pool information
	Type	None
	Number of occurrences	As many as there are vmpools elements (0 or more elements for each vmpools element).
cpuFree	Description	Free CPU capacity
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
cpuTotal	Description	Total CPU capacity
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
maxCpuPerf	Description	Maximum CPU performance
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
maxMemorySize	Description	Maximum amount of memory
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
memoryFree	Description	Amount of free memory
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
memoryTotal	Description	Total amount of memory
	Type	decimal
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
name	Description	The resource name of the VM pool
	Type	string
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
numOfMaxCpu	Description	Maximum number of CPUs
	Type	int
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
priority	Description	Priority order
	Type	int
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
vmpoolResourceId	Description	The resource ID of the VM pool
	Type	string
	Number of occurrences	As many as there are vmpool elements (0 or 1 element for each vmpool element).
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details.
	Type	string
	Number of occurrences	1
responseStatus	Description	Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.
	Type	string
	Number of occurrences	1

Sample response

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