DescribeFw

API情報

API種別 Action 対象 名称 実行
設定 DescribeFw FW/LB FW情報取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象FW+LBオプションを含むgpサービスコード
GlServiceCode 対象FW+LBオプションのglサービスコード

レスポンス

フィールド タイプ 意味
DescribeFwResponse.GlServiceCode String 対象FW+LBオプションのglサービスコード
DescribeFwResponse.Label String 対象FW+LBオプションのラベル
DescribeFwResponse.Type String 対象FW+LBオプションの品目 (ロードバランサの性能表記)
DescribeFwResponse.Redundant String

対象FW+LBオプションが冗長構成かどうか

値: Yes, No

DescribeFwResponse.FilteringRuleList.In Object FW INルール
DescribeFwResponse.FilteringRuleList.In.IPv4List Array FW INルール (IPv4) のリスト
DescribeFwResponse.FilteringRuleList.In.IPv4List.Source.IpAddress String 送信元IPv4アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.In.IPv4List.Destination.IpAddress String 送信先IPv4アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.In.IPv4List.Destination.Protocol String

送信先プロトコル

値: UDP, TCP

DescribeFwResponse.FilteringRuleList.In.IPv4List.Destination.Port String 送信先ポート番号
DescribeFwResponse.FilteringRuleList.In.IPv4List.Target String

動作

値: ACCEPT, DROP, REJECT

DescribeFwResponse.FilteringRuleList.In.IPv6List Array FW INルール (IPv6) のリスト
DescribeFwResponse.FilteringRuleList.In.IPv6List.Source.IpAddress String 送信元IPv6アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.In.IPv6List.Destination.IpAddress String 送信先IPv6アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.In.IPv6List.Destination.Protocol String

送信先プロトコル

値: UDP, TCP

DescribeFwResponse.FilteringRuleList.In.IPv6List.Destination.Port String 送信先ポート番号
DescribeFwResponse.FilteringRuleList.In.IPv6List.Target String

動作

値: ACCEPT, DROP, REJECT

DescribeFwResponse.FilteringRuleList.Out Object FW OUTルール
DescribeFwResponse.FilteringRuleList.Out.IPv4List Array FW OUTルール (IPv4) のリスト
DescribeFwResponse.FilteringRuleList.Out.IPv4List.Source.IpAddress String 送信元IPv4アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.Out.IPv4List.Destination.IpAddress String 送信先IPv4アドレス/ネットマスク
DescribeFwResponse.FilteringRuleList.Out.IPv4List.Destination.Protocol String

送信先プロトコル

値: UDP, TCP

DescribeFwResponse.FilteringRuleList.Out.IPv4List.Destination.Port String 送信先ポート番号
DescribeFwResponse.FilteringRuleList.Out.IPv4List.Target String

動作

値: ACCEPT, DROP, REJECT

エラーコード

制限

サンプル

リクエスト

※実際には一行で現します
https://gp.api.iij.jp/json
    ?APIVersion=20130901
    &AccessKeyId=XXXXXXXXXXXXXXXXXXXX
    &Action=DescribeFw
    &Expire=2013-09-01T10%3A10%3A30Z
    &GlServiceCode=gl########
    &GpServiceCode=gp########
    &SignatureMethod=HmacSHA256
    &SignatureVersion=2
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

レスポンス (JSON)

Json
{
    "DescribeFwResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Label": "XXXXX",
        "Type": "S100M",
        "Redundant": "Yes",
        "FilteringRuleList": {
            "In": {
                "IPv4List": [
                    {
                        "Source": {
                            "IpAddress": "ANY"
                        },
                        "Destination": {
                            "IpAddress": "ANY",
                            "Protocol": "TCP",
                            "Port": "80"
                        },
                        "Target": "ACCEPT"
                    },
                    {
                        "Source": {
                            "IpAddress": "ANY"
                        },
                        "Destination": {
                            "IpAddress": "ANY",
                            "Protocol": "TCP",
                            "Port": "443"
                        },
                        "Target": "ACCEPT"
                    }
                ],
                "IPv6List": [
                    {
                        "Source": {
                            "IpAddress": "ANY"
                        },
                        "Destination": {
                            "IpAddress": "ANY",
                            "Protocol": "TCP",
                            "Port": "80"
                        },
                        "Target": "ACCEPT"
                    }
                ]
            },
            "Out": {
                "IPv4List": [
                    {
                        "Source": {
                            "IpAddress": "ANY"
                        },
                        "Destination": {
                            "IpAddress": "ANY",
                            "Protocol": "TCP",
                            "Port": "80"
                        },
                        "Target": "ACCEPT"
                    }
                ]
            }
        }
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<DescribeFwResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Label>XXXXX</Label>
  <Type>S100M</Type>
  <Redundant>Yes</Redundant>
  <FilteringRuleList>
    <In>
      <IPv4List>
        <IPv4>
          <Source>
            <IpAddress>ANY</IpAddress>
          </Source>
          <Destination>
            <IpAddress>ANY</IpAddress>
            <Protocol>TCP</Protocol>
            <Port>80</Port>
          </Destination>
          <Target>ACCEPT</Target>
        </IPv4>
        <IPv4>
          <Source>
            <IpAddress>ANY</IpAddress>
          </Source>
          <Destination>
            <IpAddress>ANY</IpAddress>
            <Protocol>TCP</Protocol>
            <Port>443</Port>
          </Destination>
          <Target>ACCEPT</Target>
        </IPv4>
      </IPv4List>
      <IPv6List>
        <IPv6>
          <Source>
            <IpAddress>ANY</IpAddress>
          </Source>
          <Destination>
            <IpAddress>ANY</IpAddress>
            <Protocol>TCP</Protocol>
            <Port>80</Port>
          </Destination>
          <Target>ACCEPT</Target>
        </IPv6>
      </IPv6List>
    </In>
    <Out>
      <IPv4List>
        <IPv4>
          <Source>
            <IpAddress>ANY</IpAddress>
          </Source>
          <Destination>
            <IpAddress>ANY</IpAddress>
            <Protocol>TCP</Protocol>
            <Port>80</Port>
          </Destination>
          <Target>ACCEPT</Target>
        </IPv4>
      </IPv4List>
    </Out>
  </FilteringRuleList>
</DescribeFwResponse>