ddos src¶

Create Source ip limit entry

src Specification¶

Parameter Value

Type Intermediate Resource

Element Name src

Element URI /axapi/v3/ddos/src

Element Attributes src_attributes

Partition Visibility shared

Schema src schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/ddos/src	src_attributes

src attributes¶

default-list

Type: List

Reference Object: /axapi/v3/ddos/src/default/{default-address-type}

dynamic-entries-resource-usage

Description: dynamic-entries-resource-usage is a JSON Block. Please see below for dynamic-entries-resource-usage

Type: Object

Reference Object: /axapi/v3/ddos/src/dynamic-entries-resource-usage

dynamic-entry

Description: dynamic-entry is a JSON Block. Please see below for dynamic-entry

Type: Object

Reference Object: /axapi/v3/ddos/src/dynamic-entry

dynamic-entry-overflow-policy-list

Type: List

Reference Object: /axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}

entry-list

Type: List

Reference Object: /axapi/v3/ddos/src/entry/{src-entry-name}

geo-location-list

Type: List

Reference Object: /axapi/v3/ddos/src/geo-location/{geolocation-name}

default-list¶

Specification Value

Type list

Block object keys

age

Description Idle age for ip entry

Type: number

Range: 2-1023

Default: 5

app-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/default/{default-address-type}/app-type/{protocol}

apply-policy-on-overflow

Description Enable this flag to apply overflow policy when dynamic entry count overflows

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-address-type

Description ‘ip’: ip; ‘ipv6’: ipv6;

Type: string

Supported Values: ip, ipv6

disable

Description Disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for default-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/default/{default-address-type}/l4-type/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-dynamic-entry-count

Description Maximum count for dynamic src entry

Type: number

Range: 0-2147483647

template

Description: template is a JSON Block. Please see below for default-list_template

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

default-list_app-type-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for default-list_app-type-list_template

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

default-list_app-type-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

default-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

default-list_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

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

template

Description: template is a JSON Block. Please see below for default-list_l4-type-list_template

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

default-list_l4-type-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

default-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic-entries-resource-usage¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

entry-list¶

Specification Value

Type list

Block object keys

app-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/entry/{src-entry-name}/app-type/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description Description for this Source Entry

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for entry-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

hw-blacklist-blocking

Description: hw-blacklist-blocking is a JSON Block. Please see below for entry-list_hw-blacklist-blocking

Type: Object

Reference Object: /axapi/v3/ddos/src/entry/{src-entry-name}/hw-blacklist-blocking

ip-addr

Description

Type: string

Format: ipv4-address

ipv6-addr

Description

Type: string

Format: ipv6-address

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/entry/{src-entry-name}/l4-type/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

src-entry-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

subnet-ip-addr

Description IP Subnet

Type: string

Format: ipv4-cidr

subnet-ipv6-addr

Description IPV6 Subnet

Type: string

Format: ipv6-address-plen

template

Description: template is a JSON Block. Please see below for entry-list_template

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

entry-list_app-type-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for entry-list_app-type-list_template

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

entry-list_app-type-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

entry-list_hw-blacklist-blocking¶

Specification Value

Type object

src-enable

Description Enable Src side hardware blocking

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

entry-list_l4-type-list¶

Specification Value

Type list

Block object keys

action

Description ‘permit’: Whitelist incoming packets for protocol; ‘deny’: Blacklist incoming packets for protocol;

Type: string

Supported Values: permit, deny

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

template

Description: template is a JSON Block. Please see below for entry-list_l4-type-list_template

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

entry-list_l4-type-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

entry-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

entry-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

geo-location-list¶

Specification Value

Type list

Block object keys

app-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/geo-location/{geolocation-name}/app-type/{protocol}

bypass

Description Always permit for the Source to bypass all feature & limit checks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description Description for this Geolocation Entry

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

geolocation-name

Description Geolocation Name

Type: string

Format: string-rlx

Maximum Length: 15 characters

Maximum Length: 1 characters

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/geo-location/{geolocation-name}/l4-type/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for geo-location-list_template

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

geo-location-list_app-type-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for geo-location-list_app-type-list_template

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

geo-location-list_app-type-list_template¶

Specification Value

Type object

dns

Description DDOS DNS template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS HTTP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

geo-location-list_l4-type-list¶

Specification Value

Type list

Block object keys

action

Description ‘permit’: Whitelist incoming packets for protocol; ‘deny’: Blacklist incoming packets for protocol;

Type: string

Supported Values: permit, deny

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

template

Description: template is a JSON Block. Please see below for geo-location-list_l4-type-list_template

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

geo-location-list_l4-type-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS ICMP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

geo-location-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list¶

Specification Value

Type list

Block object keys

app-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}/app-type/{protocol}

default-address-type

Description ‘ip’: ip; ‘ipv6’: ipv6;

Type: string

Supported Values: ip, ipv6

exceed-log-cfg

Description: exceed-log-cfg is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_exceed-log-cfg

Type: Object

glid

Description Global limit ID

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/glid

l4-type-list

Type: List

Reference Object: /axapi/v3/ddos/src/dynamic-entry-overflow-policy/{default-address-type}/l4-type/{protocol}

log-periodic

Description Enable periodic log while event is continuing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_template

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

dynamic-entry-overflow-policy-list_app-type-list¶

Specification Value

Type list

Block object keys

protocol

Description ‘dns’: dns; ‘http’: http; ‘ssl-l4’: ssl-l4; ‘sip’: sip;

Type: string

Supported Values: dns, http, ssl-l4, sip

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_app-type-list_template

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

dynamic-entry-overflow-policy-list_app-type-list_template¶

Specification Value

Type object

dns

Description DDOS dns template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

http

Description DDOS http template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

sip

Description DDOS sip template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ssl-l4

Description DDOS SSL-L4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_template¶

Specification Value

Type object

logging

Description DDOS logging template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_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

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

template

Description: template is a JSON Block. Please see below for dynamic-entry-overflow-policy-list_l4-type-list_template

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

dynamic-entry-overflow-policy-list_l4-type-list_template¶

Specification Value

Type object

other

Description DDOS OTHER template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

tcp

Description DDOS TCP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v4

Description DDOS icmp-v4 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

template-icmp-v6

Description DDOS icmp-v6 template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

udp

Description DDOS UDP template

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

dynamic-entry-overflow-policy-list_exceed-log-cfg¶

Specification Value

Type object

log-enable

Description Enable logging of limit exceed drop’s

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

with-sflow-sample

Description Turn on sflow sample with log

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic-entry¶

Specification Value

Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters