2.3.17 GetSnapshotHistory (Gets a History of Snapshots and Restorations)

This API gets a history of snapshots and restorations.

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 "GetSnapshotHistory".
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 history of snapshots and restorations 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"?>
<GetSnapshotHistoryResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <histories>
    <history>
      <action>[Action performed]</action>
      <endTime>[The time when the snapshot or restoration completed]</endTime>
      <progress>[Progress of the snapshot or restoration]</progress>
      <snapshotId>[Snapshot ID]</snapshotId>
      <startTime>[The time when the snapshot or restoration started]</startTime> 
      <status>[Status of the snapshot or restoration]</status>
    </history>
  </histories>
</GetSnapshotHistoryResponse>

Element name	Item	Item description
GetSnapshotHistoryResponse	Description	Element holding the response information
	Type	None
	Number of occurrences	1
histories	Description	Element holding the response information for the snapshot information
	Type	None
	Number of occurrences	0 or 1
history	Description	Set of snapshot information
	Type	None
	Number of occurrences	As many as there are histories elements (0 or more elements for each histories element).
action	Description	Action performed. One of the following values: - SNAPSHOT: Created a snapshot - RESTORE: Restored to a snapshot - CLONING: Collect the cloning image - REMOVE: Deleted a snapshot - EVENT_REMOVE: Automatically deleted a snapshot
	Type	string
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
endTime	Description	The time when the snapshot or restoration completed
	Type	string
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
progress	Description	Progress of the snapshot or restoration. This is a value between 0 and 100.
	Type	int
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
snapshotId	Description	Snapshot ID
	Type	string
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
startTime	Description	The time when the snapshot or restoration started.
	Type	string
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
status	Description	Status of the snapshot or restoration. One of the following values: - waiting: The snapshot or restoration is in a waiting state - running: The snapshot or restoration is executing - completed: The snapshot or restoration has completed - error: An error has occurred with the snapshot or restoration
	Type	string
	Number of occurrences	As many as there are history elements (0 or 1 element for each history element).
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"?>
<GetSnapshotHistoryResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <histories>
    <history>
      <action>SNAPSHOT</action>
      <endTime>2013/10/19 19:47:09</endTime>
      <progress>100</progress>
      <snapshotId>rorv3-66_1752</snapshotId>
      <startTime>2013/10/19 19:46:32</startTime>
      <status>completed</status>
    </history>
    <history>
      <action>RESTORE</action>
      <endTime>2013/10/19 19:48:14</endTime>
      <progress>100</progress>
      <snapshotId>rorv3-66_1752</snapshotId>
      <startTime>2013/10/19 19:47:38</startTime>
      <status>completed</status>
    </history>
  </histories>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</GetSnapshotHistoryResponse>