ページの先頭行へ戻る
Systemwalker Software Configuration Manager V14g リファレンスガイド
Systemwalker
第7章 CFMG API > 7.3 CFMG APIリファレンス > 7.3.1 システムテンプレートの操作
前次

7.3.1 システムテンプレートの操作

システムテンプレートの操作に関連するCFMG APIについて説明します。

7.3.1.1 ListVSYSDescriptor

仮想データセンター内のシステムテンプレート一覧を取得します。

同時にシステムテンプレートの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「ListVSYSDescriptor」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内

[keyword]

説明

一覧に表示するテンプレートを絞り込むためのキーワード。指定した場合は、同じキーワードを含むシステムテンプレートだけがレスポンスに含まれます。

型

string UTF-8

設定内容

85文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysdescriptors>
    <vsysdescriptor>
      <creatorName>[システムテンプレート作成者の組織ID]</creatorName>
      <description>[システムテンプレートの説明]</description>
      <registrant>[システムテンプレート登録者のID]</registrant>
      <vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
      <vsysdescriptorName>[システムテンプレート名]</vsysdescriptorName>
    </vsysdescriptor>
  </vsysdescriptors>
</ListVSYSDescriptorResponse>

《要素》

要素名

項目

項目説明

ListVSYSDescriptorResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

vsysdescriptors

説明

システムテンプレート一覧のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vsysdescriptor

説明

システムテンプレート情報の一式

型

なし

出現回数

0以上

creatorName

説明

システムテンプレート作成者の組織ID

型

string ASCII

出現回数

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

description

説明

システムテンプレートの説明

型

string UTF-8

出現回数

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

registrant

説明

システムテンプレート登録者のID

型

string ASCII

出現回数

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

vsysdescriptorId

説明

システムテンプレートID

型

string ASCII

出現回数

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

vsysdescriptorName

説明

システムテンプレート名

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysdescriptors>
    <vsysdescriptor>
      <creatorName>adminorg</creatorName>
      <description>テスト用のテンプレート</description>
      <registrant>adminorg</registrant>
      <vsysdescriptorId>template-0001</vsysdescriptorId>
      <vsysdescriptorName>テストテンプレート</vsysdescriptorName>
    </vsysdescriptor>
  </vsysdescriptors>
</ListVSYSDescriptorResponse>

7.3.1.2 ListDiskImage

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

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <diskimages>
    <diskimage>
      <creatorName>[ディスクイメージの作成者の組織ID]</creatorName>
      <diskimageId>[ディスクイメージID]</diskimageId>
      <diskimageName>[ディスクイメージ名]</diskimageName>
      <registrant>[ディスクイメージの登録者のID]</registrant>
      <size>[ディスクイメージのサイズ]</size>
      <numOfNIC>[NIC数]</numOfNIC>
      <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
      <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
      <maxMemorySize>[最大メモリ量]</maxMemorySize>
      <numOfMaxDisk>[最大ディスク数]</numOfMaxDisk>
      <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      <numOfMaxNic>[最大NIC数]</numOfMaxNic>
      <softwares>
        <software>
          <license>[ライセンス]</license>
          <name>[ソフトウェア名称]</name>
          <softwareId>[ソフトウェアID]</softwareId>
          <category>[ソフトウェア区分]</category>
          <osCategory>[OS区分]</osCategory>
          <version>[バージョン]</version>
          <officialVersion>[正式バージョン]</officialVersion>
          <patch>[パッチ版数]</patch>
          <support>[サポート]</support>
        </software>
      </softwares>
      <patches>
        <patch>
          <softwareId>[ソフトウェアID]</softwareId>
          <patchId>[パッチID]</patchId>
          <componentName>[コンポーネント名]</componentName>
          <description>[パッチの説明]</description>
        </patch>
      </patches>
    </diskimage>
  </diskimages>
</ListDiskImageResponse>

《要素》

要素名

項目

項目説明

ListDiskImageResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

diskimages

説明

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

型

なし

出現回数

0または1

diskimage

説明

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

型

なし

出現回数

0以上

creatorName

説明

ディスクイメージ作成者の組織ID

型

string ASCII

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

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

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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

registrant

説明

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

型

string ASCII

出現回数

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

size

説明

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

型

decimal

出現回数

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

numOfNIC

説明

NIC数

型

int

出現回数

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

maxCpuPerf

説明

最大CPU性能

型

decimal

出現回数

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

numOfMaxCpu

説明

最大CPU数

型

int

出現回数

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

maxMemorySize

説明

最大メモリ量

型

decimal

出現回数

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

numOfMaxDisk

説明

最大ディスク数

型

int

出現回数

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

maxDiskSize

説明

最大ディスク容量

型

decimal

出現回数

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

numOfMaxNic

説明

最大NIC数

型

int

出現回数

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

softwares

説明

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

型

なし

出現回数

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

software

説明

ソフトウェア情報の一式

型

なし

出現回数

0以上

license

説明

ライセンス

型

string UTF-8

出現回数

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

name

説明

ソフトウェア名

型

string UTF-8

出現回数

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

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

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

category

説明

ソフトウェア区分

型

string UTF-8

出現回数

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

osCategory

説明

OS区分

型

string UTF-8

出現回数

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

version

説明

バージョン

型

string UTF-8

出現回数

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

officialVersion

説明

正式バージョン

型

string UTF-8

出現回数

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

patch

説明

パッチ版数

型

string UTF-8

出現回数

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

support

説明

サポート

型

string UTF-8

出現回数

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

patches

説明

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

型

なし

出現回数

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

patch

説明

パッチ情報の一式

型

なし

出現回数

0以上

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

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

patchId

説明

パッチID

型

string ASCII

出現回数

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

componentName

説明

コンポーネント名

型

string UTF-8

出現回数

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

description

説明

パッチの説明

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
 <ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <diskimages>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image_id_1</diskimageId>
      <diskimageName>image-1</diskimageName>
      <maxCpuPerf>3.0</maxCpuPerf>
      <maxDiskSize>500.0</maxDiskSize>
      <maxMemorySize>4.0</maxMemorySize>
      <numOfMaxCpu>4</numOfMaxCpu>
      <numOfMaxDisk>3</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <numOfNIC>1</numOfNIC>
      <patches>
        <patch>
          <componentName>INSERVEE</componentName>
          <description>JServlet緊急修正</description>
          <patchId>T000519WP-04</patchId>
          <softwareId>SW00000004</softwareId>
        </patch>
      </patches>
      <registrant>cfmgadm</registrant>
      <size>15.0</size>
      <softwares>
        <software>
          <category>APP</category>
          <license>Fujitsu</license>
          <name>Interstage Application Server(日本語版)</name>
          <officialVersion />
          <osCategory>windows</osCategory>
          <patch />
          <softwareId>SW00000004</softwareId>
          <support>SDK基本</support>
          <version>6.1</version>
        </software>
      </softwares>
    </diskimage>
  </diskimages>
</ListDiskImageResponse>

7.3.1.3 ListServerType

仮想データセンター内にある仮想マシンイメージタイプの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「ListServerType」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <servertypes>
    <servertype>
      <comment>[コメント]</comment>
      <cpu>
        <cpuArch>[CPUアーキテクチャ]</cpuArch>
        <cpuPerf>[CPU性能]</cpuPerf>
        <numOfCpu>[CPU数]/numOfCpu>
        <cpuReserve>[CPU予約性能]</cpuReserve>
        <cpuShare>[CPU配分比]</cpuShare>
      </cpu>
      <disks>
        <disk>
          <diskSize>[ディスク容量]</diskSize>
          <diskIndex>[ディスクインデックス]</diskIndex>
        </disk>
      </disks>
      <id>[ID]</id>
      <label>[ラベル]</label>
      <memory>
        <memorySize>[メモリサイズ]</memorySize>
        <memoryReserve>[メモリ予約容量]</memoryReserve>
        <memoryShare>[メモリ配分比]</memoryShare>
      </memory>
      <name>[L-Serverテンプレート名]</name>
      <nics>
        <numOfNIC>[NIC数]</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>[運用位置]</positioning>
        <redundancy>[冗長性]</redundancy>
      </serverPolicy>
      <type>[サーバタイプ]</type>
      <vmType>[VM種別]</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

《要素》

要素名

項目

項目説明

ListServerTypeResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

servertypes

説明

サーバタイプ情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

servertype

説明

サーバタイプ情報の一式

型

なし

出現回数

0以上

comment

説明

コメント

型

string UTF-8

出現回数

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

cpu

説明

CPU情報の一式

型

なし

出現回数

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

cpuArch

説明

CPUアーキテクチャ。以下のどちらかになります。
・「IA」: IA
・「SPARC」: SPARC

型

string ASCII

出現回数

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

cpuPerf

説明

CPU性能

型

decimal

出現回数

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

numOfCpu

説明

CPU数

型

int

出現回数

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

cpuReserve

説明

CPU予約性能

型

decimal

出現回数

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

cpuShare

説明

CPU配分比

型

int

出現回数

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

disks

説明

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

型

なし

出現回数

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

disk

説明

ディスク情報の一式

型

なし

出現回数

0以上

diskSize

説明

ディスク容量

型

decimal

出現回数

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

diskIndex

説明

ディスクインデックス

型

int

出現回数

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

id

説明

サーバID

型

string ASCII

出現回数

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

label

説明

サーバラベル

型

string UTF-8

出現回数

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

memory

説明

メモリ情報の一式

型

なし

出現回数

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

memorySize

説明

メモリサイズ

型

decimal

出現回数

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

memoryReserve

説明

メモリ予約容量

型

decimal

出現回数

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

memoryShare

説明

メモリ配分比

型

int

出現回数

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

name

説明

L-Serverテンプレート名

型

string UTF-8

出現回数

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

nics

説明

NIC情報の一式

型

なし

出現回数

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

numOfNIC

説明

NIC数

型

int

出現回数

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

serverPolicy

説明

サーバポリシー情報の一式

型

なし

出現回数

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

positioning

説明

運用位置。以下のどれかになります。
・「Fixed」: 位置固定
・「AttachAtBoot」: 起動ごとに可変
・「Flexible」:運用中も可変

型

string ASCII

出現回数

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

redundancy

説明

冗長性

型

string UTF-8

出現回数

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

type

説明

サーバタイプ。以下のどちらかになります。
・「Physical」: 物理サーバ
・「Virtual」: 仮想サーバ

型

string ASCII

出現回数

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

vmType

説明

VM種別。以下のどれかになります。
・「VMware」:VMware
・「RHEL-Xen」: RHEL-Xen
・「Hyper-V」:Hyper-V

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListServerTypeResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <servertypes>
    <servertype>
      <comment>コメント1</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.6</cpuPerf>
        <numOfCpu>4</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>1</id>
      <label>ラベル1</label>
      <memory>
        <memorySize>8</memorySize>
      </memory>
      <name>High Performance</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <type>server_type</type>
      <vmType>VMware</vmType>
    </servertype>
    <servertype>
      <comment>コメント2</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>2.0</cpuPerf>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <numOfCpu>2</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>2</id>
      <label>ラベル2</label>
      <memory>
        <memorySize>4</memorySize>
        <memoryReserve>0.5</memoryReserve>
        <memoryShare>1000</memoryShare>
      </memory>
      <name>Middle Spec</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <type>server_type</type>
      <vmType>RHEL-Xen</vmType>
    </servertype>
    <servertype>
      <comment>コメント3</comment>
      <cpu>
        <cpuArch>IA</cpuArch>
        <cpuPerf>1.4</cpuPerf>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <numOfCpu>1</numOfCpu>
      </cpu>
      <disks>
        <disk>
          <diskIndex>0</diskIndex>
          <diskSize>100</diskSize>
        </disk>
      </disks>
      <id>3</id>
      <label>ラベル3</label>
      <memory>
        <memorySize>2</memorySize>
      </memory>
      <name>Economy</name>
      <nics>
        <numOfNIC>10</numOfNIC>
      </nics>
      <serverPolicy>
        <positioning>pos</positioning>
        <redundancy>red</redundancy>
      </serverPolicy>
      <type>server_type</type>
      <vmType>VMware</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

7.3.1.4 GetVSYSDescriptorConfiguration

テンプレートの構成情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「GetVSYSDescriptorConfiguration」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内

vsysDescriptorId

説明

システムテンプレートID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysdescriptor>
    <creatorName>[テンプレート作成者の組織ID]</creatorName>
    <description>[テンプレートの説明]</description>
    <registrant>[テンプレート登録者]</registrant>
    <vnets>
      <vnet>
        <networkId>[ネットワークID]</networkId>
        <name>[ネットワーク名]</name>
        <numOfMaxVm>[最大VM数]</numOfMaxVm>
        <networkCategory>[ネットワーク種別]</networkCategory>
      </vnet>
    </vnets>
    <vservers>
      <vserver>
        <creator>[仮想マシン作成者の組織ID]</creator>
        <diskimageId>[ディスクイメージID]</diskimageId>
        <diskimageName>[ディスクイメージ名]</diskimageName>
        <vdisks>
          <vdisk>
            <size>[増設ディスクサイズ]</size>
            <storagePool>[ストレージプールのリソース名]</storagePool>
          </vdisk>
        </vdisks>
        <vserverName>[仮想マシン名]</vserverName>
        <vserverType>[仮想マシンタイプ]</vserverType>
        <vmPool>[VMプールのリソース名]</vmPool>
        <storagePool>[ストレージプールのリソース名]</storagePool>
        <vnics>
          <vnic>
            <nicNo>[NIC連番]</nicNo>
            <networkId>[接続先ネットワーク]</networkId>
            <management>[制御NIC]</management>
          </vnic>
        </vnics>
      </vserver>
    </vservers>
    <vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
    <vsysdescriptorName>[システムテンプレート名]</vsysdescriptorName>
  </vsysdescriptor>
</GetVSYSDescriptorConfigurationResponse>

《要素》

要素名

項目

項目説明

GetVSYSDescriptorConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

vsysdescriptor

説明

システムテンプレート情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

creatorName

説明

システムテンプレートの作成者の組織ID

型

string ASCII

出現回数

0または1

description

説明

システムテンプレートの説明

型

string UTF-8

出現回数

0または1

registrant

説明

システムテンプレートの登録者

型

string UTF-8

出現回数

0または1

vnets

説明

ネットワーク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vnet

説明

ネットワーク情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

name

説明

ネットワーク名

型

string UTF-8

出現回数

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

numOfMaxVm

説明

最大VM数

型

int

出現回数

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

networkCategory

説明

ネットワーク種別

型

string ASCII

出現回数

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

vservers

説明

仮想マシン情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vserver

説明

仮想マシン情報の一式

型

なし

出現回数

0以上

creator

説明

仮想マシン作成者の組織ID

型

string ASCII

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

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

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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

vdisks

説明

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

型

なし

出現回数

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

vdisk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

size

説明

増設ディスクサイズ。単位は「GB」になります。

型

decimal

出現回数

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

storagePool

説明

ストレージプールのリソース名

型

string ASCII

出現回数

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

vserverName

説明

仮想マシン名

型

string UTF-8

出現回数

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

vserverType

説明

仮想マシンタイプ

型

string ASCII

出現回数

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

vmPool

説明

VMプールのリソース名

型

string UTF-8

出現回数

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

storagePool

説明

ストレージプールのリソース名

型

string UTF-8

出現回数

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

vnics

説明

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

型

なし

出現回数

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

vnic

説明

VNIC情報の一式

型

なし

出現回数

0以上

nicNo

説明

NIC連番

型

int

出現回数

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

networkId

説明

接続先ネットワーク

型

string ASCII

出現回数

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

management

説明

制御NIC。制御NICの場合は1、そうでない場合は0になります。

型

int

出現回数

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

vsysdescriptorId

説明

システムテンプレートID

型

string ASCII

出現回数

0または1

vsysdescriptorName

説明

システムテンプレート名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSDescriptorConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysdescriptor>
    <creatorName>adminorg</creatorName>
    <description>テスト用のテンプレート</description>
    <registrant>adminorg</registrant>
    <vnets>
      <vnet>
        <name>DMZ</name>
        <networkCategory>BUSINESS</networkCategory>
        <networkId>VNET1</networkId>
        <numOfMaxVm>10</numOfMaxVm>
      </vnet>
      <vnet>
        <name>SECURE</name>
        <networkCategory>MANAGEMENT</networkCategory>
        <networkId>VNET2</networkId>
        <numOfMaxVm>5</numOfMaxVm>
      </vnet>
    </vnets>
    <vservers>
      <vserver>
        <creator>cfmgadm</creator>
        <diskimageId>image_id_1</diskimageId>
        <diskimageName>image-1</diskimageName>
        <storagePool>/storagepool</storagePool>
        <vdisks>
          <vdisk>
            <size>10.0</size>
            <storagePool>/sp_1</storagePool>
          </vdisk>
        </vdisks>
        <vmPool>/vmpool</vmPool>
        <vnics>
          <vnic>
            <management>1</management>
            <networkId>VNET1</networkId>
            <nicNo>1</nicNo>
          </vnic>
          <vnic>
            <management>0</management>
            <networkId>VNET1</networkId>
            <nicNo>2</nicNo>
          </vnic>
        </vnics>
        <vserverName>web</vserverName>
        <vserverType>Middle Spec</vserverType>
      </vserver>
    </vservers>
    <vsysdescriptorId>template-0001</vsysdescriptorId>
    <vsysdescriptorName>テストテンプレート</vsysdescriptorName>
  </vsysdescriptor>
</GetVSYSDescriptorConfigurationResponse>

7.3.1.5 GetVSYSDescriptorAttributes

システムテンプレートの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「GetVSYSDescriptorAttributes」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内

vsysDescriptorId

説明

システムテンプレートID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
 <GetVSYSDescriptorAttributesResponse xmlns=~» http://cfmg.systemwalker.jp.fujitsu.com~»>
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysdescriptor>
    <creatorName>[システムテンプレートの作成者の組織ID]</creatorName>
    <description>[システムテンプレートの説明]</description>
    <registrant>[システムテンプレートの登録者]</registrant>
    <vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
    <vsysDescriptorName>[システムテンプレート名]</vsysDescriptorName>
  </vsysdescriptor>
</GetVSYSDescriptorAttributesResponse>

《要素》

要素名

項目

項目説明

GetVSYSDescriptorAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

vsysdescriptor

説明

システムテンプレート情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

creatorName

説明

システムテンプレートの作成者の組織ID

型

string ASCII

出現回数

0または1

description

説明

システムテンプレートの説明

型

string UTF-8

出現回数

0または1

registrant

説明

システムテンプレートの登録者

型

string UTF-8

出現回数

0または1

vsysdescriptorId

説明

システムテンプレートID

型

string ASCII

出現回数

0または1

vsysdescriptorName

説明

システムテンプレート名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSDescriptorAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysdescriptor>
    <creatorName>adminorg</creatorName>
    <description>テスト用のテンプレート</description>
    <registrant>adminorg</registrant>
    <vsysdescriptorId>template-0001</vsysdescriptorId>
    <vsysdescriptorName>テストテンプレート</vsysdescriptorName>
  </vsysdescriptor>
</GetVSYSDescriptorAttributesResponse>

7.3.1.6 GetPoolList

リソースプールの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「GetPoolList」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内

[type]

説明

リソースプールの種別。省略時はすべての種別のリソースプールを取得します。

型

string ASCII

設定内容

以下から選択します。
・「vm」: VMプール
・「storage」: ストレージプール
・「mac」:MACアドレスセット


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <resourcepools>
    <vmpools>
      <vmpool>
        <name>[VMプールのリソース名]</name>
        <priority>[優先順位]</priolity>
        <cpuTotal>[CPU総容量]</cpuTotal>
        <cpuFree>[CPU空き容量]</cpuFree>
        <maxCpuPerf>[最大CPU性能]</maxCpuPerf>
        <numOfMaxCpu>[最大CPU数]</numOfMaxCpu>
        <memoryTotal>[メモリ総容量]</memoryTotal>
        <memoryFree>[メモリ空き容量]</memoryFree>
        <maxMemorySize>[最大メモリ量]</maxMemorySize>
      </vmpool>
    </vmpools>
    <storagepools>
      <storagepool>
        <name>[ストレージプールのリソース名]</name>
        <priority>[優先順位]</priolity>
        <total>[ストレージ総容量]</total>
        <free>[ストレージ空き容量]</free>
        <maxDiskSize>[最大ディスク容量]</maxDiskSize>
      </storagepool>
    </storagepools>
    <macaddresses>
      <macaddress>
        <name>[MACアドレスセットのリソース名]</name>
        <total>[MACアドレス総数]</total>
        <free>[空きMACアドレス数]</free>
      </macaddress>
    </macaddresses>
  </resourcepools>
</DetachVDiskResponse>

《要素》

要素名

項目

項目説明

GetPoolListResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「7.4 レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

resourcepools

説明

リソースプール情報のレスポンス情報を持つ要素

型

なし

出現回数

1

vmpools

説明

VMプール情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vmpool

説明

VMプール情報の一式

型

なし

出現回数

0以上

name

説明

VMプールのリソース名

型

string UTF-8

出現回数

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

priority

説明

優先順位

型

int

出現回数

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

cpuTotal

説明

CPU総容量

型

decimal

出現回数

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

cpuFree

説明

CPU空き容量

型

decimal

出現回数

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

maxCpuPerf

説明

最大CPU性能

型

decimal

出現回数

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

numOfMaxCpu

説明

最大CPU数

型

int

出現回数

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

memoryTotal

説明

メモリ総容量

型

decimal

出現回数

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

memoryFree

説明

メモリ空き容量

型

decimal

出現回数

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

maxMemorySize

説明

最大メモリ量

型

decimal

出現回数

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

storagepools

説明

ストレージプール情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

storagepool

説明

ストレージプール情報の一式

型

なし

出現回数

0以上

name

説明

ストレージプールのリソース名

型

string UTF-8

出現回数

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

priority

説明

優先順位

型

int

出現回数

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

total

説明

ストレージ総容量

型

decimal

出現回数

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

free

説明

ストレージ空き容量

型

decimal

出現回数

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

maxDiskSize

説明

最大ディスク容量

型

decimal

出現回数

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

macaddresses

説明

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

型

なし

出現回数

0または1

macaddress

説明

MACアドレス情報の一式

型

なし

出現回数

0以上

name

説明

MACアドレスセットのリソース名

型

string UTF-8

出現回数

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

total

説明

MACアドレス総数

型

int

出現回数

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

free

説明

空きMACアドレス数

型

int

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetPoolListResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <resourcepools>
    <macaddresses />
    <storagepools>
      <storagepool>
        <free>584.4</free>
        <maxDiskSize>298.9</maxDiskSize>
        <name>/StoragePool</name>
        <priority>5</priority>
        <total>1199.4</total>
      </storagepool>
    </storagepools>
    <vmpools>
      <vmpool>
        <cpuFree>36.8</cpuFree>
        <cpuTotal>46.8</cpuTotal>
        <maxCpuPerf>2.4</maxCpuPerf>
        <maxMemorySize>61.6</maxMemorySize>
        <memoryFree>121.2</memoryFree>
        <memoryTotal>131.2</memoryTotal>
        <name>/VMPool</name>
        <numOfMaxCpu>8</numOfMaxCpu>
        <priority>5</priority>
      </vmpool>
      <vmpool>
        <cpuFree>12.2</cpuFree>
        <cpuTotal>46.8</cpuTotal>
        <maxCpuPerf>1.1</maxCpuPerf>
        <maxMemorySize>55.6</maxMemorySize>
        <memoryFree>107.1</memoryFree>
        <memoryTotal>131.1</memoryTotal>
        <name>/test_resource/TEST_VMPool</name>
        <numOfMaxCpu>8</numOfMaxCpu>
        <priority>5</priority>
      </vmpool>
    </vmpools>
  </resourcepools>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</GetPoolListResponse>
前次
Copyright 2010-2011 FUJITSU LIMITED