ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.0.0 リファレンスガイド インフラ管理者編
第3部 APIリファレンス > 第7章 L-Platform API > 7.3 L-Platform APIリファレンス > 7.3.3 サーバの操作
前次

7.3.3 サーバの操作

サーバの操作に関連するL-Platform APIについて説明します。

7.3.3.1 CreateLServer (サーバを新規作成)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverName

説明

サーバ名

型

string UTF-8

設定内容

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

serverType

説明

サーバタイプ

型

string ASCII

設定内容

32文字以内

lservertype

説明

サーバ種別

型

string ASCII

設定内容

以下のどちらかを指定します。

・Physical：物理サーバ

・Virtual：仮想サーバ

省略した場合はVirtualが指定されたものとして動作します。

diskImageId

説明

ディスクイメージID

型

string ASCII

設定内容

32文字以内

controlNetworkId

説明

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

型

string ASCII

設定内容

物理サーバを作成する場合には、管理LANのネットワークIDを指定する必要があります。
制御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

[pool]

説明

VMプール、またはサーバプールのリソース名

型

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。
RHEL-KVMを利用する場合は指定必須です。

例：/tenantA/pool

[storagePool]

説明

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

型

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。
RHEL-KVMを利用する場合は指定必須です。

例：/tenantA/pool

[cpuPerf]

説明

CPU性能。GHz単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。
RHEL-KVMを利用する場合は指定しても無視され、プールの最大CPU性能値が設定されます。

型

decimal

設定内容

0.1～99999.9

[numOfCpu]

説明

CPU数

型

int

設定内容

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

[cpuReserve]

説明

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

型

decimal

設定内容

0.0～99999.9

[cpuShare]

説明

[VM種別がVMwareの場合]
CPUシェア
[VM種別がHyper-Vの場合]
CPU割当優先度

物理サーバの場合は指定しても無視されます。

型

int

設定内容

[VM種別がVMwareの場合] 1～1000000

[VM種別がHyper-Vの場合] 1～10000

[memorySize]

説明

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

型

decimal

設定内容

0.1～99999.9

[memoryReserve]

説明

[VM種別がVMwareの場合]
メモリ予約容量。0.0以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください。
[VM種別がHyper-Vの場合]
メモリ予約容量。0.1以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください。

物理サーバの場合は指定しても無視されます。

型

decimal

設定内容

[VM種別がVMwareの場合] 0.0～99999.9
[VM種別がHyper-Vの場合] 0.1～99999.9

[memoryShare]

説明

[VM種別がVMwareの場合]
メモリ配分比。
[VM種別がHyper-Vの場合]
メモリ割当優先度。

物理サーバの場合は指定しても無視されます。

型

int

設定内容

[VM種別がVMwareの場合] 0～1000000
[VM種別がHyper-Vの場合] 0～10000

[macAddress]

説明

MACアドレスのアドレスセットリソース名。RHEL5-Xenの場合に指定可能です。省略時は設定ファイルで指定したデフォルト値が使用されます。その他の場合は指定しても無効になります。

型

string ASCII

設定内容

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

[priority]

説明

一括電源制御時の起動優先度。この値が小さなサーバから起動されます。
本パラメーターを省略した場合は128が設定されます。

型

int

設定内容

1～256


コマンド

CreateLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverName サーバの名前 -serverType サーバのタイプ
 -lserverType サーバの種別 -diskImageId ディスクイメージID -controlNetworkId 制御NICのネットワークID
 [-networkId 制御NIC以外のネットワークID] [-pool VMプールのリソース名] [-storagePool ストレージプールのリソース名]
 [-cpuPerf CPU性能] [-numOfCpu CPU数] [-cpuReserve CPU予約性能]  [-cpuShare CPU配分比] [-memorySize メモリ容量]
 [-memoryReserve メモリ予約容量] [-memoryShare メモリ配分比] [-macAddress MACアドレスのアドレスセットリソース名]
 [-priority 電源起動優先度]

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

CreateLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lserverId

説明

サーバID

型

string ASCII

出現回数

0または1


サンプルレスポンス

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

7.3.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文字以内


コマンド

ListLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID

レスポンス

《ステータスコード》

正常に終了した場合に「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>
    </lserver>
  </lservers>
</ListLServerResponse>

《要素》

要素名

項目

項目説明

ListLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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)


サンプルレスポンス

<?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>
    </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>
    </lserver>
  </lservers>
</ListLServerResponse>

7.3.3.3 DestroyLServer (サーバを削除)

サーバを削除します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

DestroyLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DestroyLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.4 RestoreLServer (スナップショットからサーバをリストア)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

リストアするサーバID

型

string ASCII

設定内容

32文字以内

snapshotId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

RestoreLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -snapshotId スナップショットID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

RestoreLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.5 StartLServer (サーバを起動)

サーバ内のOSを起動します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

StartLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StartLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.6 StopLServer (サーバを停止)

サーバ内のOSを停止します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

[force]

説明

サーバを強制終了するかどうかを表します。省略した場合は「false」になります。

型

string ASCII

設定内容

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


コマンド

StopLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID [-force 強制終了]

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

StopLServerResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.7 GetLServerStatus (サーバの状態を取得)

サーバの状態情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

GetLServerStatus -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

GetLServerStatusResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lserverStatus

説明

サーバの状態。以下のどれかになります。
・「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"?>
<GetLServerStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserverStatus>RUNNING</lserverStatus>
</GetLServerStatusResponse>

7.3.3.8 GetLServerConfiguration (サーバの構成情報を取得)

サーバの構成情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

GetLServerConfiguration -version バージョンID -locale 言語コード -userId ユーザーID  -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLServerConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lserver>
    <creator>[サーバ作成者のテナント名]</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>
    <disks>
      <disk>
        <attachedTo>[増設ディスクが取り付けられているサーバID]</attachedTo>
        <creator>[増設ディスク作成者のテナント名]</creator>
        <size>[増設ディスクサイズ]</size>
        <diskId>[増設ディスクID]</diskId>
        <diskName>[増設ディスク名]</diskName>
        <resourceName>[既存ディスク名]</resourceName>
        <shared>[共有ディスク属性]</shared>
        <storagePool>[ストレージプールのリソース名]</storagePool>
      </disk>
    </disks>
    <nicgroups>
      <nicgroup>
        <nicgroupIndex>[NICグループのインデックス]</nicgroupIndex>
        <networkId>[ネットワークID]</networkId>
        <privateIp>[IPアドレス]</privateIp>
        <management>[制御NIC]</management>
      </nicgroup>
    </nicgroups>
    <nics>
      <nic>
        <networkId>[ネットワークID]</networkId>
        <nicNo>[NIC連番]</nicNo>
        <privateIp>[IPアドレス]</privateIp>
        <management>[制御NIC]</management>
        <nicgroupIndex>[所属するNICグループのインデックス]</nicgroupIndex>
      </nic>
    </nics>
    <lserverId>[サーバID]</lserverId>
    <lserverName>[サーバ名]</lserverName>
    <hostName>[サーバのホスト名]</hostName>
    <serverType>[サーバタイプ]</serverType>
    <vmType>[VM種別]</vmType>
    <Pool>[VMプールのリソース名]</Pool>
    <storagePool>[ストレージプールのリソース名]</storagePool>
    <cpuPerf>[CPU性能]</cpuPerf>
    <numOfCpu>[CPU数]</numOfCpu>
    <cpuReserve>[CPU予約性能]</cpuReserve>
    <cpuShare>[CPU配分比]</cpuShare>
    <memorySize>[メモリサイズ]</memorySize>
    <memoryReserve>[メモリ予約容量]</memoryReserve>
    <memoryShare>[メモリ配分比]</memoryShare>
    <requestCpuPerf>[要求CPU性能]</requestCpuPerf>
    <requestNumOfCpu>[要求CPU数]</requestNumOfCpu>
    <requestMemorySize>[要求メモリ容量]</requestMemorySize>
    <task>
      <taskId>[タスクID]</taskId>
      <type>[タスクタイプ]</type>
      <status>[タスクステータス]</status>
      <progress>[タスクの進捗]</progress>
    </task>
    <priority>[一括電源制御時の起動優先度]</priority>
  </lserver>
</GetLServerConfigurationResponse>

《要素》

要素名

項目

項目説明

GetLServerConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lserver

説明

サーバ情報の一式

型

なし

出現回数

0または1

creator

説明

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

型

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

説明

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

型

なし

出現回数

imageの数分(それぞれに対して0または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

disks

説明

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

型

なし

出現回数

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)

shared

説明

共有ディスク属性

型

string ASCII

出現回数

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

storagePool

説明

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

型

string ASCII

出現回数

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

nics

説明

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

型

なし

出現回数

0または1

nic

説明

NIC情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

nicNo

説明

NIC連番

型

int

出現回数

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

privateIp

説明

IPアドレス

型

string ASCII

出現回数

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

management

説明

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

型

int

出現回数

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

nicgroupIndex

説明

所属するNICグループのインデックス。

NICグループに含まれない場合は表示されません。

型

int

出現回数

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

nicgroups

説明

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

型

なし

出現回数

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

nicgroup

説明

NIC情報の一式

型

なし

出現回数

0以上

nicgroupIndex

説明

NICグループのインデックス。

型

int

出現回数

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

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

privateIp

説明

IPアドレス

型

string ASCII

出現回数

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

management

説明

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

型

int

出現回数

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

lserverId

説明

サーバID

型

string ASCII

出現回数

0または1

lserverName

説明

サーバ名

型

string UTF-8

出現回数

0または1

hostName

説明

サーバのホスト名

型

string UTF-8

出現回数

0または1

serverType

説明

サーバのタイプ

型

string ASCII

出現回数

0または1

vmType

説明

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

型

string ASCII

出現回数

0または1

pool

説明

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

requestCpuPerf

説明

要求CPU性能

型

decimal

出現回数

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

requestNumOfCpu

説明

要求CPU数

型

int

出現回数

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

requestMemorySize

説明

要求メモリ容量

型

decimal

出現回数

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

lserverType

説明

サーバタイプ。次の値のどちらかです。

・Physical：物理サーバ。

・Virtual：仮想サーバ。

型

decimal

出現回数

lserverの数分(それぞれに対して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

priority

説明

一括電源制御時の起動優先度。0～256になります。
この値が小さなサーバから起動されます。
ただし、起動優先度が「0」のサーバは一括電源操作の対象になりません

型

int

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLserverConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserver>
    <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>
    <disks>
      <disk>
        <attachedTo>testorg-lplatform-3-S-0001</attachedTo>
        <creator>testorg</creator>
        <size>12.2</size>
        <storagePool>/sp_3</storagePool>
        <diskId>testorg-lplatform-3-D-0001</diskId>
        <diskName>DISK1</diskName>
      </disk>
      <disk>
        <attachedTo>testorg-lplatform-3-S-0001</attachedTo>
        <creator>testorg</creator>
        <size>15.5</size>
        <storagePool>/sp_6</storagePool>
        <diskId>testorg-lplatform-3-D-0002</diskId>
        <diskName>DISK2</diskName>
      </disk>
    </disks>
    <Pool>/vp_3</Pool>
    <vmType>RHEL-Xen</vmType>
    <nics>
      <nic>
        <management>0</management>
        <networkId>testorg-lplatform-3-N-INTRANET</networkId>
        <nicNo>1</nicNo>
        <privateIp>10.xx.xx.xx</privateIp>
      </nic>
      <nic>
        <management>0</management>
        <networkId>testorg-lplatform-3-N-INTRANET</networkId>
        <nicNo>2</nicNo>
        <privateIp>10.xx.xx.xx</privateIp>
      </nic>
    </nics>
    <lserverId>testorg-lplatform-3-S-0001</lserverId>
    <lserverName>ap2</lserverName>
    <lserverType>island12_100</lserverType>
    <priority>10</priority>
  </lserver>
</GetLServerConfigurationResponse>

7.3.3.9 GetLServerAttributes (サーバの属性を取得)

サーバの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

GetLServerAttributes -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <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>
    <hostName>[サーバのホスト名]</hostName>
    <serverType>[サーバタイプ]</serverType>
  </lserver>
</GetLServerAttributesResponse>

《要素》

要素名

項目

項目説明

GetLServerAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

lserver

説明

サーバ情報の一式

型

なし

出現回数

0または1

creator

説明

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

型

0または1

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

0または1

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

0または1

disks

説明

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

型

なし

出現回数

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)

hostName

説明

サーバのホスト名

型

string UTF-8

出現回数

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

serverType

説明

サーバタイプ

型

string ASCII

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetLServerAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lserver>
    <creator>tenantA</creator>
    <diskimageId>image-1324e09f82f</diskimageId>
    <diskimageName>g-vm-0002</diskimageName>
    <hostName>V8O0NW7TZV0002</hostName>
    <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>
  </lserver>
</GetLServerAttributesResponse>

7.3.3.10 GetLServerInitialPassword
(サーバのOSに対応する初期管理者パスワードを取得)

サーバのOSに対応する初期管理者パスワードを取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内


コマンド

GetLServerInitialPassword -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetLServerInitialPasswordResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <initialPassword>[サーバのOSに対応する初期管理者パスワード]</initialPassword>
</GetLServerInitialPasswordResponse>

《要素》

要素名

項目

項目説明

GetLServerInitialPasswordResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

initialPassword

説明

サーバのOSに対応する初期管理者パスワード

型

string ASCII

出現回数

0または1


サンプルレスポンス

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

7.3.3.11 UpdateLServerConfiguration (サーバの性能を変更)

仮想サーバの性能を変更します。

物理サーバに対しては実行できません。

以下のうち、どれか1つは必ず指定が必要です。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

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]

説明

[VM種別がVMwareの場合]
CPU配分比
[VM種別がHyper-Vの場合]
CPU割り当て優先度

型

int

設定内容

[VM種別がVMwareの場合]1～1000000
[VM種別がHyper-Vの場合]1～10000

[memorySize]

説明

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

型

decimal

設定内容

0.1～99999.9

[memoryReserve]

説明

[VM種別がVMwareの場合]
メモリ予約容量。0.0以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください。
[VM種別がHyper-Vの場合]
起動メモリ容量。0.1以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください

型

decimal

設定内容

[VM種別がVMwareの場合]
0.0～99999.9
[VM種別がHyper-Vの場合]
0.1～99999.9

[memoryShare]

説明

[VM種別がVMwareの場合]
メモリシェア
[VM種別がHyper-Vの場合]
メモリ割当優先度

型

int

設定内容

[VM種別がVMwareの場合]0～1000000
[VM種別がHyper-Vの場合]0～10000

[serverType]

説明

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

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

型

string ASCII

設定内容

32文字以内

[priority]

説明

一括電源制御時の起動優先度。この値が小さなサーバから起動されます。0を指定した場合、そのサーバは一括電源操作の対象外となります。

型

int

設定内容

0～256


コマンド

UpdateLServerConfiguration -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID [-cpuPerf CPU性能] [-numOfCpu CPU数]
 [-cpuReserve CPU予約性能] [-cpuShare CPU配分比] [-memorySize メモリ容量] [-memoryReserve メモリ予約容量]
 [-memoryShare メモリ配分比] [-serverType <サーバタイプ>] [-priority 電源起動優先度]

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

UpdateLServerConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.12 CreateImage (サーバのクローニングイメージを採取)

サーバのクローニングイメージを採取します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

name

説明

作成するイメージにつけるイメージ名。既存のイメージと同じ名前を指定した場合、そのイメージが更新されます。

型

string ASCII

設定内容

32文字以内

imagePool

説明

イメージプール名

型

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。

例：/tenantA/pool

comment

説明

コメント

型

string UTF-8

設定内容

128文字以内


コマンド

CreateImage -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -name イメージ名 -imagePool イメージプール名
 -comment コメント

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

CreateImageResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.3.13 CreateSnapshot (スナップショットを採取)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

スナップショットを作成するサーバID

型

string ASCII

設定内容

32文字以内

comment

説明

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

型

string UTF-8

設定内容

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


コマンド

CreateSnapshot -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -comment コメント

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.14 ListSnapshot (スナップショット一覧を取得)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

スナップショットの一覧を取得するサーバID

型

string ASCII

設定内容

32文字以内


コマンド

ListSnapshot -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.15 DestroySnapshot (スナップショットを削除)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

snapshotId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

DestroySnapshot -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -snapshotId スナップショットID

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.16 GetSnapshotHistory (スナップショット、リストアの履歴を取得)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

スナップショット、リストアを取得するサーバID

型

string ASCII

設定内容

32文字以内


コマンド

GetSnapshotHistory -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.17 AddPatch (パッチ情報を追加)

サーバにパッチ情報を追加します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバ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文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


コマンド

AddPatch -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名
 -lplatformId L-Platform ID -lserverId サーバID -softwareId ソフトウェアID -patchId パッチID
 [-componentName コンポーネント名] [-description パッチの説明]

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.18 DestroyPatch (パッチ情報を削除)

サーバのパッチ情報を削除します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

softwareId

説明

ソフトウェアID

型

string ASCII

設定内容

32文字以内

patchId

説明

削除するパッチID

型

string ASCII

設定内容

32文字以内


コマンド

DestroyPatch -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -softwareId ソフトウェアID
 -patchId パッチID

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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.19 CancelError (バックアップリストアタスクのエラー状態を解除)

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

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

型

string ASCII

設定内容

32文字以内

taskId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

CancelError -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -taskId タスクID

レスポンス

《ステータスコード》

正常に終了した場合に「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

説明

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

型

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>

7.3.3.20 CreateNic (サーバにNICを追加)

サーバにNICを追加します。

仮想化ソフトウェアが、VMware、Hyper-V、およびRHEL-KVMのサーバにだけ実行可能です。

対象のサーバにスナップショットが存在する場合、NICの追加はできません。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

ネットワークを追加するL-PlatformのID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

networkId

説明

追加したNICを接続するネットワークID

型

string ASCII

設定内容

32文字以内

[ipAddress]

説明

追加したNICに割り当てるIPアドレス

型

string ASCII

設定内容

－

コマンド

CreateNic -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -networkId ネットワークID [-ipAddress IPアドレス]

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

CreateNicResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

サンプルレスポンス

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

7.3.3.21 DestroyNic (指定したNICをサーバから削除)

指定したNICをサーバから削除します。

仮想化ソフトウェアが、VMware、Hyper-V、およびRHEL-KVMのサーバにだけ実行可能です。

対象のサーバにスナップショットが存在する場合、NICの削除はできません。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

ネットワークを削除するL-PlatformのID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

nicNo

説明

NIC番号

型

string ASCII

設定内容

削除するNICの番号を指定してください。1以上の値を指定してください。

コマンド

DestroyNic -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -nicNo NIC番号

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DestroyNicResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

サンプルレスポンス

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

前次
Copyright 2011-2012 FUJITSU LIMITED