4.5.1 ListVSYSDescriptor

仮想データセンター内のシステムテンプレート一覧を取得します。

同時にシステムテンプレートの属性情報を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
Version	説明	CFMG APIのバージョンID
	型	string ASCII
	設定内容	固定。「1.0」を指定してください。
Locale	説明	CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。
	型	string ASCII
	設定内容	以下から選択します。・「ja」: 日本語・「en」: 英語
Action	説明	実行するCFMG APIの名称
	型	string ASCII
	設定内容	固定。「ListVSYSDescriptor」を指定してください。
userId	説明	CFMG APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	CFMG APIを実行するユーザーの組織ID
	型	string ASCII
	設定内容	8文字以内
[keyword]	説明	一覧に表示するテンプレートを絞り込むためのキーワード。指定した場合は、同じキーワードを含むシステムテンプレートだけがレスポンスに含まれます。
	型	string UTF-8
	設定内容	85文字以内

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysdescriptors>
    <vsysdescriptor>
      <creatorName>[システムテンプレート作成者の組織ID]</creatorName>
      <description>[システムテンプレートの説明]</description>
      <registrant>[システムテンプレート登録者のID]</registrant>
      <vsysdescriptorId>[システムテンプレートID]</vsysdescriptorId>
      <vsysdescriptorName>[システムテンプレート名]</vsysdescriptorName>
    </vsysdescriptor>
  </vsysdescriptors>
</ListVSYSDescriptorResponse>

《要素》

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

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysdescriptors>
    <vsysdescriptor>
      <creatorName>adminorg</creatorName>
      <description>テスト用のテンプレート</description>
      <registrant>adminorg</registrant>
      <vsysdescriptorId>template-0001</vsysdescriptorId>
      <vsysdescriptorName>テストテンプレート</vsysdescriptorName>
    </vsysdescriptor>
  </vsysdescriptors>
</ListVSYSDescriptorResponse>