2.3.8 DestroyLServer (Deletes Server)

This API removes a server.

This API is executed asynchronously. After the API is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed. When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

It cannot be used in the following cases:

The target server is a server for which modification configurations or deletion cannot be performed.
For the servers for which configuration modification and deletion cannot be performed, refer to "8.3.18 L-Platform Reconfiguration" in the "User's Guide for Tenant Administrators CE".

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 "DestroyLServer".
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.
[force]	Description	Flag indicating whether servers that are distribution targets for the server load balancer will be forcibly deleted.
	Type	string
	Value	Specify one of the following: - true: Forcibly deletes - false: Does not forcibly delete If omitted, "false" will be used.

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<DestroyLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
</DestroyLServerResponse>

Element name	Item	Item description
DestroyLServerResponse	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

Sample response

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