2.3.16 GetLServerStatus (Gets the Status of a Server)

This API gets status 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 "GetLServerStatus".
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"?>
<GetLServerStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lserverStatus>[Server status]</lserverStatus>
</GetLServerStatusResponse>

Element name	Item	Item description
GetLServerStatusResponse	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
lserverStatus	Description	Server status. One of the following values: - DEPLOYING: The server is being deployed. - RUNNING: The server is running. - STOPPING: The server is stopping. - STOPPED: The server is stopped. - STARTING: The server is starting. - RESTORING: The server is being restored. - BACKUP_ING: The servere is being backed up. - ERROR: An error has occurred on the server. - START_ERROR: An error has occurred when the server is starting. - STOP_ERROR: An error has occurred when the server is stopping. - CLONING: The image is collecting.
	Type	string
	Number of occurrences	0 or 1

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<GetLServerStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserverStatus>RUNNING</lserverStatus>
</GetLServerStatusResponse>