FW+LB情報一覧取得

API情報
API種別メソッドURI対象名称実行
契約、設定GET/:GisServiceCode/fw-lbs.json?StartIndex=N&Count=MFW+LBFW+LB情報一覧取得同期
  • 指定したP2契約GisServiceCodeに所属するFW+LBの情報一覧を取得します


リクエストパラメータ

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


制限
  • 特になし


サンプル

リクエストボディ

無し

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "FwLbList": [
        {
            "ServiceCode": "ifl#######1",
            (略)FW+LB情報取得と同じ
        },
        {
            "ServiceCode": "ifl#######2",
            (略)FW+LB情報取得と同じ
        },
        {
            "ServiceCode": "ifl#######3",
            (略)FW+LB情報取得と同じ
        }
    ]
}