REST API IPグループの作成/編集/データ取得

本ページではIPグループの作成、編集、データ取得をREST APIで実行する方法について解説します。

 

IPグループ作成

API

http://ServerIP:port/api/json/nfaipgroup/addIPGroup

メソッド

POST

パラメーター

パラメーター 値
apiKey （APIキー）
GroupName （IPグループ名）
Desc （IPグループの説明）
speed （速度）
DevList （インターフェースID）
※カンマ（,）で区切れば複数のインターフェースIDを指定できます
IPData

※指定するIPTypeに基づきIPDataを指定する必要があります。

IPTypeがipaddressの場合：（IPアドレス）
IPTypeがipnetworkの場合：（IPアドレス）,（ネットマスク）
IPTypeがiprangeの場合：（開始IPアドレス）,（終了IPアドレス）,（ネットマスク）

※「-」で区切れば複数のIPアドレスを指定できます。
IPType ipaddress/ipnetwork/iprange
※カンマ（,）で区切れば複数の値を指定できます。
status include/exclude
※IPDataのステータスを指定します
※カンマ（,）で区切れば複数の値を指定できますが、IPData、IPType、statusの値の数は同じである必要があります。
port （ポート）
※カンマ（,）で区切れば複数の値を指定できます。
protocol （プロトコル）
※カンマ（,）で区切れば複数の値を指定できますが、portとprotocolの値の数は同じである必要があります。
Dscp （DSCP）
※カンマ（,）で区切れば複数の値を指定できます。

リクエストサンプル

http://localhost:8083/api/json/nfaipgroup/addIPGroup

formData = {

"apiKey": "fa6073c78bfe85e71b0a69e7c7b27f77",

 

"GroupName": "MyIpGroup",

"Desc": "my network",

"DevList": "5000018,5000014,5000001,5000059,5000053",

"speed": "30000"

 

"IPData": "192.168.1.1-100.1.1.1,255.255.128.0,-200.0.0.1,200.0.0.250,255.255.255.0",

"IPType": "ipaddress,ipnetwork,iprange",

"status": "include,include,include",

 

"port": "80,80",

"protocol": "TCP,UDP",

"Dscp": "AF32,100001",

};

レスポンスサンプル

{

"message": "IPGroup added successfully",

"GName": "MyIpGroup"

}

 

IPグループ編集

API

http://ServerIP:port/api/json/nfaipgroup/modifyIPGroup

メソッド

POST

パラメーター

パラメーター 値
apiKey （APIキー）
ipGrpID （IPグループID　※編集対象の既存IPグループのID）
GroupName （IPグループ名　※編集対象の既存IPグループ名）
Desc （IPグループの説明）
speed （速度）
DevList （インターフェースID）
※カンマ（,）で区切れば複数のインターフェースIDを指定できます
IPData

※指定するIPTypeに基づきIPDataを指定する必要があります。

IPTypeがipaddressの場合：（IPアドレス）
IPTypeがipnetworkの場合：（IPアドレス）,（ネットマスク）
IPTypeがiprangeの場合：（開始IPアドレス）,（終了IPアドレス）,（ネットマスク）

※「-」で区切れば複数のIPアドレスを指定できます。
IPType ipaddress/ipnetwork/iprange
※カンマ（,）で区切れば複数の値を指定できます。
status include/exclude
※IPDataのステータスを指定します
※カンマ（,）で区切れば複数の値を指定できますが、IPData、IPType、statusの値の数は同じである必要があります。
port （ポート）
※カンマ（,）で区切れば複数の値を指定できます。
protocol （プロトコル）
※カンマ（,）で区切れば複数の値を指定できますが、portとprotocolの値の数は同じである必要があります。
Dscp （DSCP）
※カンマ（,）で区切れば複数の値を指定できます。

リクエストサンプル

http://localhost:8083/api/json/nfaipgroup/modifyIPGroup

formData = {

"apiKey": "fa6073c78bfe85e71b0a69e7c7b27f77",

 

"ipGrpID":"2500005"

"GroupName": "MyIpGroup",

"Desc": "my network",

"DevList": "5000018,5000014,5000001,5000059,5000053",

"speed": "30000"

 

"IPData": "192.168.1.1-100.1.1.1,255.255.128.0,-200.0.0.1,200.0.0.250,255.255.255.0",

"IPType": "ipaddress,ipnetwork,iprange",

"status": "include,include,include",

 

"port": "80,80",

"protocol": "TCP,UDP",

"Dscp": "AF32,100001",

};

レスポンスサンプル

{

"message": [MyIpGroup] IP Group has been modified successfully"

"GName": "MyIpGroup"

}

 

IPグループのデータ取得

API

http://ServerIP:port/api/json/nfaipgroup/listIPGroup

サンプル：
http://localhost:8083/api/json/nfaipgroup/listIPGroup?apiKey=fa6073c78bfe85e71b0a69e7c7b27f77&GroupName=MyIpGroup

メソッド

GET

パラメーター

パラメーター 値
apiKey （APIキー）
GroupName （詳細を取得したいIPグループの名称）

レスポンスサンプル

{

"app": [

"80 (TCP)",

"80 (UDP)"

],

"dscp": [

"AF32 (28)",

"100001 (33)"

],

"base": {

"Name": "MyIpGroup",

"speed": 40000,

"status": "Enabled",

"ID": 2500005,

"bandwidth": 0

},

"Asso_Device": [

"2.2.2.81 (IfIndex1)",

"2.2.2.9 (IfIndex2, IfIndex1)",

"2.2.2.49 (IfIndex2, IfIndex1)"

],

"Asso_Dev_id": [

"5000053",

"5000059",

"5000001",

"5000014",

"5000018"

],

"ip": [

[

"IPAddress",

"Include",

"192.168.1.1",

"---"

],

[

"IPNetwork",

"Include",

"100.1.1.1",

"255.255.128.0"

],

[

"IPRange",

"Include",

"200.0.0.1 to 200.0.0.250",

"255.255.255.0"

]

]

}

]

}