ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView

2.1.8 ListFirewallRuleset (ファイアーウォールのルールセットの一覧を取得)

ファイアーウォールのルールセットの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。"ListFirewallRuleset"を指定してください。

userId

説明

L-Platform APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

ListFirewallRulesetResponse

説明

レスポンスの情報を持つ要素

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧(L-Platform API)」を参照してください。

string ASCII

出現回数

1

rulesets

説明

ファイアーウォールのルールセット一覧のレスポンス情報を持つ要素

なし

出現回数

0または1

ruleset

説明

ファイアーウォールのルールセット情報の一式

なし

出現回数

0以上

name

説明

ルールセットの名前

string UTF-8

出現回数

rulesetの数分(それぞれに対して0または1)

type

説明

ネットワークデバイスのタイプ。以下の値となります。

"Firewall":ファイアーウォール

string ASCII

出現回数

rulesetの数分(それぞれに対して0または1)

rulesetCategory

説明

ルールセットの種別

string ASCII

出現回数

rulesetの数分(それぞれに対して0または1)

numOfMaxSegment

説明

最大セグメント数

int

出現回数

rulesetの数分(それぞれに対して0または1)

numOfMaxVm

説明

最大VM数

int

出現回数

rulesetの数分(それぞれに対して0または1)

description

説明

ルールセットの説明

string UTF-8

出現回数

rulesetの数分(それぞれに対して0または1)

lplatformModel

説明

L-Platformのモデル。以下のどちらかとなります。

・"Firewall+SLB":ファイアーウォールとサーバロードバランサー

・"Firewall only":ファイアーウォールだけ

string ASCII

出現回数

rulesetの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListFirewallRulesetResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <rulesets>
    <ruleset>
      <name>Firewall1</name>
      <type>Firewall</type>
      <rulesetCategory>config</rulesetCategory>
      <numOfMaxSegment>3</numOfMaxSegment>
      <numOfMaxVm>5</numOfMaxVm>
      <description>3 Tier firewall system</description>
      <lplatformModel>Firewall only</lplatformModel>
    </ruleset>
    <ruleset>
      <name>Firewall2</name>
      <type>Firewall</type>
      <rulesetCategory>config</rulesetCategory>
      <numOfMaxSegment>3</numOfMaxSegment>
      <numOfMaxVm>10</numOfMaxVm>
      <description>3 Tier firewall and SLB system</description>
      <lplatformModel>Firewall+SLB</lplatformModel>
    </ruleset>
  </rulesets>
</ListFirewallRulesetResponse>