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

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

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

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


リクエストパラメータ

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

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

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

External.NetworkType ネットワーク種別

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

External.ExternalVipName ExternalVipの名前

文字列

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

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

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

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

External.Netmask
ネットマスク 数字

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

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

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

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

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

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

InternalList.Netmask
ネットマスク 数字
レスポンス
フィールド タイプ 意味
Current Object セットアップ後の状態 オブジェクト
Current.ResourceStatus String ファイアウォールステータス
Current.HostList Array 実ホストの状態 オブジェクトの配列
Current.HostList.Master String マスターならばYes, スレーブならばNo "Yes", "No"
Current.HostList.ResourceStatus String ファイアウォールステータス
Previous Object セットアップ前の状態 オブジェクト
Previous.ResourceStatus String ファイアウォールステータス
Previous.HostList Array 実ホストの状態 オブジェクトの配列
Previous.HostList.Master String マスターならばYes, スレーブならばNo "Yes", "No"
Previous.HostList.ResourceStatus String ファイアウォールステータス
エラーコード
  • この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"
            }
        ]
    }
}