ファイアウォール追加申し込み

API情報
API種別メソッドURI対象名称実行
契約POST/:GisServiceCode/firewalls.jsonファイアウォール

ファイアウォール追加申し込み

非同期
  • ファイアウォールを新規に申し込みます
  • APIのレスポンスはファイアウォールが利用可能な状態になることを待つことなく戻ります


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
ボディTypeファイアウォール品目
レスポンス
フィールドタイプ意味
ServiceCodeStringファイアウォールのサービスコードifw########
LabelStringラベル文字列
ContractStatusString契約状態
StartDateString利用開始日YYYYMMDD
StopDateString解約予定日YYYYMMDD
TypeStringファイアウォール品目
RedundantString冗長構成有無"Yes"
ResourceStatusStringファイアウォールステータス
ExternalObjectExternalインターフェイス情報オブジェクト。追加直後は空
InternalListArrayInternalインターフェイス情報オブジェクトの配列。追加直後は空
HostListArray実ホスト情報オブジェクトの配列
HostList.MasterStringマスターならばYes, スレーブならばNo"Yes", "No"
HostList.ExternalObjectホストのExternalインターフェイス情報オブジェクト。追加直後は空
HostList.InternalListArrayホストのInternalインターフェイス情報オブジェクトの配列。追加直後は空
HostList.ServiceInfrastructureVersionStringサービス提供基盤のバージョン文字列
HostList.ResourceStatusStringホストのステータス ファイアウォールステータス
NatRuleList ArrayNATルールの一覧オブジェクトの配列。追加直後は空
NaptRuleListArrayNAPTルールの一覧オブジェクトの配列。追加直後は空
StaticRouteList Arrayスタティックルートの一覧オブジェクトの配列。追加直後は空
SyslogServerObjectログサーバの設定オブジェクト
SyslogServer.AddressStringログサーバのアドレスIPv4アドレス
SyslogServer.ProtocolString使用プロトコル"TCP", "UDP"
SyslogServer.PortStringログサーバのポート番号数字
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

{
    "Type": "FW100M"
}

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "ServiceCode": "ifw#######1",
    "Label": "XXXXX",
    "ContractStatus": "InService",
    "StartDate": "YYYYMMDD",
    "StopDate": "",
    "Type": "FW100M",
    "Redundant": "Yes",
    "ResourceStatus": "SettingUp",
    "External": {},
    "InternalList": [],
    "HostList": [
        {
            "Master": "Yes",
            "External": {},
            "InternalList": [],
            "ServiceInfrastructureVersion": "",
            "ResourceStatus": "Stopped"
        },
        {
            "Master": "No",
            "External": {},
            "InternalList": [],
            "ServiceInfrastructureVersion": "",
            "ResourceStatus": "Stopped"
        }
    ],
    "NatRuleList": [],
    "NaptRuleList": [],
    "StaticRouteList": [],
    "SyslogServer": {
        "Address": "",
        "Protocol": "",
        "Port": ""
    }
}