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

4.5.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>
        <vdisks>
          <vdisk>
            <size>[増設ディスクサイズ]</size>
            <shared>[共有ディスク属性]</shared>
            <copy>[コピー元ディスクID]</copy>
            <storagePool>[ストレージプールのリソース名]</storagePool>
          </vdisk>
        </vdisks>
        <vserverName>[仮想マシン名]</vserverName>
        <vserverType>[仮想マシンタイプ]</vserverType>
        <vmPool>[VMプールのリソース名]</vmPool>
        <storagePool>[ストレージプールのリソース名]</storagePool>
        <priority>[仮想マシンの作成順序]</priority>
        <vnics>
          <vnic>
            <nicNo>[NIC連番]</nicNo>
            <networkId>[接続先ネットワーク]</networkId>
            <management>[制御NIC]</management>
          </vnic>
        </vnics>
      </vserver>
    </vservers>
    <vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
    <vsysdescriptorName>[システムテンプレート名]</vsysdescriptorName>
  </vsysdescriptor>
</GetVSYSDescriptorConfigurationResponse>

《要素》

要素名

項目

項目説明

GetVSYSDescriptorConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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)

vdisks

説明

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

型

なし

出現回数

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

vdisk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

size

説明

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

型

decimal

出現回数

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

shared

説明

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

型

string ASCII

出現回数

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

copy

説明

コピー元ディスクID

型

string ASCII

出現回数

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)

priority

説明

仮想マシンの作成順序。1～256の値となります。

型

int

出現回数

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>
        <priority>128</priority>
        <storagePool>/storagepool</storagePool>
        <vdisks>
          <vdisk>
            <copy>copied_disk</copy>
            <shared>true</shared>
            <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>

前次
Copyright 2011 FUJITSU LIMITED