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

7.3.3 仮想サーバの操作

仮想サーバの操作に関連するCFMG APIについて説明します。

7.3.3.1 CreateVServer

システム内に仮想マシンを作成します。起動ディスクに必要な初期コンテンツとして使用するディスクイメージIDは、必ず指定しなければなりません。リクエストメッセージはUTF-8を用いてエンコードされます。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverName

説明

仮想マシン名

型

string UTF-8

設定内容

85文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。

vserverType

説明

仮想マシンタイプ

型

string ASCII

設定内容

32文字以内

diskImageId

説明

ディスクイメージID

型

string ASCII

設定内容

32文字以内

controlNetworkId

説明

制御NICを接続するネットワークID

型

string ASCII

設定内容

制御NICのIPアドレスを指定して配備する場合には、以下の形式で指定します。

controlNetworkId=network_id'xxx:xxx:xxx:xxx

[networkId]

説明

制御NIC以外のネットワークID

型

string ASCII

設定内容

複数のNICがある場合は、以下の形式で指定します。

networkId=network_1"network_2

また、IPアドレスを指定して配備する場合には、以下の形式で指定します。

networkId=network_1'xxx:xxx:xxx:xxx' 'network_2'xxx:xxx:xxx:xxx

[vmPool]

説明

VMプールリソース名

型

string ASCII

設定内容

32文字以内

[storagePool]

説明

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

型

string ASCII

設定内容

32文字以内

[cpuPerf]

説明

CPU性能。GHz単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.1～99999.9

[numOfCpu]

説明

CPU数

型

int

設定内容

1以上。最大値はイメージごとに指定された値(指定していない場合はINTの最大値)です。

[cpuReserve]

説明

CPU予約性能。0.0以上、cpuPerfまたはイメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.0～99999.9

[cpuShare]

説明

CPU配分比

型

int

設定内容

1～1000000

[memorySize]

説明

メモリ量。GByte単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.1～99999.9

[memoryReserve]

説明

メモリ予約容量。0.0以上、memorySizeまたはイメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.0～99999.9

[memoryShare]

説明

メモリ配分比

型

int

設定内容

0～1000000

[macAddress]

説明

MACアドレスのアドレスセットリソース名。RHEL-Xenの場合に指定可能です。省略時は設定ファイルで指定したデフォルト値が使用されます。
設定ファイルにつては、『導入ガイド』の「デフォルトMACアドレス設定について」を参照してください。その他の場合は指定しても無効になります。

型

string ASCII

設定内容

32文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vserverId>[仮想マシンID]</vserverId>
</CreateVServerResponse>

《要素》

要素名

項目

項目説明

CreateVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vserverId

説明

仮想マシンID

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CreateVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vserverId>VSERVER000001</vserverId>
</CreateVServerResponse>

7.3.3.2 ListVServer

システム内にある仮想マシンIDの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListVServerResponse xmlns=~»~http~://cfmg.systemwalker.jp.fujitsu.com~»>
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vservers>
    <vserver>
      <creator>[仮想マシン作成者の組織ID]</creator>
      <diskimageId>[ディスクイメージID]</diskimageId>
      <diskimageName>[ディスクイメージ名]</diskimageName>
      <vdisks>
        <vdisk>
          <attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
          <creator>[増設ディスク作成者の組織ID]</creator>
          <size>[増設ディスクサイズ]</size>
          <vdiskId>[増設ディスクID]</vdiskId>
          <vdiskName>[増設ディスク名]</vdiskName>
        </vdisk>
      </vdisks>
      <vserverId>[仮想マシンID]</vserverId>
      <vserverName>[仮想マシン名]</vserverName>
      <vserverType>[仮想マシンタイプ]</vserverType>
    </vserver>
  </vservers>
</ListVServerResponse>

《要素》

要素名

項目

項目説明

ListVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

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以上

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)

vserverId

説明

仮想マシンID

型

string ASCII

出現回数

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

vserverName

説明

仮想マシン名

型

string UTF-8

出現回数

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

vserverType

説明

仮想マシンタイプ

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vservers>
    <vserver>
      <creator>testorg</creator>
      <diskimageId>image_id_1</diskimageId>
      <diskimageName>image-1</diskimageName>
      <vdisks>
        <vdisk>
          <attachedTo>testorg-vsys-3-S-0001</attachedTo>
          <creator>testorg</creator>
          <size>12.2</size>
          <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>
          <vdiskId>testorg-vsys-3-D-0002</vdiskId>
          <vdiskName>DISK2</vdiskName>
        </vdisk>
      </vdisks>
      <vserverId>testorg-vsys-3-S-0001</vserverId>
      <vserverName>ap2</vserverName>
      <vserverType>island12_100</vserverType>
    </vserver>
    <vserver>
      <creator>testorg</creator>
      <diskimageId>ROR-manager_382</diskimageId>
      <diskimageName>image-2</diskimageName>
      <vdisks>
        <vdisk>
          <attachedTo>testorg-vsys-3-S-0002</attachedTo>
          <creator>testorg</creator>
          <size>16.6</size>
          <vdiskId>testorg-vsys-3-D-0003</vdiskId>
          <vdiskName>DISK3</vdiskName>
        </vdisk>
      </vdisks>
      <vserverId>testorg-vsys-3-S-0002</vserverId>
      <vserverName>ap1</vserverName>
      <vserverType>island12_100</vserverType>
    </vserver>
  </vservers>
</ListVServerResponse>

7.3.3.3 DestroyVServer

仮想マシンを削除します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<DestroyVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</DestroyVServerResponse>

《要素》

要素名

項目

項目説明

DestroyVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<DestroyVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroyVServerResponse>

7.3.3.4 RestoreVServer

サーバをスナップショットの状態に復元します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

リストアする仮想マシンID

型

string ASCII

設定内容

32文字以内

snapshotId

説明

リストア元スナップショットID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<RestoreVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</RestoreVServerResponse>

《要素》

要素名

項目

項目説明

RestoreVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<RestoreVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</RestoreVServerResponse>

7.3.3.5 StartVServer

仮想マシン内のOSを起動します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<StartVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</StartVServerResponse>

《要素》

要素名

項目

項目説明

StartVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<StartVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</StartVServerResponse>

7.3.3.6 StopVServer

仮想マシン内のOSを停止します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

仮想マシンID

型

string ASCII

設定内容

32文字以内

[force]

説明

仮想マシンを強制終了するかどうかを表します。省略した場合は「false」になります。

型

string ASCII

設定内容

以下から選択します。
・「true」: 強制終了する
・「false」: 強制終了しない


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<StopVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</StopVServerResponse>

《要素》

要素名

項目

項目説明

StopVServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<StopVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</StopVServerResponse>

7.3.3.7 GetVServerStatus

仮想マシンの状態情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<GetVServerStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vserverStatus>[仮想マシンの状態]</vserverStatus>
</GetVServerStatusResponse>

《要素》

要素名

項目

項目説明

GetVServerStatusResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vserverStatus

説明

仮想マシンの状態。以下のどれかになります。
・「DEPLOYING」: 配備中
・「RUNNING」: 稼働
・「STOPPING」: 停止中
・「STOPPED」: 停止
・「STARTING」: 稼働中
・「UNEXPECTED_STOP」: 予期せずに停止
・「RESTORING」: リストア中
・「BACKUP_ING」: バックアップ中
・「ERROR」: 仮想マシンのエラー
・「EXECUTE_IPCOM」: IPCOM、ネットワークサーバの構成情報が処理中
・「START_ERROR」: 仮想マシン起動時のエラー
・「STOP_ERROR」: 仮想マシン停止時のエラー

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVServerStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vserverStatus>RUNNING</vserverStatus>
</GetVServerStatusResponse>

7.3.3.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>
    <diskimageName>[ディスクイメージ名]</diskimageName>
    <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>
    <cpuReserve>[CPU予約性能]</cpuReserve>
    <cpuShare>[CPU配分比]</cpuShare>
    <momorySize>[メモリサイズ]</memorySize>
    <memoryReserve>[メモリ予約容量]</memoryReserve>
    <memoryShare>[メモリ配分比]</memoryShare>
    <task>
      <taskId>[タスクID]</tasked>
      <type>[タスクタイプ]</type>
      <status>[タスクステータス]</status>
      <progress>[タスクの進捗]</progress>
    </task>
  </vserver>
</GetVServerConfigurationResponse>

《要素》

要素名

項目

項目説明

GetVServerConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vserver

説明

仮想マシン情報の一式

型

なし

出現回数

0または1

creator

説明

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

型

string ASCII

出現回数

0または1

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

0または1

diskimageName

説明

ディスクイメージ名

型

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)

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

cpuReserve

説明

CPU予約性能

型

decimal

出現回数

0または1

cpuShare

説明

CPU配分比

型

int

出現回数

0または1

memorySize

説明

メモリ量

型

decimal

出現回数

0または1

memoryReserve

説明

メモリ予約容量

型

decimal

出現回数

0または1

memoryShare

説明

メモリ配分比

型

int

出現回数

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>
    <diskimageName>image-1</diskimageName>
    <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>
    <memoryReserve>0.5</memoryReserve>
    <memoryShare>1000</memoryShare>
    <numOfCpu>2</numOfCpu>
    <cpuReserve>0.5</cpuReserve>
    <cpuShare>10</cpuShare>
    <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>
        <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>

7.3.3.9 GetVServerAttributes

仮想マシンの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<GetVServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vserver>
    <creator>[仮想マシン作成者の組織ID]</creator>
    <diskimageId>[ディスクイメージID]</diskimageId>
    <diskimageName>[ディスクイメージ名]</diskimageName>
    <vdisks>
      <vdisk>
        <attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
        <creator>[増設ディスク作成者の組織ID]</creator>
        <size>[増設ディスクサイズ]</size>
        <vdiskId>[増設ディスクID]</vdiskId>
        <vdiskName>[増設ディスク名]</vdiskName>
      </vdisk>
    </vdisks>
    <vserverId>[仮想マシンID]</vserverId>
    <vserverName>[仮想マシン名]</vserverName>
    <vserverType>[仮想マシンタイプ]</vserverType>
  </vserver>
</GetVServerAttributesResponse>

《要素》

要素名

項目

項目説明

GetVServerAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vserver

説明

仮想マシン情報の一式

型

なし

出現回数

0または1

creator

説明

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

型

0または1

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

0または1

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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)

vserverId

説明

仮想マシンID

型

string ASCII

出現回数

0または1

vserverName

説明

仮想マシン名

型

string UTF-8

出現回数

0または1

vserverType

説明

仮想マシンタイプ

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vserver>
    <creator>testorg</creator>
    <diskimageId>image_id_1</diskimageId>
    <diskimageName>image-1</diskimageName>
    <vdisks>
      <vdisk>
        <attachedTo>testorg-vsys-3-S-0001</attachedTo>
        <creator>testorg</creator>
        <size>12.2</size>
        <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>
        <vdiskId>testorg-vsys-3-D-0002</vdiskId>
        <vdiskName>DISK2</vdiskName>
      </vdisk>
    </vdisks>
    <vserverId>testorg-vsys-3-S-0001</vserverId>
    <vserverName>ap2</vserverName>
    <vserverType>island12_100</vserverType>
  </vserver>
</GetVServerAttributesResponse>

7.3.3.10 GetVServerInitialPassword

仮想マシンのOSに対応する初期管理者パスワードを取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<GetVServerInitialPasswordResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <initialPassword>[仮想マシンのOSに対応する初期管理者パスワード]</initialPassword>
</GetVServerInitialPasswordResponse>

《要素》

要素名

項目

項目説明

GetVServerInitialPasswordResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

initialPassword

説明

仮想マシンのOSに対応する初期管理者パスワード

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVServerInitialPasswordResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <initialPassword>init_pass</initialPassword>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</GetVServerInitialPasswordResponse>

7.3.3.11 UpdateVServerConfiguration

仮想マシンの性能を変更します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

仮想マシンID

型

string ASCII

設定内容

32文字以内

[numOfCpu]

説明

CPU数

型

int

設定内容

1以上。最大値はイメージごとに指定された値(指定していない場合はINTの最大値)です。

[cpuPerf]

説明

CPU性能。GHz単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.1～99999.9

[cpuReserve]

説明

CPU予約性能。0.0以上、cpuPerfまたはイメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.0～99999.9

[cpuShare]

説明

CPU配分比

型

int

設定内容

1～1000000

[memorySize]

説明

メモリ量。GByte単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.1～99999.9

[memoryReserve]

説明

メモリ予約容量。0.0以上、memorySizeまたはイメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

型

decimal

設定内容

0.0～99999.9

[memoryShare]

説明

メモリ配分比

型

int

設定内容

0～1000000

vserverType

説明

サーバタイプ。指定したサーバタイプのデフォルトの性能値が設定されます。

本パラメーターとCPU、メモリ性能を同時に指定した場合、CPU、メモリ性能の値が優先されます。

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<UpdateVServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</UpdateVServerConfigurationResponse>

《要素》

要素名

項目

項目説明

UpdateVServerConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<UpdateVServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</UpdateVServerConfigurationResponse>

7.3.3.12 CreateSnapshot

サーバのスナップショットを作成します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

スナップショットを作成する仮想マシンID

型

string ASCII

設定内容

32文字以内

comment

説明

スナップショットに対するコメント

型

string UTF-8

設定内容

日本語、半角文字に関係なく128文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</CreateSnapshotResponse>

《要素》

要素名

項目

項目説明

CreateSnapshotResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CreateSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CreateSnapshotResponse>

7.3.3.13 ListSnapshot

スナップショットの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <snapshots>
    <snapshot>
      <snapshotId>[スナップショットID]</snapshotId>
      <comment>[スナップショットのコメント]</comment>
      <snapshotTime>[スナップショットの作成日時]</snapshotTime>
    </snapshot>
  </snapshots>
</ListSnapshotResponse>

《要素》

要素名

項目

項目説明

ListSnapshotResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

snapshots

説明

スナップショット情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

snapshot

説明

スナップショット情報の一式

型

なし

出現回数

0以上

snapshotId

説明

スナップショットID

型

string ASCII

出現回数

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

comment

説明

スナップショットのコメント

型

string UTF-8

出現回数

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

snapshotTime

説明

スナップショットの作成日時

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListSnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <snapshots>
    <snapshot>
      <comment>コメント</comment>
      <snapshotId>image000001</snapshotId>
      <snapshotTime>2010-11-12 10:00:11±09:00</snapshotTime>
    </snapshot>
    <snapshot>
      <comment>コメント</comment>
      <snapshotId>image000002</snapshotId>
      <snapshotTime>2010-11-12 10:00:11±09:00</snapshotTime>
    </snapshot>
  </snapshots>
</ListSnapshotResponse>

7.3.3.14 DestroySnapshot

スナップショットを削除します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

snapshotId

説明

削除するスナップショットID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<DestroySnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</DestroySnapshotResponse>

《要素》

要素名

項目

項目説明

DestroySnapshotResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<DestroySnapshotResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroySnapshotResponse>

7.3.3.15 GetSnapshotHistory

スナップショット、リストアの履歴を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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”?>
<GetSnapshotHistoryResponse xmlns=”http://cfmg.systemwalker.jp.fujitsu.com”>
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <histories>
    <history>
      <action>[行った操作]</action>
      <snapshotId>[スナップショットID]</snapshotId>
      <startTime>[スナップショットまたはリストアの開始時刻]</startTime>
      <endTime>[スナップショットまたはリストアの完了時刻]</endTime>
      <status>[スナップショットまたはリストアの状態]</status>
      <progress>[スナップショットまたはリストアの進捗状況]</progress>
    </history>
  </histories>
</GetSnapshotHistoryResponse>

《要素》

要素名

項目

項目説明

GetSnapshotHistoryResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

histories

説明

スナップショット情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

history

説明

スナップショット情報の一式

型

なし

出現回数

0以上

action

説明

行った操作。以下のどちらかになります。
・「SNAPSHOT」: スナップショットの作成

・「RESTORE」: スナップショットへの復元

型

string ASCII

出現回数

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

startTime

説明

スナップショットまたはリストアの開始時刻

型

string ASCII

出現回数

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

endTime

説明

スナップショットまたはリストアの完了時刻

型

string ASCII

出現回数

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

status

説明

スナップショットまたはリストアの状態。以下のどれかになります。
・「waiting」: 待ち

・「running」: 実行中

・「completed」: 完了

・「error」: エラー

型

string ASCII

出現回数

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

progress

説明

スナップショットまたはリストアの進捗状況。0～100になります。

型

int

出現回数

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

snapshotId

説明

スナップショットID

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version=”1.0” encoding=”UTF-8”?>
<GetSnapshotHistoryResponse xmlns=”http://cfmg.systemwalker.jp.fujitsu.com”>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <histories>
    <history>
      <action>SNAPSHOT</action>
      <snapshotId>image000001</snapshotId>
      <startTime>2010-11-12 10:00:11±09:00</startTime>
      <endTime>2010-11-12 10:01:11±09:00</endTime>
      <status>completed</status>
      <progress>100</progress>
    </history>
    <history>
      <action>RESTORE</action>
      <snapshotId>image000001</snapshotId>
      <startTime>2010-11-12 10:20:11±09:00</startTime>
      <status>running</status>
      <progress>70</progress>
    </history>
  </histories>
</GetSnapshotHistoryResponse>

7.3.3.16 AddPatch

仮想マシンにパッチ情報を追加します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

仮想マシンID

型

string ASCII

設定内容

32文字以内

softwareId

説明

ソフトウェアID

型

string ASCII

設定内容

32文字以内

patchId

説明

パッチID

型

string ASCII

設定内容

32文字以内。任意の値を指定できます。修正番号などを指定してください。既存のIDを指定した場合は、指定したIDのパッチ情報を更新します。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。

[componentName]

説明

パッチを適用するコンポーネント名。パッチの仕様にコンポーネントの概念がない場合は省略します。

型

string UTF-8

設定内容

85文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。

description

説明

パッチに対する説明

型

string UTF-8

設定内容

85文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<AddPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</AddPatchResponse>

《要素》

要素名

項目

項目説明

AddPatchResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<AddPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</AddPatchResponse>

7.3.3.17 DestroyPatch

仮想マシンのパッチ情報を削除します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

vserverId

説明

仮想マシンID

型

string ASCII

設定内容

32文字以内

softwareId

説明

ソフトウェアID

型

string ASCII

設定内容

32文字以内

patchId

説明

削除するパッチID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<DestroyPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</DestroyPatchResponse>

《要素》

要素名

項目

項目説明

DestroyPatchResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<DestroyPatchResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroyPatchResponse>

7.3.3.18 CancelError

指定した任意のバックアップまたはリストアタスクのエラー状態を解除します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内

taskId

説明

エラー状態を解除するバックアップまたはリストアタスクID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</CancelErrorResponse>

《要素》

要素名

項目

項目説明

CancelErrorResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CancelErrorResponse>

前次
Copyright 2010-2011 FUJITSU LIMITED