ddos zone-src-port-template udp¶

UDP template configuration

udp Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name udp-list

Collection URI /axapi/v3/ddos/zone-src-port-template/udp

Element Name udp

Element URI /axapi/v3/ddos/zone-src-port-template/udp/{name}

Element Attributes udp_attributes

Partition Visibility shared

Schema udp schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/zone-src-port-template/udp	udp attributes
POST /axapi/v3/ddos/zone-src-port-template/udp/ Payload: { "udp": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/ddos/zone-src-port-template/udp	udp attributes
Get Object	GET	/axapi/v3/ddos/zone-src-port-template/udp/{name}	udp attributes
GET /axapi/v3/ddos/zone-src-port-template/udp/a Reponse: { "udp": { "name": "a", "filter-match-type": "default", "ntp-monlist-cfg": { "ntp-monlist": 0 }, "uuid": "7c6867ba-50a4-11ee-a2fd-001fa015fd06", "user-tag": "a", "a10-url": "/axapi/v3/ddos/zone-src-port-template/udp/a" } }
Get List	GET	/axapi/v3/ddos/zone-src-port-template/udp	udp-list
Modify Object	POST	/axapi/v3/ddos/zone-src-port-template/udp/{name}	udp attributes
Replace Object	PUT	/axapi/v3/ddos/zone-src-port-template/udp/{name}	udp attributes
PUT /axapi/v3/ddos/zone-src-port-template/udp/a Payload: { "udp": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/ddos/zone-src-port-template/udp	udp-list
Delete Object	DELETE	/axapi/v3/ddos/zone-src-port-template/udp/{name}	udp attributes
DELETE /axapi/v3/ddos/zone-src-port-template/udp/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

udp-list¶

udp-list is JSON List of udp attributes

udp-list : [

{ udp attributes },

{ udp attributes },

…

]

udp attributes¶

filter-list

Type: List

Reference Object: /axapi/v3/ddos/zone-src-port-template/udp/{name}/filter/{udp-filter-name}

filter-match-type

Description ‘default’: Stop matching on drop/blacklist action; ‘stop-on-first-match’: Stop matching on first match;

Type: string

Supported Values: default, stop-on-first-match

Default: default

max-payload-size-cfg

Description: max-payload-size-cfg is a JSON Block. Please see below for max-payload-size-cfg

Type: Object

min-payload-size-cfg

Description: min-payload-size-cfg is a JSON Block. Please see below for min-payload-size-cfg

Type: Object

name

Description DDOS UDP Template Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

ntp-monlist-cfg

Description: ntp-monlist-cfg is a JSON Block. Please see below for ntp-monlist-cfg

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

ntp-monlist-cfg¶

Specification Value

Type object

ntp-monlist

Description Take action for ntp monlist request/response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ntp-monlist-action

Description ‘drop’: Drop packets for ntp-monlist (Default); ‘blacklist-src’: Blacklist-src for ntp-monlist; ‘ignore’: Ignore ntp-monlist;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: ntp-monlist-action and ntp-monlist-action-list-name are mutually exclusive

ntp-monlist-action-list-name

Description Configure action-list to take for ntp-monlist

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: ntp-monlist-action-list-name and ntp-monlist-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

max-payload-size-cfg¶

Specification Value

Type object

max-payload-size

Description Maximum UDP payload size for each single packet

Type: number

Range: 1-1470

max-payload-size-action

Description ‘drop’: Drop packets for max-payload-size exceed (Default); ‘blacklist-src’: Blacklist-src for max-payload-size exceed; ‘ignore’: Do nothing for max-payload-size exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: max-payload-size-action and max-payload-size-action-list-name are mutually exclusive

max-payload-size-action-list-name

Description Configure action-list to take for max-payload-size exceed

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

Mutual Exclusion: max-payload-size-action-list-name and max-payload-size-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

min-payload-size-cfg¶

Specification Value

Type object

min-payload-size

Description Minimum UDP payload size for each single packet

Type: number

Range: 1-1470

min-payload-size-action

Description ‘drop’: Drop packets for min-payload-size (Default); ‘blacklist-src’: Blacklist-src for min-payload-size; ‘ignore’: Do nothing for min-payload-size exceed;

Type: string

Supported Values: drop, blacklist-src, ignore

Mutual Exclusion: min-payload-size-action and min-payload-size-action-list-name are mutually exclusive

min-payload-size-action-list-name

Description Configure action-list to take for min-payload-size exceed

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

Mutual Exclusion: min-payload-size-action-list-name and min-payload-size-action are mutually exclusive

Reference Object: /axapi/v3/ddos/action-list

filter-list¶

Specification Value

Type list

Block object keys

byte-offset-filter

Description Filter using Berkeley Packet Filter syntax

Type: string

Format: string-rlx

Maximum Length: 1275 characters

Maximum Length: 1 characters

udp-filter-action

Description ‘drop’: Drop packets (Default); ‘ignore’: Take no action; ‘blacklist-src’: Blacklist-src; ‘authenticate-src’: Authenticate-src;

Type: string

Supported Values: drop, ignore, blacklist-src, authenticate-src

Mutual Exclusion: udp-filter-action and udp-filter-action-list-name are mutually exclusive

udp-filter-action-list-name

Description Configure action-list to take

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: udp-filter-action-list-name and udp-filter-action are mutually exclusive

udp-filter-inverse-match

Description Inverse the result of the matching

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

udp-filter-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

udp-filter-regex

Description Regex Expression

Type: string

Format: string-rlx

Maximum Length: 1275 characters

Maximum Length: 1 characters

udp-filter-seq

Description Sequence number

Type: number

Range: 1-200

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