2.1.1 ListLPlatformDescriptor (テンプレート一覧を取得)

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

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

リクエストパラメーター

パラメーター名	項目	項目説明
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
	設定内容	固定。"ListLPlatformDescriptor"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
[keyword]	説明	一覧に表示するテンプレートを絞り込むためのキーワード。指定した場合は、同じキーワードを含むテンプレートだけがレスポンスに含まれます。
	型	string UTF-8
	設定内容	85文字以内

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>[L-Platformテンプレート作成者のテナント名]</creatorName>
      <description>[L-Platformテンプレートの説明]</description>
      <registrant>[L-Platformテンプレート登録者のID]</registrant>
      <lplatformdescriptorId>[L-PlatformテンプレートID]</lplatformdescriptorId>
      <lplatformdescriptorName>[L-Platformテンプレート名]</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

《要素》

要素名	項目	項目説明
ListLPlatformDescriptorResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
lplatformdescriptors	説明	L-Platformテンプレート一覧のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
lplatformdescriptor	説明	L-Platformテンプレート情報の一式
	型	なし
	出現回数	0以上
creatorName	説明	L-Platformテンプレート作成者のテナント名
	型	string ASCII
	出現回数	lplatformdescriptorの数分(それぞれに対して0または1)
description	説明	L-Platformテンプレートの説明
	型	string UTF-8
	出現回数	lplatformdescriptorの数分(それぞれに対して0または1)
registrant	説明	L-Platformテンプレート登録者のID
	型	string ASCII
	出現回数	lplatformdescriptorの数分(それぞれに対して0または1)
lplatformdescriptorId	説明	L-PlatformテンプレートID
	型	string ASCII
	出現回数	lplatformdescriptorの数分(それぞれに対して0または1)
lplatformdescriptorName	説明	L-Platformテンプレート名
	型	string UTF-8
	出現回数	lplatformdescriptorの数分(それぞれに対して0または1)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_GL</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826</lplatformdescriptorName>
    </lplatformdescriptor>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>desc</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>TMPL_Win2k8x86_0826_net</lplatformdescriptorId>
      <lplatformdescriptorName>Win2k8x86_0826_net</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>