ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView

2.1.3 ListServerType (L-Serverテンプレート一覧を取得)

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

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

L-Platform APIのバージョンID

string ASCII

設定内容

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

Locale

説明

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

string ASCII

設定内容

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

Action

説明

実行するL-Platform APIの名称

string ASCII

設定内容

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

userId

説明

L-Platform APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<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>
        <aliveMonitoring>[生存監視]</aliveMonitoring>
        <repurpose>[電源OFF時のサーバの自動解放]</repurpose>
      </serverPolicy>
      <lserverType>[サーバタイプ]</lserverType>
      <vmType>[VM種別]</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>

《要素》

要素名

項目

項目説明

ListServerTypeResponse

説明

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

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

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

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)

aliveMonitoring

説明

生存監視。以下のどちらかになります。

・"true":有効

・"false":無効

string ASCII

出現回数

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

repurpose

説明

電源OFF時のサーバの自動解放。以下のどちらかになります。

・"true": 自動的に開放する

・"false": 解放しない

string ASCII

出現回数

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

lservertype

説明

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

string ASCII

出現回数

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

vmType

説明

VM種別。以下のどれかになります。
・"VMware":VMware
・"RHEL-Xen": RHEL-Xen
・"Hyper-V":Hyper-V
・"RHEL-KVM":RHEL-KVM
・"Solaris Containers":Solarisコンテナ

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>Fixed</positioning>
        <redundancy>None</redundancy>
        <aliveMonitoring>true</aliveMonitoring>
        <repurpose>false</repurpose>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <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>Fixed</positioning>
        <redundancy>None</redundancy>
        <aliveMonitoring>false</aliveMonitoring>
        <repurpose>true</repurpose>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <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>Fixed</positioning>
        <redundancy>HA</redundancy>
        <aliveMonitoring>false</aliveMonitoring>
        <repurpose>false</repurpose>
      </serverPolicy>
      <lserverType>server_type</lserverType>
      <vmType>VMware</vmType>
    </servertype>
  </servertypes>
</ListServerTypeResponse>