ddos dst zone web-gui¶

Configure web settings for onbox GUI

web-gui Specification¶

Parameter Value

Type Configuration Resource

Element Name web-gui

Element URI /axapi/v3/ddos/dst/zone/{zone-name}/web-gui

Element Attributes web-gui_attributes

Partition Visibility shared

Schema web-gui schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/dst/zone/{zone-name}/web-gui	web-gui attributes
Get Object	GET	/axapi/v3/ddos/dst/zone/{zone-name}/web-gui	web-gui attributes
Modify Object	POST	/axapi/v3/ddos/dst/zone/{zone-name}/web-gui	web-gui attributes
Replace Object	PUT	/axapi/v3/ddos/dst/zone/{zone-name}/web-gui	web-gui attributes
Delete Object	DELETE	/axapi/v3/ddos/dst/zone/{zone-name}/web-gui	web-gui attributes

web-gui attributes¶

activated-after-learning

Description Activate it after learning

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

create-time

Description Configure create time

Type: string

Maximum Length: 13 characters

Maximum Length: 1 characters

learning

Description: learning is a JSON Block. Please see below for learning

Type: Object

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/learning

modify-time

Description Configure modify time

Type: string

Maximum Length: 13 characters

Maximum Length: 1 characters

protection

Description: protection is a JSON Block. Please see below for protection

Type: Object

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection

sensitivity

Description ‘5’: Low; ‘3’: Medium; ‘1.5’: High;

Type: string

Supported Values: 5, 3, 1.5

Default: 3

status

Description ‘newly’: newly; ‘learning’: learning; ‘learned’: learned; ‘activated’: activated;

Type: string

Supported Values: newly, learning, learned, activated

Default: newly

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protection¶

Specification Value

Type object

ip-proto

Description: ip-proto is a JSON Block. Please see below for protection_ip-proto

Type: Object

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto

port

Description: port is a JSON Block. Please see below for protection_port

Type: Object

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port

port-range-list

Type: List

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port-range/{port-range-start}+{port-range-end}+{protocol}

protection_port-range-list¶

Specification Value

Type list

Block object keys

pbe

Description Peak Bandwidth Expected

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-range-end

Description Port-Range End Port Number

Type: number

Range: 1-65535

port-range-start

Description Port-Range Start Port Number

Type: number

Range: 1-65535

protocol

Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port;

Type: string

Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protection_port¶

Specification Value

Type object

zone-service-list

Type: List

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service/{port-num}+{protocol}

zone-service-other-list

Type: List

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/port/zone-service-other/{port-other}+{protocol}

protection_port_zone-service-list¶

Specification Value

Type list

Block object keys

pbe

Description Peak Bandwidth Expected

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-num

Description Port Number

Type: number

Range: 1-65535

protocol

Description ‘dns-tcp’: DNS-TCP Port; ‘dns-udp’: DNS-UDP Port; ‘http’: HTTP Port; ‘tcp’: TCP Port; ‘udp’: UDP Port; ‘ssl-l4’: SSL-L4 Port;

Type: string

Supported Values: dns-tcp, dns-udp, http, tcp, udp, ssl-l4

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protection_port_zone-service-other-list¶

Specification Value

Type list

Block object keys

pbe

Description Peak Bandwidth Expected

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-other

Description ‘other’: other;

Type: string

Supported Values: other

protocol

Description ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

protection_ip-proto¶

Specification Value

Type object

proto-name-list

Type: List

Reference Object: /axapi/v3/ddos/dst/zone/{zone-name}/web-gui/protection/ip-proto/proto-name/{protocol}

protection_ip-proto_proto-name-list¶

Specification Value

Type list

Block object keys

pbe

Description Peak Bandwidth Expected

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

protocol

Description ‘icmp-v4’: ip-proto icmp-v4; ‘icmp-v6’: ip-proto icmp-v6;

Type: string

Supported Values: icmp-v4, icmp-v6

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

learning¶

Specification Value

Type object

duration

Description ‘1minute’: 1 minute; ‘6hour’: 6 hours; ‘12hour’: 12 hours; ‘24hour’: 24 hours; ‘7day’: 7 days;

Type: string

Supported Values: 1minute, 6hour, 12hour, 24hour, 7day

Default: 6hour

starting-time

Description Configure learning starting time

Type: string

Maximum Length: 13 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters