2.4.5 ListDisk (Gets a List of Existing Disks)

This API gets a list of existing disks.

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 "ListDisk".
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.

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
 <disks>
  <disk>
   <comment>[Existing disk comment]</comment>
   <diskResourceId>[The resource ID of the existing disk]</diskResourceId>
   <label>[Existing disk label]</label>
   <locked>[Flag indicating whether the disk resource is locked for DR]</locked>
   <resourceName>[Existing disk name]</resourceName>
   <size>[The size of the existing disk]</size>
   <status>[The status of the existing disk]</status>
   <storagePool>[The resource name of the storage pool]</storagePool>
  </disk>
 </disks>
 <responseMessage>[Message]</responseMessage>
 <responseStatus>[Status]</responseStatus>
</ListDiskResponse>

Element name	Item	Item description
ListDiskResponse	Description	Element holding the response information.
	Type	None
	Number of occurrences	1
disks	Description	Element holding the response information for the existing disk information.
	Type	None
	Number of occurrences	0 or 1
disk	Description	Set of existing disk information.
	Type	None
	Number of occurrences	As many as there are disks elements (0 or more elements for each disks element).
comment	Description	Existing disk comment.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
diskResourceId	Description	The resource ID of the existing disk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
label	Description	Existing disk label.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
locked	Description	Resource locked status. Flag indicating whether the disk resource is locked for DR. - true: locked - false : unlocked The following limitation applies to locked disk resources: - An error occurs if a locked disk resource is attached using AttachDisk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
resourceName	Description	Existing disk name.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
size	Description	The size of the existing disk. The units are "GB".
	Type	decimal
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
status	Description	The status of the existing disk.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk element).
storagePool	Description	The resource name of the storage pool.
	Type	string
	Number of occurrences	As many as there are disk elements (0 or 1 element for each disk 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"?>
<ListDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com" >
  <disks>
    <disk>
      <comment>comment</comment>
      <diskResourceId>disk-1241</diskResourceId>
      <label>label</label>
      <locked>true</locked>
      <resourceName>small-disk</resourceName>
      <size>31.3</size>
      <status>normal</status>
      <storagePool>/StoragePool</storagePool>
    </disk>
  </disks>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</ListDiskResponse>