2.1.7 ListLPlatformDescriptor (Gets a List of Templates)

This API gets a list of the templates in the virtual data center.
At the same time, the API also gets attribute information for templates.

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 "ListLPlatformDescriptor".
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
[keyword]	Description	Keyword for filtering which templates to display in the list. If this parameter is specified, only those templates that include the specified keyword will be included in the response.
	Type	string
	Value	No more than 85 characters

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>[Tenant name of the person who created the L-Platform template]</creatorName>
      <description>[Description of the L-Platform template]</description>
      <registrant>[ID of the person who registered the L-Platform template]</registrant>
      <lplatformdescriptorId>[L-Platform template ID]</lplatformdescriptorId>
      <lplatformdescriptorName>[L-Platform template name]</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

Element name	Item	Item description
ListLPlatformDescriptorResponse	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
lplatformdescriptors	Description	Element holding the response information for the L-Platform template list
	Type	None
	Number of occurrences	0 or 1
lplatformdescriptor	Description	Set of L-Platform template information
	Type	None
	Number of occurrences	As many as there are lplatformdescriptors elements (0 or more elements for each lplatformdescriptors element).
creatorName	Description	The tenant name of the person who created the L-Platform template.
	Type	string
	Number of occurrences	As many as there are lplatformdescriptor elements (0 or 1 element for each lplatformdescriptor element).
description	Description	Description of the L-Platform template
	Type	string
	Number of occurrences	As many as there are lplatformdescriptor elements (0 or 1 element for each lplatformdescriptor element).
registrant	Description	The ID of the person who registered the L-Platform template.
	Type	string
	Number of occurrences	As many as there are lplatformdescriptor elements (0 or 1 element for each lplatformdescriptor element).
lplatformdescriptorId	Description	L-Platform template ID
	Type	string
	Number of occurrences	As many as there are lplatformdescriptor elements (0 or 1 element for each lplatformdescriptor element).
lplatformdescriptorName	Description	L-Platform template name
	Type	string
	Number of occurrences	As many as there are lplatformdescriptor elements (0 or 1 element for each lplatformdescriptor element).

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_GL</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826</lplatformdescriptorName>
    </lplatformdescriptor>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_net</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826_net</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>