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

レスポンス

《ステータスコード》

正常に終了した場合に"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>
    <resource>
      <name>[L-Server名]</name>
    </resource>
  </lserver>
</GetLServerAttributesResponse>

《要素》

要素名	項目	項目説明
GetLServerAttributesResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	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)
resource	説明	リソースタブで表示される情報の一式
	型	なし
	出現回数	lserverの数分(それぞれに対して0または1)
name	説明	L-Server名
	型	string ASCII
	出現回数	resourceの数分(それぞれに対して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>
    <resource>
      <name>tenantA-8O0NW7TZV-S-0002</name>
    </resource>
  </lserver>
</GetLServerAttributesResponse>