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

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

API情報

API種別	メソッド	URI	対象	名称	実行
契約、設定	GET	/:GisServiceCode/firewalls.json	ファイアウォール	ファイアウォール情報一覧取得	同期

ファイアウォールの詳細情報一覧を取得します

リクエストパラメータ

	パラメータ	必須	意味	値
URL	GisServiceCode	○	P2契約のサービスコード	gis########
クエリストリング	StartIndex		取得する情報の開始位置	数値
	Count		取得する情報の数	数値

レスポンス

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

エラーコード

このAPIに関する個別エラーはありません。
共通エラーコードはエラーレスポンスを参照して下さい

制限

特になし

サンプル

リクエストボディ

無し

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "FirewallList ": [
        {
            "ServiceCode": "ifw#######1",
            （略）ファイアウォール情報取得と同じ
        },
        {
            "ServiceCode": "ifw#######2",
            （略）ファイアウォール情報取得と同じ
        },
        {
            "ServiceCode": "ifw#######3",
            （略）ファイアウォール情報取得と同じ
        }
    ]
}