IP组API

1. IP组创建

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

类型: POST

参数:

字段 描述

api密匙

 api密匙
组名 IP组名称
描述 IP组描述
速度

速度
DevList 接口id (可以分别指定多个接口id)
IPData

需要根据IPType参数形成IPData。

如果IPType是ip地址=> IP地址

如果IPType是ip网络=> IP地址，网络掩码

如果IPType是ip范围=> 起始IP地址，结束IP地址，网络掩码

(可以分别指定多个IP地址)
IP类型

IPData类型的详细信息。可能的值是"ip地址/ip网络/ip范围"

(可以分别指定多个类型)

status

IPData状态。可能的值是"include/exclude".

(可以分别指定多个类型)

注意 *:IPData、IPType、status值的数量应该是相等的。

端口

 端口(可以分别指定多个端口)

协议

协议(可以分别指定多个协议)

注意 *: 端口和协议值的数量应该相等。

Dscp

 dscp (可以分别指定多个dscp)

API举例:

请求:

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"

}

 

2. IP组修改

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

类型: POST

参数:

字段 描述

api密匙

 api密匙
ipGrpID IP组Id (已存在的需要修改的Ip组id)
组名 IP组名称(已存在的需要修改的Ip组名称)
Desc IP组描述
速度

速度
DevList 接口(可以分别指定多个接口id)
IPData

需要根据IP类型参数形成IPData。

如果IP类型是ip地址=> IP地址

如果IP类型是ip网络=> IP地址，网络掩码

如果IP类型是ip范围=>开始IP地址，结束IP地址，网络掩码

(可以分别指定多个IP地址)
IP类型

IPData类型的详细信息。可能的值为"ip地址/ip网络/ip范围"

(可以分别指定多个类型)

状态

IPData的状态。可能的值为"include/exclude".

(可以分别指定多个类型)

注意 *:IPData, IPType, status值的数量应该是相等的。

端口

 端口(可以分别指定多个端口)

协议

协议(可以分别指定多个协议)

注意 *:端口、协议的值的数量应该是相等的。

Dscp

 dscp (可以分别指定多个dscp)

API举例:

请求:

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"

}

 

 

3. 获取IP组数据

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

类型: GET

参数:

字段 描述

api密匙

 api密匙
组名 获取详细信息的ip组名

API举例:

请求:

http://localhost:8083/api/json/nfaipgroup/listIPGroup?apiKey=fa6073c78bfe85e71b0a69e7c7b27f77&GroupName=MyIpGroup

响应:

{

"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"

]

]

}

]

}

 

Back to Top