ページの先頭行へ戻る
Systemwalker Software Configuration Manager V14g リファレンスガイド API編
Systemwalker
第4章 CFMG APIリファレンス > 4.7 仮想サーバの操作 > 4.7.8 GetVServerConfiguration
前次

4.7.8 GetVServerConfiguration

システムの構成情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

仮想マシンID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetVServerConfigurationResponse xmlns=~»~http~://cfmg.systemwalker.jp.fujitsu.com~»>
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vserver>
    <creator>[仮想マシン作成者の組織ID]</creator>
    <diskimageId>[ディスクイメージID]</diskimageId>
    <image>
      <cpuBit>[CPUビット数]</cpuBit>
      <id>[イメージID]</id>
      <numOfMaxDisk>[最大ディスク数]</numOfMaxDisk>
      <numOfMaxNic>[最大NIC数]</numOfMaxNic>
      <serverApplication>[サーバ用途]</serverApplication>
      <serverCategory>[サーバ種別]</serverCategory>
      <softwares>
        <software>
          <category>[ソフトウェア区分]</category>
          <softwareId>[ソフトウェアID]</softwareId>
          <license>[ライセンス情報]</license>
          <name>[ソフトウェア名]</name>
          <officialVersion>[正式バージョン]</officialVersion>
          <patch>[パッチ版数]</patch>
          <support>[サポート]</support>
          <version>[バージョン]</version>
        </software>
      </softwares>
      <patches>
        <patch>
          <softwareId>[ソフトウェアID]</softwareId>
          <patchId>[パッチID]</patchId>
          <componentName>[コンポーネント名]</componentName>
          <description>[パッチの説明]</description>
        </patch>
      </patches>
      <sysvolSize>[SYSVOLサイズ]</sysvolSize>
    </image>
    <vdisks>
      <vdisk>
        <attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
        <creator>[増設ディスク作成者の組織ID]</creator>
        <size>[増設ディスクサイズ]</size>
        <vdiskId>[増設ディスクID]</vdiskId>
        <vdiskName>[増設ディスク名]</vdiskName>
      </vdisk>
    </vdisks>
    <vnics>
      <vnic>
        <networkId>[ネットワークID]</networkId>
        <nicNo>[NIC連番]</nicNo>
        <privateIp>[IPアドレス]</privateIp>
      </vnic>
    </vnics>
    <vserverId>[仮想マシンID]</vserverId>
    <vserverName>[仮想マシン名]</vserverName>
    <vserverType>[仮想マシンタイプ]</vserverType>
    <vmType>[VM種別]</vmType>
    <vmPool>[VMプールのリソース名]</vmPool>
    <storagePool>[ストレージプールのリソース名]</storagePool>
    <cpuPerf>[CPU性能]</cpuPerf>
    <numOfCpu>[CPU数]</numOfCpu>
    <momorySize>[メモリサイズ]</memorySize>
    <task>
      <taskId>[タスクID]</tasked>
      <type>[タスクタイプ]</type>
      <status>[タスクステータス]</status>
      <progress>[タスクの進捗]</progress>
    </task>
  </vserver>
</GetVServerConfigurationResponse>

《要素》

要素名

項目

項目説明

GetVServerConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vserver

説明

仮想マシン情報の一式

型

なし

出現回数

0または1

creator

説明

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

型

string ASCII

出現回数

0または1

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

0または1

image

説明

イメージ情報の一式

型

なし

出現回数

0または1

cpuBit

説明

CPUビット数。以下のどちらかになります。
・「32」:32ビット
・「64」:64ビット

型

string ASCII

出現回数

0または1

id

説明

イメージID

型

string ASCII

出現回数

0または1

numOfMaxDisk

説明

最大ディスク数

型

int

出現回数

0または1

numOfMaxNic

説明

最大NIC数

型

int

出現回数

0または1

serverApplication

説明

サーバ用途。以下のどれかになります。
・「WEB」:WEBサーバ
・「AP」:APサーバ
・「DB」:DBサーバ
・「FILE」:FILEサーバ

型

string ASCII

出現回数

0または1

serverCategory

説明

サーバ種別。「GENERAL：汎用サーバ」になります。

型

string ASCII

出現回数

0または1

softwares

説明

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

型

なし

出現回数

0または1

software

説明

ソフトウェア情報の一式

型

なし

出現回数

0以上

category

説明

ソフトウェア区分。次のどれかになります。
・「OS」:OS
・「MIDDLE」：ミドルウェア
・「APP」：アプリケーション

型

string ASCII

出現回数

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

softwareId

説明

ソフトウェアID

型

string ASCII

出現回数

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

license

説明

ライセンス

型

string UTF-8

出現回数

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

name

説明

ソフトウェア名

型

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)

version

説明

バージョン

型

string UTF-8

出現回数

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

patches

説明

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

型

なし

出現回数

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)

sysvolSize

説明

SYSVOLサイズ

型

decimal

出現回数

0または1

vdisks

説明

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

型

なし

出現回数

0または1

vdisk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

attachedTo

説明

増設ディスクが取り付けられている仮想マシンID

型

string ASCII

出現回数

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

creator

説明

増設ディスク作成者の組織ID

型

string ASCII

出現回数

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

size

説明

増設ディスクサイズ。「GB」単位で指定します。

型

decimal

出現回数

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

vdiskId

説明

増設ディスクID

型

string ASCII

出現回数

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

vdiskName

説明

増設ディスク名

型

string UTF-8

出現回数

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

shared

説明

ディスク共有属性。以下のどちらかになります。
・「true」: 共有ディスクの場合
・「false」: 共有ディスクではない場合または表示されない場合

型

string ASCII

出現回数

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

storagePool

説明

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

型

string ASCII

出現回数

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

vnics

説明

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

型

なし

出現回数

0または1

vnic

説明

VNIC情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

nicNo

説明

NIC連番

型

int

出現回数

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

privateIp

説明

IPアドレス

型

string ASCII

出現回数

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

management

説明

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

型

int

出現回数

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

vserverId

説明

仮想マシンID

型

string ASCII

出現回数

0または1

vserverName

説明

仮想マシン名

型

string UTF-8

出現回数

0または1

vserverType

説明

仮想マシンのタイプ

型

string ASCII

出現回数

0または1

vmType

説明

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

型

string ASCII

出現回数

0または1

vmPool

説明

VMプールのリソース名

型

string UTF-8

出現回数

0または1

storagePool

説明

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

型

string UTF-8

出現回数

0または1

cpuPerf

説明

CPU性能

型

decimal

出現回数

0または1

numOfCpu

説明

CPU数

型

int

出現回数

0または1

memorySize

説明

メモリ量

型

decimal

出現回数

0または1

task

説明

最新のバックアップまたはリストアのタスク情報の一式

型

なし

出現回数

0または1

taskId

説明

タスクID

型

string ASCII

出現回数

0または1

type

説明

タスク種別。以下のどちらかになります。
・「BACKUP」:バックアップ
・「RESTORE」:リストア

型

string ASCII

出現回数

0または1

status

説明

タスクステータス。以下のどれかになります。
・「completed」: 完了
・「running」: 実行中
・「waiting」: 待機中
・「error」: エラー

型

string ASCII

出現回数

0または1

progress

説明

タスク進捗率。単位は「%」になります。0から100の値となります。

型

int

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vserver>
    <cpuPerf>1.3</cpuPerf>
    <creator>testorg</creator>
    <diskimageId>image_id_1</diskimageId>
    <image>
      <cpuBit>64</cpuBit>
      <id>image_id_1</id>
      <numOfMaxDisk>3</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <patches>
        <patch>
          <componentName>コンポ1</componentName>
          <description>説明1</description>
          <patchId>patch-sw1-01</patchId>
          <softwareId>SW00000001</softwareId>
        </patch>
        <patch>
          <componentName>コンポ2</componentName>
          <description>説明2</description>
          <patchId>patch-sw4-01</patchId>
          <softwareId>SW00000004</softwareId>
        </patch>
      </patches>
      <serverApplication>WEB</serverApplication>
      <serverCategory>GENERAL</serverCategory>
      <softwares>
        <software>
          <category>APP</category>
          <license>Fujitsu</license>
          <name>Interstage Application Server(日本語版)</name>
          <officialVersion>4</officialVersion>
          <patch>p-4</patch>
          <softwareId>SW00000004</softwareId>
          <support>SDK基本</support>
          <version>6.1</version>
        </software>
      </softwares>
      <sysvolSize>15.0</sysvolSize>
    </image>
    <memorySize>8.9</memorySize>
    <numOfCpu>2</numOfCpu>
    <storagePool>/sp_3</storagePool>
    <task>
      <progress>100</progress>
      <status>completed</status>
      <taskId>task_00004</taskId>
      <type>RESTORE</type>
    </task>
    <vdisks>
      <vdisk>
        <attachedTo>testorg-vsys-3-S-0001</attachedTo>
        <creator>testorg</creator>
        <shared>true</shared>
        <size>12.2</size>
        <storagePool>/sp_3</storagePool>
        <vdiskId>testorg-vsys-3-D-0001</vdiskId>
        <vdiskName>DISK1</vdiskName>
      </vdisk>
      <vdisk>
        <attachedTo>testorg-vsys-3-S-0001</attachedTo>
        <creator>testorg</creator>
        <size>15.5</size>
        <storagePool>/sp_6</storagePool>
        <vdiskId>testorg-vsys-3-D-0002</vdiskId>
        <vdiskName>DISK2</vdiskName>
      </vdisk>
    </vdisks>
    <vmPool>/vp_3</vmPool>
    <vmType>RHEL-Xen</vmType>
    <vnics>
      <vnic>
        <management>0</management>
        <networkId>testorg-vsys-3-N-INTRANET</networkId>
        <nicNo>1</nicNo>
        <privateIp>10.xx.xx.xx</privateIp>
      </vnic>
      <vnic>
        <management>0</management>
        <networkId>testorg-vsys-3-N-INTRANET</networkId>
        <nicNo>2</nicNo>
        <privateIp>10.xx.xx.xx</privateIp>
      </vnic>
    </vnics>
    <vserverId>testorg-vsys-3-S-0001</vserverId>
    <vserverName>ap2</vserverName>
    <vserverType>island12_100</vserverType>
  </vserver>
</GetVServerConfigurationResponse>

前次
Copyright 2011 FUJITSU LIMITED