ddos network-object¶

Configure DDoS a static Monitor Network Object

network-object Specification¶

Parameter Value

Type Collection

Object Key(s) object-name

Collection Name network-object-list

Collection URI /axapi/v3/ddos/network-object

Element Name network-object

Element URI /axapi/v3/ddos/network-object/{object-name}

Element Attributes network-object_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/ddos/network-object/{object-name}/stats

Operational Data URI /axapi/v3/ddos/network-object/{object-name}/oper

Schema network-object schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/network-object	network-object attributes
Create List	POST	/axapi/v3/ddos/network-object	network-object attributes
Get Object	GET	/axapi/v3/ddos/network-object/{object-name}	network-object attributes
Get List	GET	/axapi/v3/ddos/network-object	network-object-list
Modify Object	POST	/axapi/v3/ddos/network-object/{object-name}	network-object attributes
Replace Object	PUT	/axapi/v3/ddos/network-object/{object-name}	network-object attributes
Replace List	PUT	/axapi/v3/ddos/network-object	network-object-list
Delete Object	DELETE	/axapi/v3/ddos/network-object/{object-name}	network-object attributes

network-object-list¶

network-object-list is JSON List of network-object attributes

network-object-list : [

{ network-object attributes },

{ network-object attributes },

…

]

network-object attributes¶

anomaly-detection-trigger

Description ‘all’: Use both learned and static thresholds (static thresholds take precedence); ‘static-threshold-only’: Use static thresholds only;

Type: string

Supported Values: all, static-threshold-only

Default: all

histogram-enable

Description Enable histogram statistics (Default: Disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

host-anomaly-threshold

Description: host-anomaly-threshold is a JSON Block. Please see below for host-anomaly-threshold

Type: Object

ip

Type: List

ipv6

Type: List

network-object-anomaly-threshold

Description: network-object-anomaly-threshold is a JSON Block. Please see below for network-object-anomaly-threshold

Type: Object

notification

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

Type: Object

Reference Object: /axapi/v3/ddos/network-object/{object-name}/notification

object-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

operational-mode

Description ‘monitor’: Monitor mode; ‘learning’: Learning mode;

Type: string

Supported Values: monitor, learning

Default: learning

relative-auto-break-down-threshold

Description: relative-auto-break-down-threshold is a JSON Block. Please see below for relative-auto-break-down-threshold

Type: Object

sampling-enable

Type: List

service-break-down-threshold-local

Description: service-break-down-threshold-local is a JSON Block. Please see below for service-break-down-threshold-local

Type: Object

service-discovery

Description ‘disable’: Disable service discovery for hosts (default: enabled);

Type: string

Supported Values: disable

static-auto-break-down-threshold

Description: static-auto-break-down-threshold is a JSON Block. Please see below for static-auto-break-down-threshold

Type: Object

sub-network-list

Type: List

Reference Object: /axapi/v3/ddos/network-object/{object-name}/sub-network/{subnet-ip-addr}

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

network-object-anomaly-threshold¶

Specification Value

Type object

network-object-byte-rate

Description Byte rate of the network-object

Type: number

Range: 100-10995116277760

network-object-pkt-rate

Description Packet rate of the network-object

Type: number

Range: 1-10995116277760

ip¶

Specification Value

Type list

Block object keys

subnet-ip-addr

Description IP Subnet, supported prefix range is from 8 to 31

Type: string

Format: ipv4-cidr

service-break-down-threshold-local¶

Specification Value

Type object

svc-percentage

Description percentage of parent ip node

Type: number

Range: 5-99

relative-auto-break-down-threshold¶

Specification Value

Type object

network-percentage

Description percentage of parent node

Type: number

Range: 1-99

permil

Description permil of root node

Type: number

Range: 1-999

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘subnet_learned’: Subnet Entry Learned; ‘subnet_aged’: Subnet Entry Aged; ‘ip_learned’: IP Entry Learned; ‘ip_aged’: IP Entry Aged; ‘service_learned’: Service Entry Learned; ‘service_aged’: Service Entry Aged;

Type: string

Supported Values: all, subnet_learned, subnet_aged, subnet_create_fail, ip_learned, ip_aged, ip_create_fail, service_learned, service_aged, service_create_fail

ipv6¶

Specification Value

Type list

Block object keys

subnet-ipv6-addr

Description IPV6 Subnet, supported prefix range is from 40 to 63

Type: string

Format: ipv6-address-plen

sub-network-list¶

Specification Value

Type list

Block object keys

host-anomaly-threshold

Description: host-anomaly-threshold is a JSON Block. Please see below for sub-network-list_host-anomaly-threshold

Type: Object

sub-network-anomaly-threshold

Description: sub-network-anomaly-threshold is a JSON Block. Please see below for sub-network-list_sub-network-anomaly-threshold

Type: Object

subnet-ip-addr

Description IPv4 Subnet/host, supported prefix range is from 24 to 32

Type: string

Format: ipv4-cidr

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

sub-network-list_sub-network-anomaly-threshold¶

Specification Value

Type object

static-sub-network-byte-rate

Description Byte rate of the sub-network

Type: number

Range: 100-4294967295

static-sub-network-pkt-rate

Description Packet rate of the sub-network

Type: number

Range: 1-2147483647

sub-network-list_host-anomaly-threshold¶

Specification Value

Type object

static-byte-rate-threshold

Description Byte rate of per host

Type: number

Range: 100-4294967295

static-pkt-rate-threshold

Description Packet rate of per host

Type: number

Range: 1-2147483647

notification¶

Specification Value

Type object

configuration

Description ‘configuration’: configuration;

Type: string

Supported Values: configuration

notification

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

notification_notification¶

Specification Value

Type list

Block object keys

notification-template-name

Description Specify the notification template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/notification-template

host-anomaly-threshold¶

Specification Value

Type object

host-byte-rate

Description Byte rate of per host

Type: number

Range: 100-4294967295

host-pkt-rate

Description Packet rate of per host

Type: number

Range: 1-2147483647

static-auto-break-down-threshold¶

Specification Value

Type object

network-pkt-rate

Description packet rate of current node

Type: number

Range: 100-2000000