ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView
第2章 L-Platform APIリファレンス > 2.3 サーバの操作 > 2.3.2 ListLServer (L-Platform内のサーバ一覧を取得)
前次

2.3.2 ListLServer (L-Platform内のサーバ一覧を取得)

L-Platform 内にあるサーバIDの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lservers>
    <lserver>
      <creator>[サーバ作成者のテナント名]</creator>
      <diskimageId>[ディスクイメージID]</diskimageId>
      <diskimageName>[ディスクイメージ名]</diskimageName>
      <disks>
        <disk>
          <attachedTo>[増設ディスクが取り付けられているサーバID]</attachedTo>
          <creator>[増設ディスク作成者のテナント名]</creator>
          <size>[増設ディスクサイズ]</size>
          <diskId>[増設ディスクID]</diskId>
          <diskName>[増設ディスク名]</diskName>
          <resourceName>[既存ディスク名]</resourceName>
        </disk>
      </disks>
      <lserverId>[サーバID]</lserverId>
      <lserverName>[サーバ名]</lserverName>
      <serverType>[サーバのタイプ]</serverType>
      <lserverType>[サーバタイプ]</lserverType>
      <resource>
        <name>[L-Server名]</name>
      </resource>
      <containerPoolManaged>[本製品の管理対象かどうかを示すフラグ]</containerPoolManaged>
      <snapshotExist>[サーバにスナップショットが存在するかを示すフラグ]</snapshotExist>
    </lserver>
  </lservers>
</ListLServerResponse>

《要素》

要素名

項目

項目説明

ListLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lservers

説明

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

型

なし

出現回数

0または1

lserver

説明

サーバ情報の一式

型

なし

出現回数

0以上

creator

説明

サーバ作成者のテナント名

型

string ASCII

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

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

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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

disks

説明

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

型

なし

出現回数

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

disk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

attachedTo

説明

増設ディスクが取り付けられているサーバID

型

string ASCII

出現回数

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

creator

説明

増設ディスク作成者のテナント名

型

string ASCII

出現回数

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

size

説明

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

型

decimal

出現回数

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

diskId

説明

増設ディスクID

型

string ASCII

出現回数

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

diskName

説明

増設ディスク名

型

string UTF-8

出現回数

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

resourceName

説明

既存ディスクの名前。

この要素は既存ディスクだけに表示されます。

型

string UTF-8

出現回数

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

lserverId

説明

サーバID

型

string ASCII

出現回数

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

lserverName

説明

サーバ名

型

string UTF-8

出現回数

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

serverType

説明

サーバタイプ

型

string ASCII

出現回数

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

lserverType

説明

サーバタイプ。次の値のどちらかです。
・Physical：物理サーバ

・Virtual：仮想サーバ。

型

string ASCII

出現回数

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

resource

説明

リソースタブで表示される情報の一式

型

なし

出現回数

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

name

説明

L-Server名

型

string ASCII

出現回数

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

containerPoolManaged

説明

サーバが動作するコンテナリソースプールが、本製品の管理対象かどうかを示すフラグ。以下のどちらかです。

"true":管理対象

"false":管理対象外

型

string ASCII

出現回数

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

snapshotExist

説明

サーバにスナップショットが存在するかを示すフラグ。以下のどちらかです。

"true":スナップショットが存在する

"false":スナップショットが存在しない

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListLServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lservers>
    <lserver>
      <creator>tenantA</creator>
      <diskimageId>image-1324e093f4e</diskimageId>
      <diskimageName>g-physical-0001</diskimageName>
      <lserverType>Physical</lserverType>
      <disks/>
      <lserverId>tenantA-8O0NW7TZV-S-0001</lserverId>
      <lserverName>物理サーバ-1</lserverName>
      <serverType>Economy</serverType>
      <resource>
        <name>tenantA-8O0NW7TZV-S-0001</name>
      </resource>
      <snapshotExist>false</snapshotExist>
    </lserver>
    <lserver>
      <creator>tenantA</creator>
      <diskimageId>image-1324e09f82f</diskimageId>
      <diskimageName>g-vm-0002</diskimageName>
      <lserverType>Virtual</lserverType>
      <disks>
        <disk>
          <attachedTo>tenantA-8O0NW7TZV-S-0002</attachedTo>
          <creator>tenantA</creator>
          <size>20.0</size>
          <diskId>tenantA-8O0NW7TZV-D-0001</diskId>
          <diskName>DISK1</diskName>
        </disk>
      </disks>
      <lserverId>tenantA-8O0NW7TZV-S-0002</lserverId>
      <lserverName>仮想マシン-1</lserverName>
      <serverType>over_commit</serverType>
      <resource>
        <name>tenantA-8O0NW7TZV-S-0002</name>
      </resource>
      <snapshotExist>true</snapshotExist>
    </lserver>
  </lservers>
</ListLServerResponse>

前次
Copyright 2011-2012 FUJITSU LIMITED