ddos dst interface-ip¶

Configure protections on local interface IPs

interface-ip Specification¶

Parameter Value

Type Collection

Object Key(s) addr

Collection Name interface-ip-list

Collection URI /axapi/v3/ddos/dst/interface-ip

Element Name interface-ip

Element URI /axapi/v3/ddos/dst/interface-ip/{addr}

Element Attributes interface-ip_attributes

Partition Visibility shared

Schema interface-ip schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/dst/interface-ip	interface-ip attributes
Create List	POST	/axapi/v3/ddos/dst/interface-ip	interface-ip attributes
Get Object	GET	/axapi/v3/ddos/dst/interface-ip/{addr}	interface-ip attributes
Get List	GET	/axapi/v3/ddos/dst/interface-ip	interface-ip-list
Modify Object	POST	/axapi/v3/ddos/dst/interface-ip/{addr}	interface-ip attributes
Replace Object	PUT	/axapi/v3/ddos/dst/interface-ip/{addr}	interface-ip attributes
Replace List	PUT	/axapi/v3/ddos/dst/interface-ip	interface-ip-list
Delete Object	DELETE	/axapi/v3/ddos/dst/interface-ip/{addr}	interface-ip attributes

interface-ip-list¶

interface-ip-list is JSON List of interface-ip attributes

interface-ip-list : [

{ interface-ip attributes },

{ interface-ip attributes },

…

]

interface-ip attributes¶

addr

Description IP address of interface

Type: string

Format: ipv4-address

ip-proto-list

Type: List

Reference Object: /axapi/v3/ddos/dst/interface-ip/{addr}/ip-proto/{port-num}

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/dst/interface-ip/{addr}/l4-type/{protocol}

log-enable

Description Enable logging of limit exceed drops

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-list

Type: List

Reference Object: /axapi/v3/ddos/dst/interface-ip/{addr}/port/{port-num}+{protocol}

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

port-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

port-num

Description Port Number

Type: number

Range: 1-65535

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘http-probe’: http port for interface health check;

Type: string

Supported Values: tcp, udp, http-probe

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

ip-proto-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

port-num

Description IP protocol number

Type: number

Range: 0-255

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

l4-type-list¶

Specification Value

Type list

Block object keys

deny

Description Blacklist and Drop all incoming packets for protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

drop-frag-pkt

Description Drop fragmented packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

protocol

Description ‘tcp’: tcp; ‘udp’: udp; ‘icmp’: icmp; ‘other’: other;

Type: string

Supported Values: tcp, udp, icmp, other

tunnel-decap

Description: tunnel-decap is a JSON Block. Please see below for l4-type-list_tunnel-decap

Type: Object

tunnel-rate-limit

Description: tunnel-rate-limit is a JSON Block. Please see below for l4-type-list_tunnel-rate-limit

Type: Object

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

l4-type-list_tunnel-decap¶

Specification Value

Type object

gre-decap

Description Enable GRE Tunnel decapsulation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-decap

Description Enable IP Tunnel decapsulation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

key-cfg

Type: List

l4-type-list_tunnel-decap_key-cfg¶

Specification Value

Type list

Block object keys

key

Description Only decapsulate GRE packet with this key (Hexadecimal 0x0-0xFFFFFFFF,decimal 0-4294967295)

Type: string

Maximum Length: 10 characters

Maximum Length: 1 characters

l4-type-list_tunnel-rate-limit¶

Specification Value

Type object

gre-rate-limit

Description Enable inner IP rate limiting on GRE traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-rate-limit

Description Enable inner IP rate limiting on IPinIP traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0