4.6.2 ListVSYS

仮想データセンター内にあるシステムの一覧を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	CFMG APIのバージョンID
	型	string ASCII
	設定内容	固定。「1.0」を指定してください。
Locale	説明	CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。・「ja」: 日本語・「en」: 英語
Action	説明	実行するCFMG APIの名称
	型	string ASCII
	設定内容	固定。「ListVSYS」を指定してください。
userId	説明	CFMG APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	CFMG APIを実行するユーザーの組織ID
	型	string ASCII
	設定内容	8文字以内

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsyss>
    <vsys>
      <baseDescriptor>[システムの元になったテンプレートID]</baseDescriptor>
      <creator>[システム作成者の組織ID]</creator>
      <description>[システムの説明]</description>
      <vsysId>[システムID]</vsysId>
      <vsysName>[システム名]</vsysName>
    </vsys>
  </vsyss>
</ListVSYSResponse>

《要素》

要素名	項目	項目説明
ListVSYSResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録B レスポンスステータス・エラーコード一覧」を参照してください。
	型	string ASCII
	出現回数	1
vsyss	説明	システム情報のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
vsys	説明	システム情報の一式
	型	なし
	出現回数	0以上
baseDescriptor	説明	システムの元になったテンプレートID
	型	string ASCII
	出現回数	vsysの数分(それぞれに対して0または1)
creator	説明	システム作成者の組織ID
	型	string ASCII
	出現回数	vsysの数分(それぞれに対して0または1)
description	説明	システムの説明
	型	string UTF-8
	出現回数	vsysの数分(それぞれに対して0または1)
vsysId	説明	システムID
	型	string ASCII
	出現回数	vsysの数分(それぞれに対して0または1)
vsysName	説明	システム名
	型	string UTF-8
	出現回数	vsysの数分(それぞれに対して0または1)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsyss>
    <vsys>
      <baseDescriptor>testTemplate000</baseDescriptor>
      <creator>testorg</creator>
      <description>Linux2階層</description>
      <vsysId>testorg-vsys-3</vsysId>
      <vsysName>正常</vsysName>
    </vsys>
  </vsyss>
</ListVSYSResponse>