FW+LBセットアップ
API情報
| API種別 | メソッド | URI | 対象 | 名称 | 実行 |
|---|---|---|---|---|---|
| 設定 | PUT | /:GisServiceCode/fw-lbs/:IflServiceCode/action.json | FW+LB | FW+LBセットアップ | 非同期 |
- 指定したFW+LB IflServiceCodeのセットアップを行います
- FW+LBを利用するには、まずセットアップを実行して、指定したネットワークにFW+LBを接続する必要があります
- FW+LBにはネットワークインターフェイスが２つ用意されており、それぞれExternalとInternalと呼びます
- Externalはリクエストを受け付ける（リッスンする）インターフェイス、Internalはノードとの通信に利用するインターフェイスです
- Externalにはグローバルネットワークまたは標準プライベートネットワークまたはプライベートネットワーク/Vを接続できます
- Internalには標準プライベートネットワークまたはプライベートネットワーク/Vを接続することができます
- ExternalとInternalに同じネットワークを指定して、同一ネットワーク上でロードバランスすることも可能です
- 一度セットアップを終えたFW+LBは、再びセットアップすることができません。接続したいネットワークを変更するには、別途FW+LBを追加してください
- このAPIのレスポンスはセットアップの完了を待つことなく戻ります。セットアップ中はステータスがConfiguringとなり、完了するとConfiguredになります
リクエストパラメータ
| パラメータ | 必須 | 意味 | 値 | |
|---|---|---|---|---|
| URL | GisServiceCode | ○ | P2契約のサービスコード | gis######## |
| IflServiceCode | ○ | FW+LB 専有タイプのサービスコード | ifl######## | |
| ボディ | ActionType | ○ | "Setup" | リテラル |
| External.NetworkType | ○ | ネットワーク種別 | ||
| External.ServiceCode | プライベートネットワーク/Vのサービスコード | ivl######## | ||
| External.TrafficIpName | ○ | トラフィックIP名 | 文字列 | |
| External.TrafficIpAddress | トラフィックIPアドレス | IPv4アドレス | ||
| External.MasterHostAddress | マスターのホストアドレス | IPv4アドレス | ||
| External.SlaveHostAddress | スレーブのホストアドレス | IPv4アドレス | ||
| External.Netmask | ネットマスク | 数字 | ||
| Internal.NetworkType | ○ | ネットワーク種別 | ||
| Internal.ServiceCode | プライベートネットワーク/Vのサービスコード | ivl######## | ||
| Internal.TrafficIpName | トラフィックIP名 | 文字列 | ||
| Internal.TrafficIpAddress | トラフィックIPアドレス | IPv4アドレス | ||
| Internal.MasterHostAddress | マスターのホストアドレス | IPv4アドレス | ||
| Internal.SlaveHostAddress | スレーブのホストアドレス | IPv4アドレス | ||
| Internal.Netmask | ネットマスク | 数字 |
- ExternalとInternalにそれぞれ指定するネットワークタイプに応じて、指定すべきパラメータが異なります
- 必須ではないパラメータは、いずれもNetworkTypeにPrivateを指定した場合に必要になります。その場合はすべてのパラメータが必須となります
- すでにリソースが接続されているプライベートネットワーク/VへFW+LBを接続する場合、TrafficIpAddress, MasterHostAddress, SlaveHostAddressに指定するアドレスは、既存リソースと同一のアドレスブロックから指定する必要があります
- FW+LBを冗長化なしで利用する場合、SlaveHostAddressは利用されませんが指定する必要があります。後に冗長化ありへ変更したときに利用されます
レスポンス
| フィールド | タイプ | 意味 | 値 |
|---|---|---|---|
| Current.ResourceStatus | String | FW+LB 専有タイプステータス | |
| Current.HostList.Master | String | マスターならばYes, スレーブならばNo | "Yes" "No" |
| Current.HostList.ResourceStatus | String | FW+LB 専有タイプステータス | |
| Previous.ResourceStatus | String | FW+LB 専有タイプステータス | |
| Previous.HostList.Master | String | マスターならばYes, スレーブならばNo | "Yes" "No" |
| Previous.HostList.ResourceStatus | String | FW+LB 専有タイプステータス |
制限
- 特になし
サンプル
リクエストボディ
# グローバル、プライベート標準
{
"ActionType": "Setup",
"External": {
"NetworkType": "Global",
"TrafficIpName": "TrafficIpName1"
},
"Internal": {
"NetworkType": "PrivateStandard"
}
}
# グローバル、プライベートネットワーク/V
{
"ActionType": "Setup",
"External": {
"NetworkType": "Global",
"TrafficIpName": "TrafficIpName1"
},
"Internal": {
"NetworkType": "Private",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
}
}
# プライベート標準、プライベート標準（一本足）
{
"ActionType": "Setup",
"External": {
"NetworkType": "PrivateStandard",
"TrafficIpName": "TrafficIpName1"
},
"Internal": {
"NetworkType": "PrivateStandard"
}
}
# プライベート標準、プライベートネットワーク/V
{
"ActionType": "Setup",
"External": {
"NetworkType": "PrivateStandard",
"TrafficIpName": "TrafficIpName1"
},
"Internal": {
"NetworkType": "Private",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
}
}
# プライベートネットワーク/V、プライベート標準
{
"ActionType": "Setup",
"External": {
"NetworkType": "Private",
"TrafficIpName": "TrafficIpName1",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
},
"Internal": {
"NetworkType": "PrivateStandard"
}
}
# プライベートネットワーク/V、プライベートネットワーク/V（二本足）
{
"ActionType": "Setup",
"External": {
"NetworkType": "Private",
"TrafficIpName": "TrafficIpName1",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
},
"Internal": {
"NetworkType": "Private",
"ServiceCode": "ivl00000002",
"TrafficIpAddress": "10.0.1.1",
"MasterHostAddress": "10.0.1.2",
"SlaveHostAddress": "10.0.1.3",
"Netmask": "28"
}
}
# プライベートネットワーク/V、プライベートネットワーク/V（一本足）
{
"ActionType": "Setup",
"External": {
"NetworkType": "Private",
"TrafficIpName": "TrafficIpName1",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
},
"Internal": {
"NetworkType": "Private",
"ServiceCode": "ivl00000001",
"TrafficIpAddress": "10.0.0.1",
"MasterHostAddress": "10.0.0.2",
"SlaveHostAddress": "10.0.0.3",
"Netmask": "28"
}
}
レスポンス (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"
}
]
}
}