API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
契約、設定 |
GET |
/:GisServiceCode/best-effort-fw-lbs/:IlbServiceCode.json |
FW+LBベストエフォートタイプ |
FW+LBベストエフォートタイプ情報取得 |
同期 |
- 指定したFW+LB ベストエフォートタイプの詳細情報を取得します
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
|
IlbServiceCode |
○ |
FW+LB ベストエフォートタイプのサービスコード |
ilb######## |
レスポンス
フィールド |
タイプ |
意味 |
値 |
Label |
String |
ラベル |
文字列 |
ContractStatus |
String |
契約状態
|
|
StartDate |
String |
利用開始日 |
YYYYMMDD |
StopDate |
String |
解約予定日 |
YYYYMMDD |
Type |
String |
FW+LB ベストエフォートタイプ品目
|
|
Redundant |
String |
冗長構成有無 |
"Yes" |
ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
External |
Object |
Externalインターフェイス情報 |
オブジェクト |
External.NetworkType |
String |
ネットワーク種別
|
"Global" |
Internal |
Object |
Internalインターフェイス情報 |
オブジェクト |
Internal.NetworkType |
String |
ネットワーク種別
|
"PrivateStandard" "Private" |
Internal.TrafficIpAddress |
String |
配下の仮想サーバからみた時にゲートウェイになるアドレス |
IPv4アドレス |
Internal.ServiceCode |
String |
ネットワーク種別がPrivateの場合のみプラベートネットワーク/Vのサービスコード |
ivl######## |
HostList |
Array |
実ホスト情報 |
オブジェクトの配列 |
HostList.Master |
String |
マスターならばYes, スレーブならばNo |
"Yes" "No" |
HostList.External |
Object |
ホストのExternalインターフェイス情報 |
オブジェクト |
HostList.External.IPv4Address |
String |
IPv4アドレス |
IPv4アドレス |
HostList.Internal |
Object |
ホストのInternalインターフェイス情報 |
オブジェクト |
HostList.Internal.IPv4Address |
String |
IPv4アドレス |
IPv4アドレス |
HostList.ServiceInfrastractureVersion |
String |
サービス提供基盤のバージョン |
文字列 |
HostList.ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
HostList.RestartRequired |
Array |
実ホストの再起動が必要な場合に出力 |
オブジェクトの配列 |
HostList.RestartRequired.DueDate |
String |
再起動実施期限 |
YYYYMMDD |
HostList.RestartRequired.Reason |
String |
再起動が必要な理由 |
文字列 |
Lb |
Object |
LBの設定情報 |
オブジェクト |
Lb.TrafficIpList |
Array |
TrafficIp情報一覧 |
オブジェクトの配列 |
Lb.TrafficIpList.IPv4 |
Object |
IPv4情報 |
オブジェクト |
Lb.TrafficIpList.IPv4.TrafficIpName |
String |
TrafficIp IPv4の名前 |
文字列 |
Lb.TrafficIpList.IPv4.TrafficIpAddress |
String |
TrafficIp IPv4アドレス |
IPv4アドレス |
Lb.TrafficIpList.IPv4.DomainName |
String |
逆引きドメイン名 |
文字列 |
SnatRuleList |
Array |
SNATルールの一覧 |
オブジェクトの配列 |
SnatRuleList.SourceIpAddress |
String |
変換元IPアドレス |
IPv4アドレス |
SnatRuleList.ToSourceIpAddress |
String |
変換先IPアドレス |
IPv4アドレス |
StaticRouteList |
Array |
スタティックルートの一覧 |
オブジェクトの配列 |
StaticRouteList.StaticRouteId |
String |
スタティックルートID |
数字 |
StaticRouteList.Destination |
String |
宛先ネットワークアドレス |
IPv4アドレス/マスク長 |
StaticRouteList.Gateway |
String |
ゲートウェイアドレス |
IPv4アドレス |
StaticRouteList.ServiceCode |
String |
インターフェイス |
ivl######## |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
無し
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Label": "XXXXX",
"ContractStatus": "InService",
"StartDate": "YYYYMMDD",
"StopDate": "",
"Type": "B1000M",
"Redundant": "Yes",
"ResourceStatus": "Configured",
"External": {
"NetworkType": "Global"
},
"Internal": {
"NetworkType": "Private",
"TrafficIpAddress": "192.168.2.18",
"ServiceCode": "ivl#######3" # Privateの場合
},
"HostList": [
{
"Master": "Yes",
"External": {
"IPv4Address": "203.0.113.31"
},
"Internal": {
"IPv4Address": "192.168.2.31"
},
"ServiceInfrastructureVersion": "##.##.##",
"ResourceStatus": "Running",
"RestartRequired": {
"DueDate": "YYYYMMDD",
"Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
}
},
{
"Master": "No",
"External": {
"IPv4Address": "203.0.113.32"
},
"Internal": {
"IPv4Address": "192.168.2.32"
},
"ServiceInfrastructureVersion": "##.##.##",
"ResourceStatus": "Running",
"RestartRequired": {
"DueDate": "YYYYMMDD",
"Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL"
}
}
],
"Lb": {
"TrafficIpList": [
{
"IPv4": {
"TrafficIpName": "GIO_TRAFFIC_IP",
"TrafficIpAddress": "203.0.113.20",
"DomainName": "20.113.0.203.rev.iijgio.jp"
}
}
]
},
"SnatRuleList": [
{
"SourceIpAddress": "192.168.2.111",
"ToSourceIpAddress": "203.0.113.20"
}
],
"StaticRouteList": [
{
"StaticRouteId": "27",
"Destination": "10.10.10.0/24",
"Gateway": "192.168.2.201",
"ServiceCode": "ivl#######3"
}
]
}