2.4.5 ListDisk (既存ディスクの一覧を取得)

既存ディスクの一覧を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	L-Platform APIのバージョンID
	型	string ASCII
	設定内容	固定。"2.0"を指定してください。
Locale	説明	L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。・"ja": 日本語・"en": 英語
Action	説明	実行するL-Platform APIの名称
	型	string ASCII
	設定内容	固定。"ListDisk"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内

レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
 <disks>
  <disk>
   <comment>[既存ディスクのコメント]</comment>
   <diskResourceId>[既存ディスクのリソースID]</diskResourceId>
   <label>[既存ディスクラベル]</label>
   <locked>[ディスクリソースが凍結されているかどうかを示すフラグ]</locked>
   <resourceName>[既存ディスク名]</resourceName>
   <size>[既存ディスクサイズ]</size>
   <status>[既存ディスクのステータス]</status>
   <storagePool>[ストレージプールのリソース名]</storagePool>
  </disk>
 </disks>
 <responseMessage>[メッセージ]</responseMessage>
 <responseStatus>[ステータス]</responseStatus>
</ListDiskResponse>

《要素》

要素名	項目	項目説明
ListDiskResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
disks	説明	既存ディスク情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
disk	説明	既存ディスク情報の一式
	型	なし
	出現回数	disksの数分(それぞれに対して0以上)
comment	説明	既存ディスクのコメント
	型	string UTF-8
	出現回数	diskの数分(それぞれに対して0または1)
diskResourceId	説明	既存ディスクのリソースID
	型	string ASCII
	出現回数	diskの数分(それぞれに対して0または1)
label	説明	既存ディスクラベル
	型	string UTF-8
	出現回数	diskの数分(それぞれに対して0または1)
locked	説明	リソース凍結状態。DRでディスクリソースが凍結されているかどうかを示すフラグ。以下のどちらかです。・true : 凍結されている・false : 凍結されていない凍結されているディスクリソースについては、以下の制限があります。・AttachDisk実行時に、凍結されたディスクリソースをアタッチしようとするとエラーとなります。
	型	string ASCII
	出現回数	diskの数分(それぞれに対して0または1)
resourceName	説明	既存ディスク名
	型	string UTF-8
	出現回数	diskの数分(それぞれに対して0または1)
size	説明	既存ディスクサイズ。"GB"単位で指定します。
	型	decimal
	出現回数	diskの数分(それぞれに対して0または1)
status	説明	既存ディスクのステータス
	型	string ASCII
	出現回数	diskの数分(それぞれに対して0または1)
storagePool	説明	ストレージプールのリソース名
	型	string UTF-8
	出現回数	diskの数分(それぞれに対して0または1)
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第15章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1

サンプルレスポンス

<?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>