サーバの構成情報を取得します。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
---|---|---|
Version | 説明 | L-Platform APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。"2.0"を指定してください。 | |
Locale | 説明 | L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 ・"ja": 日本語 | |
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文字以内 |
レスポンス
《ステータスコード》
正常に終了した場合に"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> <maxCpuPerf>[最大CPU性能]</maxCpuPerf> <maxDiskSize>[最大ディスクサイズ]</maxDiskSize> <maxMemorySize>[最大メモリ容量]</maxMemorySize> <maxSysvolSize>[システムディスクの最大容量]</maxSysvolSize> <numOfMaxCpu>[最大CPU数]</numOfMaxCpu> <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> <sysvolSize>[SYSVOLのサイズ]</sysvolSize> <lserverType>[サーバタイプ]</lserverType> <resource> <name>[L-Server名]</name> </resource> <containerPoolManaged>[本製品の管理対象かどうかを示すフラグ]</containerPoolManaged> <snapshotExist>[サーバにスナップショットが存在するかを示すフラグ]</snapshotExist> <vmType>[VM種別]</vmType> <Pool>[VMプールのリソース名]</Pool> <storagePool>[ストレージプールのリソース名]</storagePool> <sparePool>[予備設定プールのリソース名]</sparePool> <cpuPerf>[CPU性能]</cpuPerf> <numOfCpu>[CPU数]</numOfCpu> <cpuReserve>[CPU予約性能]</cpuReserve> <cpuShare>[CPU配分比]</cpuShare> <maxDefinableMemorySize>[最大メモリ量]</maxDefinableMemorySize> <memoryHotPlug>[メモリホットプラグ]</memoryHotPlug> <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 | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | 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ビット |
型 | string ASCII | |
出現回数 | 0または1 | |
id | 説明 | イメージID |
型 | string ASCII | |
出現回数 | 0または1 | |
numOfMaxCpu | 説明 | 最大CPU数 |
型 | int | |
出現回数 | 0または1 | |
maxCpuPerf | 説明 | 最大CPU性能 |
型 | decimal | |
出現回数 | 0または1 | |
maxDiskSize | 説明 | 最大ディスク容量 |
型 | decimal | |
出現回数 | 0または1 | |
maxMemorySize | 説明 | 最大メモリ量 |
型 | decimal | |
出現回数 | 0または1 | |
maxSysvolSize | 説明 | システムディスクの最大容量 |
型 | decimal | |
出現回数 | 0または1 | |
numOfMaxDisk | 説明 | 最大ディスク数 |
型 | int | |
出現回数 | 0または1 | |
numOfMaxNic | 説明 | 最大NIC数 |
型 | int | |
出現回数 | 0または1 | |
serverApplication | 説明 | サーバ用途。以下のどれかになります。 ・"WEB":WEBサーバ |
型 | string ASCII | |
出現回数 | 0または1 | |
serverCategory | 説明 | サーバ種別。"GENERAL:汎用サーバ"になります。 |
型 | string ASCII | |
出現回数 | 0または1 | |
softwares | 説明 | ソフトウェア情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | 0または1 | |
software | 説明 | ソフトウェア情報の一式 |
型 | なし | |
出現回数 | 0以上 | |
category | 説明 | ソフトウェア区分。次のどれかになります。 ・"OS":OS |
型 | 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 |
型 | string ASCII | |
出現回数 | 0または1 | |
pool | 説明 | VMプールのリソース名 |
型 | string UTF-8 | |
出現回数 | 0または1 | |
storagePool | 説明 | ストレージプールのリソース名 |
型 | string UTF-8 | |
出現回数 | 0または1 | |
sparePool | 説明 | 予備設定プールのリソース名 |
型 | 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 | |
maxDefinableMemorySize | 説明 | 最大メモリ量。 |
型 | decimal | |
出現回数 | 0または1 | |
memoryHotPlug | 説明 | メモリホットプラグ。メモリホットプラグが有効なKVMのサーバは、メモリの活性変更が可能です。 ・true:有効 メモリホットプラグが有効な場合、変更可能な最大メモリ量は以下のうち、最も小さな値に制限されます。 ・MAXDefinableMemorySize |
型 | string ASCII | |
出現回数 | 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:物理サーバ。 |
型 | string ASCII | |
出現回数 | lserverの数分(それぞれに対して0または1) | |
task | 説明 | 最新のバックアップまたはリストアのタスク情報の一式 |
型 | なし | |
出現回数 | 0または1 | |
taskId | 説明 | タスクID |
型 | string ASCII | |
出現回数 | 0または1 | |
type | 説明 | タスク種別。以下のどれかになります。 ・"BACKUP":バックアップ |
型 | string ASCII | |
出現回数 | 0または1 | |
status | 説明 | タスクステータス。以下のどれかになります。 ・"completed": 完了 |
型 | string ASCII | |
出現回数 | 0または1 | |
progress | 説明 | タスク進捗率。単位は"%"になります。0から100の値となります。 |
型 | int | |
出現回数 | 0または1 | |
priority | 説明 | 一括電源制御時の起動優先度。0~256になります。 |
型 | int | |
出現回数 | lserverの数分(それぞれに対して0または1) | |
resource | 説明 | リソースタブで表示される情報の一式 |
型 | なし | |
出現回数 | lserverの数分(それぞれに対して0または1) | |
name | 説明 | L-Server名 |
型 | string ASCII | |
出現回数 | resourceの数分(それぞれに対して0または1) | |
containerPoolManaged | 説明 | サーバが動作するコンテナリソースプールが、本製品の管理対象かどうかを示すフラグ。以下のどちらかです。 ・"true":管理対象 |
型 | string ASCII | |
出現回数 | lserverの数分(それぞれに対して0または1) | |
snapshotExist | 説明 | サーバにスナップショットが存在するかを示すフラグ。以下のどちらかです。 ・"true":スナップショットが存在する |
型 | string ASCII | |
出現回数 | lserverの数分(それぞれに対して0または1) | |
sysvolSize | 説明 | SYSVOLのサイズ |
型 | decimal | |
出現回数 | 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.4</cpuPerf> <creator>tenantA</creator> <diskimageId>image-132480039e8</diskimageId> <diskimageName>g-vm-0001</diskimageName> <hostName>test-vm11</hostName> <image> <cpuBit>32</cpuBit> <id>image-132480039e8</id> <maxCpuPerf>4.0</maxCpuPerf> <maxDiskSize>100.0</maxDiskSize> <maxMemorySize>8.0</maxMemorySize> <maxSysvolSize>200.0</maxSysvolSize> <numOfMaxCpu>2</numOfMaxCpu> <numOfMaxDisk>0</numOfMaxDisk> <numOfMaxNic>3</numOfMaxNic> <serverApplication>AP</serverApplication> <serverCategory>GENERAL</serverCategory> <softwares> <software> <category>OS</category> <license>1</license> <name>softNameA</name> <officialVersion/> <patch/> <softwareId>SW00000003</softwareId> <support>1</support> <version>6.0</version> </software> </softwares> <sysvolSize>20.0</sysvolSize> </image> <memorySize>2.0</memorySize> <numOfCpu>1</numOfCpu> <storagePool>/StoragePool</storagePool> <lserverType>Virtual</lserverType> <disks/> <vmType>Vmware</vmType> <nics> <nic> <management>1</management> <networkId>N3FY52Z4F-N-3sep#FWS#</networkId> <nicNo>1</nicNo> <privateIp>192.xxx.xxx.xxx</privateIp> </nic> <nic> <management>0</management> <networkId>N3FY52Z4F-N-3sep#FWS#</networkId> <nicNo>2</nicNo> <privateIp>192.xxx.xxx.xxx</privateIp> </nic> <nic> <management>0</management> <networkId>N3FY52Z4F-N-3seq#FWS#</networkId> <nicNo>3</nicNo> <privateIp>192.xxx.xxx.xxx</privateIp> </nic> </nics> <lserverId>tenantA-N3FY52Z4F-S-0001</lserverId> <lserverName>test-vm11</lserverName> <serverType>over_commit</serverType> <sysvolSize>100</sysvolSize> <resource> <name>tenantA-N3FY52Z4F-S-0001</name> </resource> <snapshotExist>true</snapshotExist> </lserver> </GetLServerConfigurationResponse>