FW+LB追加申込

API情報
API種別メソッドURI対象名称実行
契約POST/:GisServiceCode/fw-lbs.jsonFW+LBFW+LB追加申込非同期
  • FW+LBを新規に申し込みます
  • APIのレスポンスはFW+LBが利用可能な状態になることを待つことなく戻ります。準備中は契約状態(ContractStatus)がInPreparationとなり、完了するとInServiceになります
  • InPreparationの間のステータス(ResourceStatus)はSettingUpとなり、InServiceとなったときにInitializedになります
  • Initializedの後にセットアップを実行し、FW+LBにネットワークを接続する必要があります

リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
ボディTypeFW+LB 専有タイプ品目 
 Redundant冗長構成有無"Yes" "No"
レスポンス
フィールドタイプ意味
ServiceCodeStringFW+LB 専有タイプのサービスコードifl########
LabelStringラベル文字列
ContractStatusString契約状態 
StartDateString利用開始日YYYYMMDD
StopDateString解約予定日YYYYMMDD
TypeStringFW+LB 専有タイプ品目 
RedundantString冗長構成有無"Yes" "No"
ResourceStatusStringFW+LB 専有タイプステータス 
ExternalObjectExternalインターフェイスオブジェクト。追加直後は空
InternalObjectInternalインターフェイスオブジェクト。追加直後は空
HostListStringFW+LBを構成するホストのリスト
HostList.MasterStringマスターならばYes, スレーブならばNo"Yes" "No"
HostList.ExternalObjectホストのExternalインターフェイス情報オブジェクト。追加直後は空
HostList.InternalObjectホストのInternalインターフェイス情報オブジェクト。追加直後は空
HostList.ServiceInfrastructureVersionStringサービス提供基盤のバージョン文字列
HostList.ResourceStatusStringFW+LB 専有タイプステータス 
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アドレス(ポートをリッスンするアドレス)オブジェクトの配列。追加直後は空
Lb.AdministrationServerAllowNetworkListArray管理画面へのアクセスを許可するIPアドレスIPアドレスの配列。追加直後は空
SnatRuleListArraySNATルールの一覧追加申し込み時は常に空配列
StaticRouteListArrayスタティックルートの一覧追加申し込み時は常に空配列
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

{
    "Type": "D10M",
    "Redundant": "Yes"
}

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "ServiceCode": "ifl#######1",
    "Label": "",
    "ContractStatus": "InPreparation",
    "StartDate": "",
    "StopDate": "",
    "Type": "D10M",
    "Redundant": "Yes",
    "ResourceStatus": "SettingUp",
    "External": {},
    "Internal": {},
    "HostList": [
        {
            "Master": "Yes",
            "External": {},
            "Internal": {},
            "ServiceInfrastructureVersion": "",
            "ResourceStatus": "Stopped",
            "LbSoftwareVersion": "",
            "LbLatestSoftwareVersion": "",
            "LbAdministrationServerUrl": "",
            "LbApiEndpointUrl": "",
            "LbApiVersion": ""
        },
        {
            "Master": "No",
            "External": {},
            "Internal": {},
            "ServiceInfrastructureVersion": "",
            "ResourceStatus": "Stopped",
            "LbSoftwareVersion": "",
            "LbLatestSoftwareVersion": "",
            "LbAdministrationServerUrl": "",
            "LbApiEndpointUrl": "",
            "LbApiVersion": ""
        }
    ],
    "Lb": {
        "TrafficIpList": [],
        "AdministrationServerAllowNetworkList": []
    },
    "SnatRuleList": [],
    "StaticRouteList": []
}