FW+LB情報取得

API情報

API種別 メソッド URI 対象 名称 実行
契約、設定 GET /:GisServiceCode/fw-lbs/:IflServiceCode.json FW+LB FW+LB情報取得 同期

リクエストパラメータ

  パラメータ 必須 意味
URL GisServiceCode P2契約のサービスコード gis########
  IflServiceCode FW+LB 専有タイプのサービスコード ifl########

レスポンス

フィールド タイプ 意味
Label String ラベル 文字列
ContractStatus String 契約状態  
StartDate String 利用開始日 YYYYMMDD
StopDate String 解約予定日 YYYYMMDD
Type String FW+LB 専有タイプ品目  
Redundant String 冗長構成有無 "Yes" "No"
ResourceStatus String FW+LB 専有タイプステータス  
External.NetworkType String ネットワーク種別  
External.ServiceCode String ネットワーク種別がPrivateの場合のみ、サービスコード ivl########
Internal.NetworkType String ネットワーク種別  
Internal.ServiceCode String ネットワーク種別がPrivateの場合のみ、サービスコード ivl########
Internal.TrafficIpAddress String トラフィックIPアドレス IPアドレス
HostList.Master String マスターならばYes, スレーブならばNo "Yes" "No"
HostList.External.IPv4Address String ExternalインターフェイスのIPv4アドレス IPv4アドレス
HostList.External.IPv6Address String ExternalインターフェイスのIPv6アドレス IPv6アドレス
HostList.Internal.IPv4Address String InternalインターフェイスのIPv4アドレス IPv4アドレス
HostList.ServiceInfrastractureVersion String サービス提供基盤のバージョン 文字列
HostList.ResourceStatus String FW+LB 専有タイプステータス  
HostList.RestartRequired Array 実ホストの再起動が必要な場合に出力 オブジェクトの配列
HostList.RestartRequired.DueDate String 再起動実施期限 YYYYMMDD
HostList.RestartRequired.Reason String 再起動が必要な理由 文字列
HostList.LbSoftwareVersion String LBソフトウェアバージョン 例: "9.9"
HostList.LbAdministrationServerUrl String LB管理サーバURL 例: https://lbcNNNNN.lb.pub.p2.iijgio.jp
HostList.LbLatestSoftwareVersion String 利用可能なLBソフトウェアの最新バージョン 例: 10.4
HostList.LbApiEndpointUrl String LB用APIのエンドポイントURL 例: https://lbcXXXXXXXX-api.lb.pub.p2.iijgio.jp/api/tm/3.3
HostList.LbApiVersion String LB用APIのバージョン 例: "9.9"
Lb.TrafficIpList Array トラフィックIPアドレス オブジェクトの配列
TrafficIpList.IPv4.TrafficIpName String トラフィックIP名 文字列
TrafficIpList.IPv4.TrafficIpAddress String トラフィックIPv4アドレス IPv4アドレス
TrafficIpList.IPv4.DomainName String 逆引きドメイン名。ネットワーク種別がGlobalに限る 文字列
TrafficIpList.IPv6.TrafficIpName String トラフィックIP名 文字列
TrafficIpList.IPv6.TrafficIpAddress String トラフィックIPv6アドレス IPv6アドレス
TrafficIpList.IPv6.DomainName String 逆引きドメイン名。ネットワーク種別がGlobalに限る 文字列
Lb.AdministrationServerAllowNetworkList Array 管理画面へのアクセスを許可するIPアドレス IPアドレスの配列
SnatRuleList Array SNATルールの一覧 オブジェクトの配列
SnatRuleList.SourceIpAddress String 変換元IPアドレス IPv4アドレス
SnatRuleList.ToSourceIpAddress String 変換先IPアドレス IPアドレス
StaticRouteList Array スタティックルートの一覧 オブジェクトの配列
StaticRouteList.StaticRouteId String スタティックルートID 数字
StaticRouteList.Destination String 設定した宛先ネットワークアドレス IPv4アドレス/マスク長
StaticRouteList.Gateway String 設定したゲートウェイアドレス IPv4アドレス
StaticRouteList.ServiceCode String 設定したインターフェイス ivl########

エラーコード

制限

サンプル

リクエストボディ

無し

レスポンス (JSON)

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"
        }
    ]
}