ServerView Resource Orchestrator Cloud Edition V3.1.2 リファレンスガイド (API編)

2.1.10 ListSLBRuleset (サーバロードバランサーのルールセットの一覧を取得)

サーバロードバランサーのルールセットの一覧を取得します。

リクエストパラメーター

パラメーター名	項目	項目説明
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
	設定内容	固定。"ListSLBlRuleset"を指定してください。
userId	説明	L-Platform APIを実行するユーザーID
	型	string ASCII
	設定内容	31文字以内
orgId	説明	L-Platform APIを実行するユーザーのテナント名
	型	string ASCII
	設定内容	32文字以内
[rulesetCategory]	説明	ルールセットの種別。省略時は、すべての種別のルールセットを取得します。
	型	string ASCII
	設定内容	以下のどちらかを指定してください。 ・config：設定用のルールセット ・operation：運用操作用のルールセット

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListSLBRulesetResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <rulesets>
    <ruleset>
      <description>[ルールセットの説明]</description>
      <lplatformModel>[L-Platformのモデル]</lplatformModel>
      <name>[ルールセットの名前]</name>
      <numOfMaxSegment>[最大セグメント数]</numOfMaxSegment>
      <numOfMaxVm>[最大VM数]</numOfMaxVm>
      <rulesetCategory>[ルールセットの種別]</rulesetCategory>
      <type>[ネットワークデバイスのタイプ]</type>
    </ruleset>
  </rulesets>
</ListSLBRulesetResponse>

《要素》

要素名	項目	項目説明
ListSLBRulesetResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。 メッセージの詳細については、「メッセージ集」の「第15章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
rulesets	説明	サーバロードバランサーのルールセット一覧のレスポンス情報を持つ要素
	型	なし
	出現回数	0または1
ruleset	説明	サーバロードバランサーのルールセット情報の一式
	型	なし
	出現回数	rulesetsの数分(それぞれに対して0以上)
description	説明	ルールセットの説明
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
lplatformModel	説明	L-Platformのモデル。以下のどちらかです。 ・"Firewall+SLB"：ファイアーウォールとサーバロードバランサー ・"SLB only"：サーバロードバランサーだけ
	型	string ASCII
	出現回数	rulesetの数分(それぞれに対して0または1)
name	説明	ルールセットの名前
	型	string UTF-8
	出現回数	rulesetの数分(それぞれに対して0または1)
numOfMaxSegment	説明	最大セグメント数
	型	int
	出現回数	rulesetの数分(それぞれに対して0または1)
numOfMaxVm	説明	最大VM数
	型	int
	出現回数	rulesetの数分(それぞれに対して0または1)
rulesetCategory	説明	ルールセットの種別
	型	string ASCII
	出現回数	rulesetの数分(それぞれに対して0または1)
type	説明	ネットワークデバイスのタイプ。以下の値となります。 ・SLB：サーバロードバランサー
	型	string ASCII
	出現回数	rulesetの数分(それぞれに対して0または1)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListSLBRulesetResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <rulesets>
    <ruleset>
      <description>SLB server1</description>
      <lplatformModel>SLB only</lplatformModel>
      <name>slb_config1</name>
      <numOfMaxSegment>5</numOfMaxSegment>
      <numOfMaxVm>15</numOfMaxVm>
      <rulesetCategory>config</rulesetCategory>
      <type>SLB</type>
    </ruleset>
    <ruleset>
      <description>SLB server2</description>
      <lplatformModel>Firewall+SLB</lplatformModel>
      <name>slb_config2a</name>
      <numOfMaxSegment>5</numOfMaxSegment>
      <numOfMaxVm>15</numOfMaxVm>
      <rulesetCategory>config</rulesetCategory>
      <type>SLB</type>
    </ruleset>
  </rulesets>
</ListSLBRulesetResponse>