API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
設定 |
PUT |
/:GisServiceCode/best-effort-fw-lbs/:IlbServiceCode/action.json |
FW+LBベストエフォートタイプ |
FW+LBベストエフォートタイプセットアップ |
非同期 |
- 指定したFW+LB ベストエフォートタイプのセットアップを行います
- FW+LB ベストエフォートタイプを利用するには、まずセットアップを実行して、指定したネットワークにFW+LBを接続する必要があります
- FW+LB ベストエフォートタイプにはネットワークインターフェイスが2つ用意されており、それぞれExternalとInternalと呼びます
- Externalはリクエストを受け付ける(リッスンする)インターフェイス、Internalはノードとの通信に利用するインターフェイスです
- Externalにはグローバルネットワークのみ接続できます
- Internalには標準プライベートネットワークまたはプライベートネットワーク/Vを接続することができます
- 一度セットアップを終えたFW+LB ベストエフォートタイプは、再びセットアップすることができません。接続したいネットワークを変更するには、別途FW+LB ベストエフォートタイプを追加してください
- このAPIのレスポンスはセットアップの完了を待つことなく戻ります。セットアップ中はステータスがConfiguringとなり、完了するとConfiguredになります
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
|
IlbServiceCode |
○ |
FW+LB ベストエフォートタイプのサービスコード |
ilb######## |
ボディ |
ActionType |
○ |
操作内容 |
"Setup" |
|
External |
○ |
Externalインターフェイスの設定 |
オブジェクト |
|
External.NetworkType |
○ |
ネットワーク種別
|
|
|
External.TrafficIpName |
○ |
TrafficIp名称 |
文字列 |
|
Internal |
○ |
Internalインターフェイスの設定 |
オブジェクト |
|
Internal.NetworkType |
○ |
ネットワーク種別
|
|
|
Internal.ServiceCode |
|
プライベートネットワーク/Vのサービスコード |
ivl######## |
|
Internal.TrafficIpAddress |
|
配下の仮想サーバからみた時にゲートウェイになるアドレス |
IPv4アドレス |
|
Internal.MasterHostAddress |
|
マスターのホストアドレス |
IPv4アドレス |
|
Internal.SlaveHostAddress |
|
スレーブのホストアドレス |
IPv4アドレス |
|
Internal.Netmask |
|
ネットマスク |
数字 |
レスポンス
フィールド |
タイプ |
意味 |
値 |
Current |
Object |
セットアップ後の状態 |
オブジェクト |
Current.ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
Current.HostList |
Array |
FW+LBを構成するホストの状態 |
オブジェクトの配列 |
Current.HostList.Master |
String |
マスターならばYes, スレーブならばNo |
"Yes" "No" |
Current.HostList.ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
Previous |
Object |
セットアップ前の状態 |
オブジェクト |
Previous.ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
Previous.HostList |
Array |
FW+LBを構成するホストの状態 |
オブジェクトの配列 |
Previous.HostList.Master |
String |
マスターならばYes, スレーブならばNo |
"Yes" "No" |
Previous.HostList.ResourceStatus |
String |
FW+LB ベストエフォートタイプステータス
|
|
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
# グローバル、プライベート標準
{
"ActionType": "Setup",
"External": {
"NetworkType": "Global",
"TrafficIpName": "TrafficIpName1"
},
"Internal": {
"NetworkType": "PrivateStandard"
}
}
# グローバル、プライベート
{
"ActionType": "Setup",
"External": {
"NetworkType": "Global",
"TrafficIpName": "TrafficIpName2"
},
"Internal": {
"NetworkType": "Private",
"ServiceCode": "ivl#######1",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
}
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"Current": {
"ResourceStatus": "Configuring",
"HostList": [
{
"Master": "Yes",
"ResourceStatus": "Starting"
},
{
"Master": "No",
"ResourceStatus": "Starting"
}
]
},
"Previous": {
"ResourceStatus": "Initialized",
"HostList": [
{
"Master": "Yes",
"ResourceStatus": "Stopped"
},
{
"Master": "No",
"ResourceStatus": "Stopped"
}
]
}
}