既存ディスクの一覧を取得します。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
Version | 説明 | L-Platform APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。"2.0"を指定してください。 | |
Locale | 説明 | L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 | |
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"> <responseMessage>[メッセージ]</responseMessage> <responseStatus>[ステータス]</responseStatus> <disks> <disk> <resourceName>[既存ディスク名]</resourceName> <diskResourceId>[既存ディスクのリソースID]</diskResourceId> <label>[既存ディスクラベル]</label> <comment>[既存ディスクのコメント]</comment> <diskSize>[既存ディスクサイズ]</diskSize> <storagePool>[ストレージプールのリソース名]</storagePool> <preCreated>[事前切り出し属性]</preCreated> <status>[既存ディスクのステータス]</status> </disk> </disks> </ListDiskResponse>
《要素》
要素名 | 項目 | 項目説明 |
|---|---|---|
ListDiskResponse | 説明 | レスポンスの情報を持つ要素 |
型 | なし | |
出現回数 | 1 | |
responseMessage | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | string ASCII | |
出現回数 | 1 | |
disks | 説明 | 既存ディスク情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | 0または1 | |
disk | 説明 | 既存ディスク情報の一式 |
型 | なし | |
出現回数 | 0以上 | |
resourceName | 説明 | 既存ディスク名 |
型 | string UTF-8 | |
出現回数 | diskの数分(それぞれに対して0または1) | |
diskResourceId | 説明 | 既存ディスクのリソースID |
型 | string ASCII | |
出現回数 | diskの数分(それぞれに対して0または1) | |
label | 説明 | 既存ディスクラベル |
型 | string UTF-8 | |
出現回数 | diskの数分(それぞれに対して0または1) | |
comment | 説明 | 既存ディスクのコメント |
型 | string UTF-8 | |
出現回数 | diskの数分(それぞれに対して0または1) | |
diskSize | 説明 | 既存ディスクサイズ。"GB"単位で指定します。 |
型 | decimal | |
出現回数 | diskの数分(それぞれに対して0または1) | |
storagePool | 説明 | ストレージプールのリソース名 |
型 | string UTF-8 | |
出現回数 | diskの数分(それぞれに対して0または1) | |
preCreated | 説明 | 事前切り出し属性 |
型 | string ASCII | |
出現回数 | diskの数分(それぞれに対して0または1) | |
status | 説明 | 既存ディスクのステータス |
型 | string ASCII | |
出現回数 | diskの数分(それぞれに対して0または1) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?> <ListDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> <disks> <disk> <name>small-disk</name> <diskResourceId>disk-1241</diskResourceId> <label>disk-0001</label> <comment>comment</comment> <size>30.0</size> <storagePool>/StoragePool</storagePool> <status>normal</status> </disk> </disks> </ListDiskResponse>
