FW+LBベストエフォートタイプ情報一覧取得

API情報
API種別メソッドURI対象名称実行
契約、設定GET/:GisServiceCode/best-effort-fw-lbs.json?StartIndex=N&Count=MFW+LBベストエフォートタイプFW+LBベストエフォートタイプ情報一覧取得同期
  • 指定されたP2契約に所属するFW+LB ベストエフォートタイプの情報一覧を取得します


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
クエリストリングStartIndex
StartIndexだけスキップした位置から情報を取得する数値

Count
取得する情報の最大数数値
レスポンス
フィールドタイプ意味

BestEffortFwLbList

ArrayFW+LB ベストエフォートタイプ情報の一覧オブジェクトの配列

BestEffortFwLbList.ServiceCode

StringFW+LB ベストエフォートタイプのサービスコードilb########

BestEffortFwLbList.Label

Stringラベル文字列

BestEffortFwLbList.ContractStatus

String 契約状態

BestEffortFwLbList.StartDate

String利用開始日YYYYMMDD

BestEffortFwLbList.StopDate

String解約予定日YYYYMMDD

BestEffortFwLbList.Type

StringFW+LB ベストエフォートタイプ品目  

BestEffortFwLbList.Redundant

String冗長構成有無"Yes"

BestEffortFwLbList.ResourceStatus

StringFW+LB ベストエフォートタイプステータス

BestEffortFwLbList.External

ObjectExternalインターフェイス情報オブジェクト

BestEffortFwLbList.External.NetworkType

Stringネットワーク種別"Global"

BestEffortFwLbList.Internal

ObjectInternalインターフェイス情報オブジェクト

BestEffortFwLbList.Internal.NetworkType

String ネットワーク種別 "PrivateStandard" "Private"

BestEffortFwLbList.Internal.TrafficIpAddress

String配下の仮想サーバからみた時にゲートウェイになるアドレスIPv4アドレス

BestEffortFwLbList.Internal.ServiceCode

Stringネットワーク種別がPrivateの場合のみプラベートネットワーク/Vのサービスコードivl########

BestEffortFwLbList.HostList

ArrayFW+LBを構成するホストのリストオブジェクトの配列

BestEffortFwLbList.HostList.Master

StringマスターならばYes, スレーブならばNo"Yes" "No"

BestEffortFwLbList.HostList.External

ObjectホストのExternalインターフェイス情報オブジェクト

BestEffortFwLbList.HostList.External.IPv4Address

StringIPv4アドレスIPv4アドレス

BestEffortFwLbList.HostList.Internal

ObjectホストのInternalインターフェイス情報オブジェクト

BestEffortFwLbList.HostList.Internal.IPv4Address

StringIPv4アドレスIPv4アドレス
BestEffortFwLbList.HostList.ServiceInfrastractureVersionStringサービス提供基盤のバージョン文字列

BestEffortFwLbList.HostList.ResourceStatus

StringFW+LB ベストエフォートタイプステータス
BestEffortFwLbList.HostList.RestartRequiredArray実ホストの再起動が必要な場合に出力オブジェクトの配列
BestEffortFwLbList.HostList.RestartRequired.DueDateString再起動実施期限YYYYMMDD
BestEffortFwLbList.HostList.RestartRequired.ReasonString再起動が必要な理由文字列
BestEffortFwLbList.LbObjectロードバランス設定情報オブジェクト
BestEffortFwLbList.Lb.TrafficIpListArrayTrafficIp情報一覧オブジェクトの配列
BestEffortFwLbList.Lb.TrafficIpList.IPv4ObjectIPv4情報オブジェクト
BestEffortFwLbList.Lb.TrafficIpList.IPv4.TrafficIpNameStringTrafficIp IPv4の名前文字列
BestEffortFwLbList.Lb.TrafficIpList.IPv4.TrafficIpAddressStringTrafficIp IPv4アドレスIPv4アドレス
BestEffortFwLbList.Lb.TrafficIpList.IPv4.DomainNameString逆引きドメイン名文字列
BestEffortFwLbList.SnatRuleListArraySNATルールの一覧オブジェクトの配列
BestEffortFwLbList.SnatRuleList.SourceIpAddressString変換元IPアドレスIPv4アドレス
BestEffortFwLbList.SnatRuleList.ToSourceIpAddressString変換先IPアドレスIPv4アドレス
BestEffortFwLbList.StaticRouteList Arrayスタティックルートの一覧オブジェクトの配列
BestEffortFwLbList.StaticRouteList.StaticRouteIdStringスタティックルートID数字
BestEffortFwLbList.StaticRouteList.DestinationString宛先ネットワークアドレスIPv4アドレス/マスク長
BestEffortFwLbList.StaticRouteList.GatewayStringゲートウェイアドレスIPv4アドレス
BestEffortFwLbList.StaticRouteList.ServiceCodeStringインターフェイスivl########
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

無し

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "BestEffortFwLbList ": [
        {
            "ServiceCode": "ilb#######1",
            (略)FW+LB ベストエフォートタイプ情報取得と同じ
        },
        {
            "ServiceCode": "ilb#######2",
            (略)FW+LB ベストエフォートタイプ情報取得と同じ
        },
        {
            "ServiceCode": "ilb#######3",
            (略)FW+LB ベストエフォートタイプ情報取得と同じ
        }
    ]
}