getPortForwardingList.lua
[INDEX]

ABSTRACT

Get port forwarding list

Get all configured port forwarding list.

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

NONE

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": [
/*ARRAY*/

The port forwarding list, each item is a JSON object

{
/*OBJECT*/

"Status":
"STRING"

The port forwarding work status:

running

Normal case, port forwarding task is running.

idle

For some reason, the port forwarding task is not started. This is an abnormal case, you can assume this is an error.

error

Port forwarding start failed.

restart

The port forwarding task is terminated (since an exception) but now is restarting.

terminated

The port forwarding task is terminated since it's destroied.

"Protocol":
"STRING"

Forward protocol type, 'tcp' or 'udp'.

"Listen":
"STRING"

Device local listen address and port, the format is "address:port". Which address can be '*', that means listen at any network interface.

"__Port":
INTEGER

The listening port extracted from "Listen", for alternative using.

"Target":
"STRING"

Forward to network target, format is "address:port", wich address can be a domain name, i.e. 'www.google.com'.

"Over":
"STRING"

The data forwarding over which device's network interface. You can get all valid network interfaces by getNetInterface.lua

"MaxPacketSize":
INTEGER

The maximum packet size for data transmission, in KB.

"SocketRxBuffer":
INTEGER

Socket receiving buffer size, in KB.

"SocketTxBuffer":
INTEGER

Socket sending buffer size, in KB.

}
]
}

OTHER NOTES

KILOVIEW Device HTTP API, v1.0