FW+LB情報取得

API情報
API種別メソッドURI対象名称実行
契約、設定GET/:GisServiceCode/fw-lbs/:IflServiceCode.jsonFW+LBFW+LB情報取得同期
  • 指定したFW+LB IflServiceCodeの詳細情報を取得します


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
 IflServiceCodeFW+LB 専有タイプのサービスコードifl########
レスポンス
フィールドタイプ意味
LabelStringラベル文字列
ContractStatusString契約状態 
StartDateString利用開始日YYYYMMDD
StopDateString解約予定日YYYYMMDD
TypeStringFW+LB 専有タイプ品目 
RedundantString冗長構成有無"Yes" "No"
ResourceStatusStringFW+LB 専有タイプステータス 
External.NetworkTypeStringネットワーク種別 
External.ServiceCodeStringネットワーク種別がPrivateの場合のみ、サービスコードivl########
Internal.NetworkTypeStringネットワーク種別 
Internal.ServiceCodeStringネットワーク種別がPrivateの場合のみ、サービスコードivl########
Internal.TrafficIpAddressStringトラフィックIPアドレスIPアドレス
HostList.MasterStringマスターならばYes, スレーブならばNo"Yes" "No"
HostList.External.IPv4AddressStringExternalインターフェイスのIPv4アドレスIPv4アドレス
HostList.External.IPv6AddressStringExternalインターフェイスのIPv6アドレスIPv6アドレス
HostList.Internal.IPv4AddressStringInternalインターフェイスのIPv4アドレスIPv4アドレス
HostList.ServiceInfrastractureVersionStringサービス提供基盤のバージョン文字列
HostList.ResourceStatusStringFW+LB 専有タイプステータス 
HostList.RestartRequiredArray実ホストの再起動が必要な場合に出力オブジェクトの配列
HostList.RestartRequired.DueDateString再起動実施期限YYYYMMDD
HostList.RestartRequired.ReasonString再起動が必要な理由文字列
HostList.LbSoftwareVersionStringLBソフトウェアバージョン例: "9.9"
HostList.LbAdministrationServerUrlStringLB管理サーバURL例: https://lbcNNNNN.lb.pub.p2.iijgio.jp
HostList.LbLatestSoftwareVersionString利用可能なLBソフトウェアの最新バージョン例: 10.4
HostList.LbApiEndpointUrlStringLB用APIのエンドポイントURL 例:  https://lbcXXXXXXXX-api.lb.pub.p2.iijgio.jp/api/tm/3.3
HostList.LbApiVersionStringLB用APIのバージョン例: "9.9"
Lb.TrafficIpListArrayトラフィックIPアドレスオブジェクトの配列
TrafficIpList.IPv4.TrafficIpNameStringトラフィックIP名文字列
TrafficIpList.IPv4.TrafficIpAddressStringトラフィックIPv4アドレスIPv4アドレス
TrafficIpList.IPv4.DomainNameString逆引きドメイン名。ネットワーク種別がGlobalに限る文字列
TrafficIpList.IPv6.TrafficIpNameStringトラフィックIP名文字列
TrafficIpList.IPv6.TrafficIpAddressStringトラフィックIPv6アドレスIPv6アドレス
TrafficIpList.IPv6.DomainNameString逆引きドメイン名。ネットワーク種別がGlobalに限る文字列
Lb.AdministrationServerAllowNetworkListArray管理画面へのアクセスを許可するIPアドレスIPアドレスの配列
SnatRuleListArraySNATルールの一覧オブジェクトの配列
SnatRuleList.SourceIpAddressString変換元IPアドレスIPv4アドレス
SnatRuleList.ToSourceIpAddressString変換先IPアドレスIPアドレス
StaticRouteListArrayスタティックルートの一覧オブジェクトの配列
StaticRouteList.StaticRouteIdStringスタティックルートID数字
StaticRouteList.DestinationString設定した宛先ネットワークアドレスIPv4アドレス/マスク長
StaticRouteList.GatewayString設定したゲートウェイアドレスIPv4アドレス
StaticRouteList.ServiceCodeString設定したインターフェイスivl########
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

無し

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "Label": "XXXXX",
    "ContractStatus": "InService",
    "StartDate": "YYYYMMDD",
    "StopDate": "",
    "Type": "D10M",
    "Redundant": "Yes",
    "ResourceStatus": "Configured",
    "External": {
        "NetworkType": "Global"
        ,"ServiceCode": "ivl#######3"  # Privateの場合
    },
    "Internal": {  # 一本足の場合は空
        "NetworkType": "Private",
        "TrafficIpAddress": "192.0.2.33"
        ,"ServiceCode": "ivl#######3"  # Privateの場合
    },
    "HostList": [
        {
            "Master": "Yes",
            "External": {
                "IPv4Address": "203.0.113.31"
                ,"IPv6Address": "2001:0db8:0000:0000:0000:0000:000b:0031"  # Globalの場合
            },
            "Internal": {  # 一本足の場合は空
                "IPv4Address": "192.0.2.31"
            },
            "ServiceInfrastructureVersion": "##.##.##",
            "ResourceStatus": "Running",
            "RestartRequired": {
                "DueDate": "YYYYMMDD",
                "Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
            },
            "LbSoftwareVersion": "9.0r3",
            "LbLatestSoftwareVersion": "10.4",
            "LbAdministrationServerUrl": "https://lbcXXXXXXXX.lb.gp.iijgio.jp",
            "LbApiEndpointUrl": "https://lbcXXXXXXXX-api.lb.pub.p2.iijgio.jp/api/tm/3.3",
            "LbApiVersion": "3.3"
        },
        {
            "Master": "No",
            "External": {
                "IPv4Address": "203.0.113.32"
                ,"IPv6Address": "2001:0db8:0000:0000:0000:0000:000b:0032" # Globalの場合
            },
            "Internal": {  # 一本足の場合は空
                "IPv4Address": "192.0.2.32"
            },
            "ServiceInfrastructureVersion": "##.##.##",
            "ResourceStatus": "Running",
            "RestartRequired": {
                "DueDate": "YYYYMMDD",
                "Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
            },
            "LbSoftwareVersion": "9.0r3",
            "LbLatestSoftwareVersion": "10.4",
            "LbAdministrationServerUrl": "https://lbcXXXXXXXX.lb.gp.iijgio.jp/",
            "LbApiEndpointUrl": "https://lbcXXXXXXXX-api.lb.pub.p2.iijgio.jp/api/tm/3.3",
            "LbApiVersion": "3.3"
        }
    ],
    "Lb": {
        "TrafficIpList": [
            {
                "IPv4": {
                    "TrafficIpName": "GIO_TRAFFIC_IP",
                    "TrafficIpAddress": "203.0.113.20"
                    ,"DomainName": "20.113.0.203.rev.iijgio.jp"  # Globalの場合
                }
                ,"IPv6": { # Globalの場合
                    "TrafficIpName": "GIO_TRAFFIC_IP6",
                    "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0001",
                    "DomainName": ""
                }
            },
            {
                "IPv4": {
                    "TrafficIpName": "GIO_TRAFFIC_IP",
                    "TrafficIpAddress": "203.0.113.21"
                    ,"DomainName": "21.113.0.203.rev.iijgio.jp"  # Globalの場合
                }
                ,"IPv6": { # Globalの場合
                    "TrafficIpName": "GIO_TRAFFIC_IP6",
                    "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0002",
                    "DomainName": ""
                }
            }
        ],
        "AdministrationServerAllowNetworkList": [
            "192.0.2.1",
            "192.0.2.2",
            "192.0.2.32/28"
        ]
    },
    "SnatRuleList": [
        {
            "SourceIpAddress": "192.0.2.111",
            "ToSourceIpAddress": "203.0.113.20"
        },
        {
            "SourceIpAddress": "192.0.2.112",
            "ToSourceIpAddress": "203.0.113.20"
        }
    ],
    "StaticRouteList": [
        {
            "StaticRouteId": "27",
            "Destination": "10.10.10.0/24",
            "Gateway": "192.0.2.201",
            "ServiceCode": "ivl#######3"
        }
    ]
}