2.3.4 CreateImage (Collects the Cloning Image of a Server)

This API collects the cloning image of 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 "CreateImage".
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
name	Description	The image name to be given to the image to be created
	Type	string
	Value	No more than 32 characters
imagePool	Description	The resource ID of the image pool
	Type	string
	Value	No more than 32 characters
comment	Description	Comment
	Type	string
	Value	No more than 128 characters
[allDisk]	Description	Specify whether to collect the cloning master together with the expanded disk
	Type	string
	Value	One of the following values: - true: Collect the cloning master together with the expanded disk - false: Do not collect the cloning master together with the expanded disk If this parameter is omitted, the default value is the "false". This can be specified with VMware or Hyper-V servers. With VMware servers, if images are collected with "false" specified, the actual collected image will be an image including expanded disks. However, the image information registered after image collection will be image information that does not include expanded disks, so if this image information is used to deploy a server, it is deployed to a system disk.

Response

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

<XML>

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

Element name	Item	Item description
CreateImageResponse	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"?>
<CreateImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CreateImageResponse>