ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.1 リファレンスガイド (API編)
ServerView
第2章 L-Platform APIリファレンス > 2.1 L-Platformテンプレートの操作 > 2.1.10 GetRulesetConfiguration (ルールセットの構成情報を取得)
前次

2.1.10 GetRulesetConfiguration (ルールセットの構成情報を取得)

ルールセットの構成情報を取得します。

ファイアーウォールとサーバロードバランサーのどちらのルールセットでも実行できます。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

rulesetName

説明

ルールセット名

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetRulesetConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <ruleset>
    <name>[ルールセット名]</name>
    <type>[ネットワークデバイスのタイプ]</type>
    <rulesetCategory>[ルールセットの種別]</rulesetCategory>
    <lplatformModel>[L-Platformのモデル]</lplatformModel>
    <numOfMaxSegment>[最大セグメント数]</numOfMaxSegment>
    <numOfMaxVm>[最大VM数]</numOfMaxVm>
    <description>[ルールセットの説明]</description>
    <desigintype>[UIのタイプ]</desigintype>
    <parameters>
      <parameter>
        <name>[パラメーター名]</name>
        <view>[パラメーター表示の有無]</view>
        <value>[パラメーターの値]</value>
        <summary>[パラメーターの概要]</summary>
        <description>[パラメーターの説明]</description>
        <syntax>[パラメーターの書式]</syntax>
        <required>[パラメーターの値が指定必須かどうかを指定]</required>
      </parameter>
    </parameters>
    <parametergroups>
      <parametergroup>
         <name>[パラメーターグループの名前]</name>
         <id>[パラメーターグループのID]</id>
         <parameters>
           <parameter>
             <name>[パラメーター名]</name>
             <view>[パラメーター表示の有無]</view>
             <value>[パラメーターの値]</value>
             <summary>[パラメーターの概要]</summary>
             <description>[パラメーターの説明]</description>
             <syntax>[パラメーターの書式]</syntax>
             <required>[パラメーターの値が指定必須かどうかを指定]</required>
           </parameter>
       </parameters>
      </parametergroup>
    </parametergroups>
  </ruleset>
  <interfaces>
    <interface>
      <name>[インターフェース名]</name>
      <segmentType>[セグメント識別情報]</segmentType>
    </interface>
  </interfaces>
  <configurations>
    <deviceModel>[ネットワークデバイスのモデル]</deviceModel>
    <maxAccessRuleSetting>[ルールセットで扱うことができるアクセスルールの最大設定数]</maxAccessRuleSetting>
    <maxProvision>[ルールセットによってネットワークデバイスへ配備できるファイアーウォールの最大数]</maxProvision>
  </configurations>
</GetRulesetConfigurationResponse>

《要素》

要素名

項目

項目説明

GetRulesetConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

ruleset

説明

ルールセットの情報の一式

型

なし

出現回数

0または1

name

説明

ルールセットの名前

型

string UTF-8

出現回数

0または1

type

説明

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

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

型

string ASCII

出現回数

0または1

rulesetCategory

説明

ルールセットの種別。以下のどちらかとなります。

・"config"：設定用のルールセット
・"operation"：運用操作用のルールセット

型

string ASCII

出現回数

0または1

lplatformModel

説明

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

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

型

string ASCII

出現回数

0または1

numOfMaxSegment

説明

最大セグメント数

型

int

出現回数

0または1

numOfMaxVm

説明

最大VM数

型

int

出現回数

0または1

description

説明

ルールセットの説明

型

string UTF-8

出現回数

0または1

desingtype

説明

UIのタイプ。以下のどちらかを指定します。
・UserCustomize: ユーザーカスタマイズ
・Simple: 簡単設定

型

string ASCII

出現回数

0または1

parameters

説明

パラメーター情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

parameter

説明

パラメーター情報の一式

型

なし

出現回数

0以上

name

説明

パラメーター名

型

string UTF-8

出現回数

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

view

説明

パラメーター表示の有無

型

string ASCII

出現回数

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

value

説明

パラメーターの値

型

string ASCII

出現回数

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

required

説明

パラメーターの値が指定必須かどうかを指定します。
以下のどちらかを指定します。

・true : 必須
・false : 任意

型

string ASCII

出現回数

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

summary

説明

パラメーターの概要

型

string UTF-8

出現回数

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

description

説明

パラメーターの説明

型

string UTF-8

出現回数

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

syntax

説明

パラメーターの書式

型

string ASCII

出現回数

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

parametergroups

説明

パラメーターグループ情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

parametergroup

説明

パラメーターグループ情報の一式

型

なし

出現回数

0以上

name

説明

パラメーターグループの名前

型

string UTF-8

出現回数

0または1

id

説明

パラメーターグループのID

型

string UTF-8

出現回数

0または1

parameters

説明

パラメーター情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

parameter

説明

パラメーター情報の一式

型

なし

出現回数

0以上

name

説明

パラメーターの名前

型

string UTF-8

出現回数

0または1

view

説明

パラメーターの表示の有無

型

string ASCII

出現回数

0または1

required

説明

パラメーターの値が指定必須かどうかを指定します。
以下のどちらかを指定します。
・true : 必須
・false : 任意

型

string ASCII

出現回数

0または1

summary

説明

パラメーターの概要

型

string UTF-8

出現回数

0または1

description

説明

パラメーターの説明

型

string UTF-8

出現回数

0または1

symtax

説明

パラメーターの書式

型

string ASCII

出現回数

0または1

interfaces

説明

インターフェース情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

interface

説明

インターフェース情報の一式

型

なし

出現回数

0以上

name

説明

インターフェース名

型

string UTF-8

出現回数

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

segmentType

説明

セグメント識別情報

型

string ASCII

出現回数

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

configurations

説明

デバイス定義情報
ユーザーインターフェースのタイプが"簡単設定"の場合にだけ表示されます。

型

なし

出現回数

0または1

deviceModel

説明

ネットワークデバイスのモデル

型

string ASCII

出現回数

0または1

maxAccessRuleSetting

説明

ルールセットで扱うことのできるアクセスルールの最大設定数

型

int

出現回数

0または1

maxProvision

説明

ルールセットによってネットワークデバイスへ配備できるファイアーウォールの最大数

型

int

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetRulesetConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>SUCCESS</responseMessage>
  <responseStatus>PAPI00000</responseStatus>
  <ruleset>
    <desigintype>UserCustomize</desigintype>
    <name>Firewall1</name>
    <type>Firewall</type>
    <rulesetCategory>config</rulesetCategory>
    <lplatformModel>Firewall only</lplatformModel>
    <numOfMaxSegment>10</numOfMaxSegment>
    <numOfMaxVm>3</numOfMaxVm>
    <description>SLB server1</description>
    <parameters>
      <parameter>
        <name>param_var_001</name>
        <view>true</view>
        <value>400</value>
        <summary>パラメタ1の概要</summary>
        <description>パラメタ1の詳細説明（日本語）</description>
        <syntax>INTEGER(0..65535)</syntax>
        <required>true</required>
      </parameter>
      <parameter>
        <name>param_var_002</name>
        <view>true</view>
        <value>200</value>
        <summary>パラメタ2の概要</summary>
        <description>パラメタ2の詳細説明（日本語）</description>
        <syntax>INTEGER(0..255)</syntax>
        <required>true</required>
      </parameter>
    </parameters>
  </ruleset>
  <interfaces>
    <interface>
      <name>interface1</name>
      <segmentType>SECURE</segmentType>
    </interface>
    <interface>
      <name>interface2</name>
      <segmentType>DMZ</segmentType>
    </interface>
  </interfaces>
</GetRulesetConfigurationResponse>

前次
Copyright 2011-2013 FUJITSU LIMITED