API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
契約 |
POST |
/:GisServiceCode/fw-lbs.json |
FW+LB |
FW+LB追加申込 |
非同期 |
- FW+LBを新規に申し込みます
- APIのレスポンスはFW+LBが利用可能な状態になることを待つことなく戻ります。準備中は契約状態(ContractStatus)がInPreparationとなり、完了するとInServiceになります
- InPreparationの間のステータス(ResourceStatus)はSettingUpとなり、InServiceとなったときにInitializedになります
- Initializedの後にセットアップを実行し、FW+LBにネットワークを接続する必要があります
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
ボディ |
Type |
○ |
FW+LB 専有タイプ品目
|
|
|
Redundant |
○ |
冗長構成有無 |
"Yes" "No" |
レスポンス
フィールド |
タイプ |
意味 |
値 |
ServiceCode |
String |
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 |
Object |
Externalインターフェイス |
オブジェクト。追加直後は空 |
Internal |
Object |
Internalインターフェイス |
オブジェクト。追加直後は空 |
HostList |
String |
FW+LBを構成するホストのリスト |
|
HostList.Master |
String |
マスターならばYes, スレーブならばNo |
"Yes" "No" |
HostList.External |
Object |
ホストのExternalインターフェイス情報 |
オブジェクト。追加直後は空 |
HostList.Internal |
Object |
ホストのInternalインターフェイス情報 |
オブジェクト。追加直後は空 |
HostList.ServiceInfrastructureVersion |
String |
サービス提供基盤のバージョン |
文字列 |
HostList.ResourceStatus |
String |
FW+LB 専有タイプステータス
|
|
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アドレス(ポートをリッスンするアドレス) |
オブジェクトの配列。追加直後は空 |
Lb.AdministrationServerAllowNetworkList |
Array |
管理画面へのアクセスを許可するIPアドレス |
IPアドレスの配列。追加直後は空 |
SnatRuleList |
Array |
SNATルールの一覧 |
追加申し込み時は常に空配列 |
StaticRouteList |
Array |
スタティックルートの一覧 |
追加申し込み時は常に空配列 |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
{
"Type": "D10M",
"Redundant": "Yes"
}
レスポンス (JSON)
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": []
}