2.3.19 ListSnapshot (Gets a List of Snapshots)

This API gets a list of snapshots.

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 "ListSnapshot".
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	The ID of the server for which a list of snapshots is to be obtained
	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"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <snapshots>
    <snapshot>
      <comment>[Snapshot comment]</comment>
      <snapshotId>[Snapshot ID]</snapshotId>
      <snapshotTime>[Date and time when a snapshot was created]</snapshotTime>
    </snapshot>
  </snapshots>
</ListSnapshotResponse>

Element name	Item	Item description
ListSnapshotResponse	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
snapshots	Description	Element holding the response information for the snapshot information
	Type	None
	Number of occurrences	0 or 1
snapshot	Description	Set of snapshot information
	Type	None
	Number of occurrences	As many as there are snapshots elements (0 or more elements for each snapshots element).
comment	Description	A comment for the snapshot
	Type	string
	Number of occurrences	As many as there are snapshot elements (0 or 1 element for each snapshot element).
snapshotId	Description	Snapshot ID
	Type	string
	Number of occurrences	As many as there are snapshot elements (0 or 1 element for each snapshot element).
snapshotTime	Description	Date and time when a snapshot was created
	Type	string
	Number of occurrences	As many as there are snapshot elements (0 or 1 element for each snapshot element).

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <snapshots>
    <snapshot>
      <comment>Comment</comment>
      <snapshotId>image000001</snapshotId>
      <snapshotTime>Nov 12, 2010 10:00:11 AM</snapshotTime>
    </snapshot>
    <snapshot>
      <comment>Comment</comment>
      <snapshotId>image000002</snapshotId>
      <snapshotTime> Nov 12, 2010 10:00:11 AM</snapshotTime>
    </snapshot>
  </snapshots>
</ListSnapshotResponse>