ファイアウォール情報取得

API情報

API種別 メソッド URI 対象 名称 実行
契約、設定 GET /:GisServiceCode/firewalls/:IfwServiceCode/action.json ファイアウォール

ファイアウォール情報取得

 同期

リクエストパラメータ

  パラメータ 必須 意味 値
URL GisServiceCode ○ P2契約のサービスコード gis########
  IfwServiceCode ○ ファイアウォールのサービスコード ifw########

レスポンス

フィールド タイプ 意味 値
Label String ラベル 文字列
ContractStatus String 契約状態  
StartDate String 利用開始日 YYYYMMDD
StopDate String 解約予定日 YYYYMMDD
Type String ファイアウォール品目  
Redundant String 冗長構成有無 "Yes"
ResourceStatus String ファイアウォールステータス  
External Object Externalインターフェイス情報 オブジェクト
External.NetworkType String ネットワーク種別  
External.ServiceCode String プラベートネットワーク/V のサービスコード ivl########
External.ExternalVipList Array ExternalVip 情報一覧 オブジェクトの配列
External.ExternalVipList.IPv4 Object IPv4情報 オブジェクト
External.ExternalVipList.IPv4.ExternalVipName String ExternalVipの名前 文字列
External.ExternalVipList.IPv4.ExternalVipAddress String ExternalVip IPv4アドレス IPv4アドレス
External.ExternalVipList.IPv4.DomainName String 逆引きドメイン名 文字列
External.ExternalVipList.IPv6 Object IPv6情報 オブジェクト
External.ExternalVipList.IPv6.ExternalVipName String ExternalVipの名前 文字列
External.ExternalVipList.IPv6.ExternalVipAddress String ExternalVip IPv6アドレス IPv6アドレス
InternalList Array Internalインターフェイスの情報一覧 オブジェクトの配列
InternalList.NetworkType String ネットワーク種別 "PrivateStandard" "Private"
InternalList.ServiceCode String プラベートネットワーク/V のサービスコード ivl########
InternalList.InternalVipAddress String 配下の仮想サーバからみた時にゲートウェイになるアドレス IPv4アドレス
HostList Array 実ホスト情報 オブジェクトの配列
HostList.Master String マスターならばYes, スレーブならばNo "Yes", "No"
HostList.External Object ホストのExternalインターフェイス情報 オブジェクト
HostList.External.IPv4Address String IPv4アドレス IPv4アドレス
HostList.External.IPv6Address String IPv6アドレス IPv6アドレス
HostList.InternalList Array ホストのInternalインターフェイスの情報一覧 オブジェクトの配列
HostList.InternalList.ServiceCode String プラベートネットワーク/V のサービスコード ivl########
HostList.InternalList.IPv4Address String IPv4アドレス IPv4アドレス
HostList.ServiceInfrastractureVersion String サービス提供基盤のバージョン 文字列
HostList.ResourceStatus String ファイアウォールステータス  
HostList.RestartRequired Array 実ホストの再起動が必要な場合に出力 オブジェクトの配列
HostList.RestartRequired.DueDate String 再起動実施期限 YYYYMMDD
HostList.RestartRequired.Reason String 再起動が必要な理由 文字列
NatRuleList Array NATルールの一覧 オブジェクトの配列
NatRuleList.Id String NATルールを一意に識別するID 数字
NatRuleList.DestinationIpAddress String 変換元IPアドレス IPv4アドレス, IPv6アドレス
NatRuleList.ToDestinationIpAddress String 変換先IPアドレス IPv4アドレス
NatRuleList.ServiceCode String 変換先が接続されているネットワークのサービスコード ivl########
NaptRuleList Array NAPTルールの一覧 オブジェクトの配列
NaptRuleList.Id String NAPTルールを一意に識別するID 数字
NaptRuleList.SourceIpAddress String 変換元ネットワークアドレス IPv4アドレス/マスク長
NaptRuleList.ToSourceIpAddress String 変換先IPアドレス IPv4アドレス
StaticRouteList Array スタティックルートの一覧 オブジェクトの配列
StaticRouteList.StaticRouteId String スタティックルートID 数字
StaticRouteList.Destination String 宛先ネットワークアドレス IPv4アドレス/マスク長
StaticRouteList.Gateway String ゲートウェイアドレス IPv4アドレス
StaticRouteList.ServiceCode String ゲートウェイが接続されているネットワークのサービスコード ivl########
SyslogServer Object ログサーバの設定 オブジェクト
SyslogServer.Address String ログサーバのアドレス IPv4アドレス
SyslogServer.Protocol String 使用プロトコル "TCP", "UDP"
SyslogServer.Port String ログサーバのポート番号 数字

エラーコード

制限

サンプル

リクエストボディ 

無し

レスポンス (JSON)

Json
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "Label": "XXXXX",
    "ContractStatus": "InService",
    "StartDate": "YYYYMMDD",
    "StopDate": "",
    "Type": "FW100M",
    "Redundant": "Yes",
    "ResourceStatus": "Configured",
    "External": {
        "NetworkType": "Global",
        "ExternalVipList": [
            {
                "IPv4": {
                    "ExternalVipName": "EXTERNAL_VIP",
                    "ExternalVipAddress": "203.0.113.20",
                    "DomainName": "20.113.0.203.rev.iijgio.jp"
                },
                "IPv6": {
                    "ExternalVipName": "EXTERNAL_VIP_v6",
                    "ExternalVipAddress": "2001:0db8:0000:0000:0000:0000:000b:0020",
                }
            }
        ]
    },
    "InternalList": [
        {
            "NetworkType": "Private",
            "InternalVipAddress": "192.168.2.18",
            "ServiceCode": "ivl#######3"
        },
        {
            "NetworkType": "PrivateStandard",
            "InternalVipAddress": "10.203.0.10"
        }
    ],
    "HostList": [
        {
            "Master": "Yes",
            "External": {
                "IPv4Address": "203.0.113.31",
                "IPV6Address": "2001:0db8:0000:0000:0000:0000:000b:0031" # Globalの場合
            },
            "InternalList": [
                {
                    "IPv4Address": "192.168.2.31",
                    "ServiceCode": "ivl#######3"
                },
                {
                    "IPv4Address": "10.203.0.11"
                }
            ],
            "ServiceInfrastructureVersion": "##.##.##",
            "ResourceStatus": "Running",
            "RestartRequired": {
                "DueDate": "YYYYMMDD",
                "Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
            }
        },
        {
            "Master": "No",
            "External": {
                "IPv4Address": "203.0.113.32"
                "IPv6Address": "2001:0db8:0000:0000:0000:0000:000b:0032" # Globalの場合
            },
            "InternalList": [
                {
                    "IPv4Address": "192.168.2.32",
                    "ServiceCode": "ivl#######3"
                },
                {
                    "IPv4Address": "10.203.0.12"
                }
            ],
            "ServiceInfrastructureVersion": "##.##.##",
            "ResourceStatus": "Running",
            "RestartRequired": {
                "DueDate": "YYYYMMDD",
                "Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
            }
        }
    ],
    "NatRuleList": [
        {
            "Id": "1",
            "DestinationIpAddress": "203.0.113.20",
            "ToDestinationIpAddress": "192.168.2.110",
            "ServiceCode": "ivl#######3"
        },
        {
            "Id": "2",
            "DestinationIpAddress": "2001:db8::111",
            "ToDestinationIpAddress": "192.168.2.111",
            "ServiceCode": "ivl#######3"
        },
    ],
    "NaptRuleList": [
        {
            "Id": "1",
            "SourceIpAddress": "192.168.2.0/24",
            "ToSourceIpAddress": "203.0.113.20"
        }
    ],
    "StaticRouteList": [
        {
            "StaticRouteId": "27",
            "Destination": "10.10.10.0/24",
            "Gateway": "192.168.2.201",
            "ServiceCode": "ivl#######3"
        }
    ],
    "SyslogServer": {
        "Address": "192.168.2.222",
        "Protocol": "UDP",
        "Port": "514"
    }
}

親トピック: 11.ファイアウォール