2.3.13 GetLServerAttributes (Gets the Attributes of a Server)

This API gets attribute information for a server.

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 "GetLServerAttributes".
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.
lserverId	Description	Server 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"?>
<GetLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lserver>
    <creator>[Tenant name of the person who created the virtual machine]</creator>
    <diskimageId>[Disk image ID]</diskimageId>
    <diskimageName>[Disk image name]</diskimageName>
    <hostName>[Host name of server]</hostName>
    <resource>
      <name>[L-Server name]</name>
    </resource>
    <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>
        <size>[Size of the additional disk]</size>
        <diskId>[ID of the additional disk]</diskId>
        <diskName>[Name of the additional disk]</diskName>
        <resourceName>[Name of the Existing disk]</resourceName>
      </disk>
    </disks>
    <lserverId>[Server ID]</lserverId>
    <lserverName>[Server name]</lserverName>
    <serverType>[Server type]</serverType>
  </lserver>
</GetLServerAttributesResponse>

Element name	Item	Item description
GetLServerAttributesResponse	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
lserver	Description	Set of server information.
	Type	None
	Number of occurrences	0 or 1
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).
hostName	Description	The host name of the 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).
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 server.
	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	The name of the existing disk. This element will be displayed for existing disks only.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk 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"?>
<GetLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserver>
    <creator>papi</creator>
    <diskimageId>image-141cafdcb24</diskimageId>
    <diskimageName>RHEL62X8664</diskimageName>
    <hostName>VTAFRIXZ530001</hostName>
    <resource>
      <name>papi-TAFRIXZ53-S-0001</name>
    </resource>
    <disks>
      <disk>
        <attachedTo>papi-TAFRIXZ53-S-0001</attachedTo>
        <creator>papi</creator>
        <size>0.2</size>
        <diskId>papi-TAFRIXZ53-D-0001</diskId>
        <diskName>DISK0</diskName>
      </disk>
    </disks>
    <lserverId>papi-TAFRIXZ53-S-0001</lserverId>
    <lserverName>PRE_IMG</lserverName>
    <serverType>sample_medium</serverType>
  </lserver>
</GetLServerAttributesResponse>