ファイアウォールセットアップ

API情報
API種別メソッドURI対象名称実行
設定PUT/:GisServiceCode/firewalls/:IfwServiceCode/action.jsonファイアウォール

ファイアウォールセットアップ

非同期
  • 指定したファイアウォールをセットアップをします
  • APIのレスポンスはセットアップ処理の完了を待つことなく戻ります
  • ファイアウォールがメンテナンス中の場合はメンテナンスが完了するまでセットアップはできません


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########

IfwServiceCodeファイアウォールのサービスコードifw########
ボディActionType操作内容"Setup"

ExternalExternalインターフェイスの設定オブジェクト

External.NetworkTypeネットワーク種別

External.ServiceCode
プラベートネットワーク/V のサービスコードivl########

External.ExternalVipNameExternalVipの名前

文字列

  • 文字数
    • 1文字以上50文字以下
  • 使用可能文字
    • 半角英字(大文字・小文字)
    • 半角数字
    • 半角記号: _

External.ExternalVipAddress
ExternalVip IPv4アドレスIPv4アドレス

External.MasterHostAddress
マスターホストのアドレスIPv4アドレス

External.SlaveHostAddress
スレーブホストのアドレスIPv4アドレス

External.Netmask
ネットマスク数字

InternalListInternalインターフェイスの設定オブジェクトの配列

InternalList.NetworkType ネットワーク種別 "PrivateStandard", "Private"

InternalList.ServiceCode
プラベートネットワーク/V のサービスコードivl########

InternalList.InternalVipAddress
配下の仮想サーバからみた時にゲートウェイになるアドレスIPv4アドレス

InternalList.MasterHostAddress
マスターホストのアドレスIPv4アドレス

InternalList.SlaveHostAddress
スレーブホストのアドレスIPv4アドレス

InternalList.Netmask
ネットマスク数字
レスポンス
フィールドタイプ意味
CurrentObjectセットアップ後の状態オブジェクト
Current.ResourceStatusStringファイアウォールステータス
Current.HostListArray実ホストの状態オブジェクトの配列
Current.HostList.MasterStringマスターならばYes, スレーブならばNo"Yes", "No"
Current.HostList.ResourceStatusStringファイアウォールステータス
PreviousObjectセットアップ前の状態オブジェクト
Previous.ResourceStatusStringファイアウォールステータス
Previous.HostListArray実ホストの状態オブジェクトの配列
Previous.HostList.MasterStringマスターならばYes, スレーブならばNo"Yes", "No"
Previous.HostList.ResourceStatusStringファイアウォールステータス
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

# グローバル、プライベート標準
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "Global",
        "ExternalVipName": "EXTERNAL_VIP",
    },
    "InternalList": [
        {
            "NetworkType": "PrivateStandard"
        }
    ]
}
  
# グローバル、プライベートネットワーク/V
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "Global",
        "ExternalVipName": "EXTERNAL_VIP",
    },
    "InternalList": [
        {
            "NetworkType": "Private",
            "ServiceCode": "ivl#######1",
            "InternalVipAddress": "10.0.0.1",
            "MasterHostAddress": "10.0.0.2",
            "SlaveHostAddress": "10.0.0.3",
            "Netmask": "28"
        }
    ]
}
 
# グローバル、プライベート標準+プライベートネットワーク/V
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "Global",
        "ExternalVipName": "EXTERNAL_VIP",
    },
    "InternalList": [
        {
            "NetworkType": "PrivateStandard"
        },
        {
            "NetworkType": "Private",
            "ServiceCode": "ivl#######1",
            "InternalVipAddress": "10.0.0.1",
            "MasterHostAddress": "10.0.0.2",
            "SlaveHostAddress": "10.0.0.3",
            "Netmask": "28"
        }
    ]
}
# プライベート標準、プライベートネットワーク/V
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "PrivateStandard",
        "ExternalVipName": "EXTERNAL_VIP",
    },
    "InternalList": [
        {
            "NetworkType": "Private",
            "ServiceCode": "ivl#######1",
            "InternalVipAddress": "10.0.0.1",
            "MasterHostAddress": "10.0.0.2",
            "SlaveHostAddress": "10.0.0.3",
            "Netmask": "28"
        }
    ]
}
  
# プライベートネットワーク/V、プライベート標準
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "Private",
        "ExternalVipName": "EXTERNAL_VIP",
        "ServiceCode": "ivl#######1",
        "ExternalVipAddress": "10.0.0.1",
        "MasterHostAddress": "10.0.0.2",
        "SlaveHostAddress": "10.0.0.3",
        "Netmask": "28"
    },
    "InternalList": [
        {
            "NetworkType": "PrivateStandard"
        }
    ]
}
  
# プライベートネットワーク/V、プライベートネットワーク/V
{
    "ActionType": "Setup",
    "External": {
        "NetworkType": "Private",
        "ExternalVipName": "EXTERNAL_VIP",
        "ServiceCode": "ivl#######1",
        "ExternalVipAddress": "10.0.0.1",
        "MasterHostAddress": "10.0.0.2",
        "SlaveHostAddress": "10.0.0.3",
        "Netmask": "28"
    },
    "InternalList": [
        {
            "NetworkType": "Private",
            "ServiceCode": "ivl#######2",
            "InternalVipAddress": "10.0.1.1",
            "MasterHostAddress": "10.0.1.2",
            "SlaveHostAddress": "10.0.1.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"
            }
        ]
    }
}