ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.2 リファレンスガイド (API編)
FUJITSU Software
第2章 L-Platform APIリファレンス > 2.1 L-Platformテンプレートの操作 > 2.1.5 ListDiskImage (マスターイメージの一覧を取得)
前次

2.1.5 ListDiskImage (マスターイメージの一覧を取得)

仮想データセンター内にあるディスクイメージのIDを取得します。ディスクイメージのコンテンツに対応するProduct IDは、ディスクイメージを登録する際に指定します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。"ListDiskImage"を指定してください。

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"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <diskimages>
    <diskimage>
      <creatorName>[ディスクイメージの作成者のテナント名]</creatorName>
      <diskimageId>[ディスクイメージID]</diskimageId>
      <diskimageName>[ディスクイメージ名]</diskimageName>
      <disks>
        <disk>
          <diskSize>[ディスクサイズ]</diskSize>
          <no>[ディスク連番]</no>
        </disk>
      </disks>
      <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
      <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      <maxMemorySize>[最大メモリ量]</maxMemorySize>
      <maxSysvolSize>[システムディスクの最大容量]</maxSysvolSize>
      <name>[ディスクイメージ情報の名称]</name>
      <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
      <numOfMaxDisk>[最大ディスク数]</numOfMaxDisk>
      <numOfMaxNic>[最大NIC数]</numOfMaxNic>
      <patches>
        <patch>
          <componentName>[コンポーネント名]</componentName>
          <description>[パッチの説明]</description>
          <patchId>[パッチID]</patchId>
          <softwareId>[ソフトウェアID]</softwareId>
        </patch>
      </patches>
      <registrant>[ディスクイメージの登録者のID]</registrant>
      <size>[ディスクイメージのサイズ]</size>
      <softwares>
        <software>
          <category>[ソフトウェア区分]</category>
          <license>[ライセンス]</license>
          <name>[ソフトウェア名称]</name>
          <officialVersion>[正式バージョン]</officialVersion>
          <osCategory>[OS区分]</osCategory>
          <patch>[パッチ版数]</patch>
          <softwareId>[ソフトウェアID]</softwareId>
          <support>[サポート]</support>
          <version>[バージョン]</version>
        </software>
      </softwares>
      <storeType>[格納先種別]</storeType>
      <vdi>[VDI連携の使用の有無]</vdi>
      <vmType>[VM種別]</vmType>
    </diskimage>
  </diskimages>
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</ListDiskImageResponse>

《要素》

要素名

項目

項目説明

ListDiskImageResponse

説明

レスポンスの情報を持つ要素

型

なし

出現回数

1

diskimages

説明

ディスクイメージ情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

diskimage

説明

ディスクイメージ情報の一式

型

なし

出現回数

diskimagesの数分(それぞれに対して0以上)

creatorName

説明

ディスクイメージ作成者のテナント名

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

disks

説明

ディスク情報のレスポンス情報を持つ要素

型

なし

出現回数

diskimageの数分(それぞれに対して0または1)

disk

説明

ディスク情報の一式

型

なし

出現回数

disksの数分(それぞれに対して0以上)

diskSize

説明

ディスクサイズ。単位は"GB"です。

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

no

説明

ディスク連番

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

maxCpuPerf

説明

最大CPU性能

型

decimal

出現回数

diskimageの数分(それぞれに対して0または1)

maxDiskSize

説明

最大ディスク容量

型

decimal

出現回数

diskimageの数分(それぞれに対して0または1)

maxMemorySize

説明

最大メモリ量

型

decimal

出現回数

diskimageの数分(それぞれに対して0または1)

maxSysvolSize

説明

システムディスクの最大容量

型

decimal

出現回数

diskimageの数分(それぞれに対して0または1)

name

説明

ディスクイメージ情報の名称

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

numOfMaxCpu

説明

最大CPU数

型

int

出現回数

diskimageの数分(それぞれに対して0または1)

numOfMaxDisk

説明

最大ディスク数

型

int

出現回数

diskimageの数分(それぞれに対して0または1)

numOfMaxNic

説明

最大NIC数

型

int

出現回数

diskimageの数分(それぞれに対して0または1)

patches

説明

パッチ情報のレスポンス情報を持つ要素

型

なし

出現回数

diskimageの数分(それぞれに対して0または1)

patch

説明

パッチ情報の一式

型

なし

出現回数

patchesの数分(それぞれに対して0以上)

componentName

説明

コンポーネント名

型

string UTF-8

出現回数

patchの数分(それぞれに対して0または1)

description

説明

パッチの説明

型

string UTF-8

出現回数

patchの数分(それぞれに対して0または1)

patchId

説明

パッチID

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

patchの数分(それぞれに対して0または1)

registrant

説明

ディスクイメージの登録者のID

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

size

説明

ディスクイメージのサイズ。単位は"GB"です。

型

decimal

出現回数

diskimageの数分(それぞれに対して0または1)

softwares

説明

ソフトウェア情報のレスポンス情報を持つ要素

型

なし

出現回数

diskimageの数分(それぞれに対して0または1)

software

説明

ソフトウェア情報の一式

型

なし

出現回数

softwaresの数分(それぞれに対して0以上)

category

説明

ソフトウェア区分

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

license

説明

ライセンス

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

name

説明

ソフトウェア名

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

officialVersion

説明

正式バージョン

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

osCategory

説明

OS区分

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

patch

説明

パッチ版数

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

softwareの数分(それぞれに対して0または1)

support

説明

サポート

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

version

説明

バージョン

型

string UTF-8

出現回数

softwareの数分(それぞれに対して0または1)

storeType

説明

格納先種別。以下のどちらかです。
・Virtual Disk：仮想ストレージ
・Raw Disk：既存ディスク

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

vdi

説明

VDI連携を使用するかどうかを指定します。
・true: 使用する
VDI連携を使用しない場合、本タグは表示されません。

型

string ASCII

出現回数

diskimageの数分(それぞれに対して0または1)

vmType

説明

VM種別。
詳細は「リファレンスガイド (コマンド/XML編) CE」の「15.2.2 仮想L-Serverテンプレート」を参照してください。

型

string ASCII

出現回数

diskimageの数分(それぞれに対して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"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <diskimages>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image-13f2b6162a3</diskimageId>
      <diskimageName>g-vm-0002</diskimageName>
      <disks>
        <disk>
          <diskSize>400.0</diskSize>
          <no>3</no>
        </disk>
        <disk>
          <diskSize>500.0</diskSize>
          <no>5</no>
        </disk>
      </disks>
      <maxCpuPerf>1.4</maxCpuPerf>
      <maxDiskSize>500.0</maxDiskSize>
      <maxMemorySize>2.0</maxMemorySize>
      <maxSysvolSize>70.0</maxSysvolSize>
      <name>data_disks</name>
      <numOfMaxCpu>1</numOfMaxCpu>
      <numOfMaxDisk>5</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <registrant>manage1</registrant>
      <size>70.0</size>
      <softwares>
        <software>
          <category>OS</category>
          <license/>
          <name>Windows Server 2008 R2 Enterprise</name>
          <officialVersion/>
          <osCategory>windows64</osCategory>
          <patch/>
          <softwareId>SW00000007</softwareId>
          <support/>
          <version>6.1</version>
        </software>
      </softwares>
      <vmType>VMware</vmType>
    </diskimage>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image-13d23c1c832</diskimageId>
      <diskimageName>g-vm-0001</diskimageName>
      <maxCpuPerf>3.2</maxCpuPerf>
      <maxDiskSize>30.0</maxDiskSize>
      <maxMemorySize>8.0</maxMemorySize>
      <maxSysvolSize>50.0</maxSysvolSize>
      <name>solaristest</name>
      <numOfMaxCpu>4</numOfMaxCpu>
      <numOfMaxDisk>1</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <patches>
        <patch>
          <componentName/>
          <description/>
          <patchId>PATCH1</patchId>
          <softwareId>SW00000016</softwareId>
        </patch>
        <patch>
          <componentName/>
          <description/>
          <patchId>PATCH2</patchId>
          <softwareId>SW00000016</softwareId>
        </patch>
      </patches>
      <registrant>manage1</registrant>
      <size>50.0</size>
      <softwares>
        <software>
          <category>OS</category>
          <license/>
          <name>FreeOS</name>
          <officialVersion/>
          <osCategory>other</osCategory>
          <patch/>
          <softwareId>SW00000016</softwareId>
          <support/>
          <version>1.0</version>
        </software>
      </softwares>
      <vmType>VMware</vmType>
    </diskimage>
  </diskimages>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</ListDiskImageResponse>

前次
Copyright 2011-2015 FUJITSU LIMITED