2.3.18 ListLServer (Gets a List of Servers in an L-Platform)

This API gets a list of server IDs within an L-Platform.

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 "ListLServer".
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.
lplatformId	Description	L-Platform ID.
	Type	string
	Value	No more than 32 characters.

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lservers>
    <lserver>
      <creator>[Tenant name of the person who created the server]</creator>
      <diskimageId>[Disk image ID]</diskimageId>
      <diskimageName>[Disk image name]</diskimageName>
      <lserverType>[Server type]</lserverType>
      <resource>
        <name>[L-Server name]</name>
      </resource>
      <snapshotExist>[Flag to indicate whether a snapshot is on the server]</snapshotExist>
      <disks>
        <disk>
          <attachedTo>[ID of the virtual machine to which the additional disk has been attached]</attachedTo>
          <creator>[Tenant name of the person who created the additional disk]</creator>
          <resourceName>[Name of the Existing disk]</resourceName>
          <size>[Size of the additional disk]</size>
          <diskId>[ID of the additional disk]</diskId>
          <diskName>[Name of the additional disk]</diskName>
        </disk>
      </disks>
      <containerPoolManaged>[Flag to indicate whether it is managed by this product]</containerPoolManaged>
      <lserverId>[Server ID]</lserverId>
      <lserverName>[Server name]</lserverName>
      <serverType>[Server type]</serverType> 
    </lserver>
  </lservers>
</ListLServerResponse>

Element name	Item	Item description
ListLServerResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
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
lservers	Description	Element holding the response information for the server information.
	Type	None
	Number of occurrences	0 or 1
lserver	Description	Set of server information.
	Type	None
	Number of occurrences	As many as there are lservers elements (0 or more elements for each lservers element).
creator	Description	The tenant name of the person who created the server.
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
diskimageId	Description	Disk image ID.
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
diskimageName	Description	Disk image name.
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
lserverType	Description	Server type. One of the following: - Physical: Physical server. - Virtual: Virtual server.
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
resource	Description	Set of information displayed in the [Resources] tab.
	Type	None
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
name	Description	L-Server name
	Type	string
	Number of occurrences	As many as there are resource elements (0 or 1 element for each resource element).
snapshotExist	Description	Flag indicating whether a snapshot exists on the server. This is one of the following: - true: Snapshot exists - false: Snapshot does not exist
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
disks	Description	Element holding the response information for the additional disk information.
	Type	None
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
disk	Description	Set of additional disk information.
	Type	None
	Number of occurrences	As many as there are disks elements (0 or more elements for each disks element).
attachedTo	Description	The ID of the virtual machine to which the additional disk has been attached.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
creator	Description	The tenant name of the person who created the additional disk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
size	Description	The size of the additional disk. Specify this value in GB.
	Type	decimal
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
diskId	Description	The ID of the additional disk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
diskName	Description	The name of the additional disk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
resourceName	Description	Name of the Existing disk
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
containerPoolManaged	Description	Flag indicating whether the container resource pool where the server operates is managed by this product. This is one of the following: - true: Managed - false: Not managed
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
lserverId	Description	Server ID
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
lserverName	Description	Server name
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).
serverType	Description	Server type
	Type	string
	Number of occurrences	As many as there are lserver elements (0 or 1 element for each lserver element).

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lservers>
    <lserver>
      <creator>tenantD</creator>
      <diskimageId>image-13f2b6162a3</diskimageId>
      <diskimageName>g-vm-0002</diskimageName>
      <lserverType>Virtual</lserverType>
      <resource>
        <name>tenantD-HY43YHSWA-S-0001</name>
      </resource>
      <snapshotExist>false</snapshotExist>
      <disks>
        <disk>
          <attachedTo>tenantD-HY43YHSWA-S-0001</attachedTo>
          <creator>tenantD</creator>
          <size>400.0</size>
          <diskId>tenantD-HY43YHSWA-D-0001</diskId>
          <diskName>DISK0</diskName>
        </disk>
        <disk>
          <attachedTo>tenantD-HY43YHSWA-S-0001</attachedTo>
          <creator>tenantD</creator>
          <size>500.0</size>
          <diskId>tenantD-HY43YHSWA-D-0002</diskId>
          <diskName>DISK1</diskName>
        </disk>
      </disks>
      <lserverId>tenantD-HY43YHSWA-S-0001</lserverId>
      <lserverName>AP1</lserverName>
      <serverType>over_commit</serverType>
    </lserver>
    <lserver>
      <creator>tenantD</creator>
      <diskimageId>image-13bb0a794a0</diskimageId>
      <diskimageName>g-vm-0001</diskimageName>
      <lserverType>Virtual</lserverType>
      <resource>
        <name>tenantD-HY43YHSWA-S-0002</name>
      </resource>
      <snapshotExist>false</snapshotExist>
      <disks/>
      <lserverId>tenantD-HY43YHSWA-S-0002</lserverId>
      <lserverName>AP2</lserverName>
      <serverType>over_commit_large</serverType>
    </lserver>
    <lserver>
      <creator>tenantD</creator>
      <diskimageId>image-142128952ad</diskimageId>
      <diskimageName>g-physical-0002</diskimageName>
      <lserverType>Physical</lserverType>
      <resource>
        <name>tenantD-HY43YHSWA-S-0003</name>
      </resource>
      <snapshotExist>false</snapshotExist>
      <disks/>
      <lserverId>tenantD-HY43YHSWA-S-0003</lserverId>
      <lserverName>Physical-more-nic</lserverName>
      <serverType>Middle_Spec</serverType>
    </lserver>
  </lservers>
</ListLServerResponse>