ddos zone-profile¶

Profile for DDoS zone thresholds

zone-profile Specification¶

Parameter Value

Type Collection

Object Key(s) profile-name

Collection Name zone-profile-list

Collection URI /axapi/v3/ddos/zone-profile

Element Name zone-profile

Element URI /axapi/v3/ddos/zone-profile/{profile-name}

Element Attributes zone-profile_attributes

Partition Visibility shared

Schema zone-profile schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/zone-profile	zone-profile attributes
POST /axapi/v3/ddos/zone-profile/ Payload: { "zone-profile": { "profile-name": "a" } }
Create List	POST	/axapi/v3/ddos/zone-profile	zone-profile attributes
Get Object	GET	/axapi/v3/ddos/zone-profile/{profile-name}	zone-profile attributes
GET /axapi/v3/ddos/zone-profile/a Reponse: { "zone-profile": { "profile-name": "a", "uuid": "f6f11ed0-1b7c-11ee-8061-96e2e08a4638", "a10-url": "/axapi/v3/ddos/zone-profile/a" } }
Get List	GET	/axapi/v3/ddos/zone-profile	zone-profile-list
Modify Object	POST	/axapi/v3/ddos/zone-profile/{profile-name}	zone-profile attributes
Replace Object	PUT	/axapi/v3/ddos/zone-profile/{profile-name}	zone-profile attributes
PUT /axapi/v3/ddos/zone-profile/a Payload: { "zone-profile": { "profile-name": "a" } }
Replace List	PUT	/axapi/v3/ddos/zone-profile	zone-profile-list
Delete Object	DELETE	/axapi/v3/ddos/zone-profile/{profile-name}	zone-profile attributes
DELETE /axapi/v3/ddos/zone-profile/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

zone-profile-list¶

zone-profile-list is JSON List of zone-profile attributes

zone-profile-list : [

{ zone-profile attributes },

{ zone-profile attributes },

…

]

zone-profile attributes¶

ip-proto

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

Type: Object

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/ip-proto

port-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}

port-range-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}

profile-name

Description Profile for DDoS zone thresholds

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

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

indicator-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/port/{port-num}+{port-protocol}/indicator/{indicator-name}

port-num

Description Port Number

Type: number

Range: 1-65535

port-protocol

Description ‘dns-tcp’: dns-tcp; ‘dns-udp’: dns-udp; ‘sip-tcp’: sip-tcp; ‘sip-udp’: sip-udp; ‘http’: http; ‘tcp’: tcp; ‘udp’: udp; ‘ssl-l4’: ssl-l4; ‘quic’: quic;

Type: string

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

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_indicator-list¶

Specification Value

Type list

Block object keys

indicator-name

Description ‘pkt-rate’: pkt-rate; ‘pkt-drop-rate’: pkt-drop-rate; ‘bit-rate’: bit-rate; ‘pkt-drop-ratio’: pkt-drop-ratio; ‘bytes-to-bytes-from-ratio’: bytes-to-bytes-from-ratio; ‘concurrent-conns’: concurrent-conns; ‘conn-miss-rate’: conn-miss-rate; ‘syn-rate’: syn-rate; ‘fin-rate’: fin-rate; ‘rst-rate’: rst-rate; ‘small-window-ack-rate’: small-window-ack-rate; ‘empty-ack-rate’: empty-ack-rate; ‘small-payload-rate’: small-payload-rate; ‘syn-fin-ratio’: syn-fin-ratio; ‘cpu-utilization’: cpu-utilization; ‘interface-utilization’: interface-utilization;

Type: string

Supported Values: pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

src-threshold-cfg

Description: src-threshold-cfg is a JSON Block. Please see below for port-list_indicator-list_src-threshold-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

zone-threshold-cfg

Description: zone-threshold-cfg is a JSON Block. Please see below for port-list_indicator-list_zone-threshold-cfg

Type: Object

port-list_indicator-list_src-threshold-cfg¶

Specification Value

Type object

src-threshold-num

Description Indicator per-src threshold

Type: number

Range: 1-2147483647

src-threshold-str

Description Indicator per-src threshold (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-list_indicator-list_zone-threshold-cfg¶

Specification Value

Type object

zone-threshold-num

Description Threshold for the entire zone

Type: number

Range: 1-2147483647

zone-threshold-str

Description Threshold for the entire zone (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto¶

Specification Value

Type object

proto-name-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-name/{protocol}

proto-number-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-number/{protocol-num}

ip-proto_proto-number-list¶

Specification Value

Type list

Block object keys

indicator-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-number/{protocol-num}/indicator/{indicator-name}

protocol-num

Description Protocol Number

Type: number

Range: 0-255

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip-proto_proto-number-list_indicator-list¶

Specification Value

Type list

Block object keys

indicator-name

Description ‘pkt-rate’: pkt-rate; ‘pkt-drop-rate’: pkt-drop-rate; ‘bit-rate’: bit-rate; ‘pkt-drop-ratio’: pkt-drop-ratio; ‘bytes-to-bytes-from-ratio’: bytes-to-bytes-from-ratio; ‘frag-rate’: frag-rate; ‘cpu-utilization’: cpu-utilization; ‘interface-utilization’: interface-utilization;

Type: string

Supported Values: pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, frag-rate, cpu-utilization, interface-utilization

src-threshold-cfg

Description: src-threshold-cfg is a JSON Block. Please see below for ip-proto_proto-number-list_indicator-list_src-threshold-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

zone-threshold-cfg

Description: zone-threshold-cfg is a JSON Block. Please see below for ip-proto_proto-number-list_indicator-list_zone-threshold-cfg

Type: Object

ip-proto_proto-number-list_indicator-list_src-threshold-cfg¶

Specification Value

Type object

src-threshold-num

Description Indicator per-src threshold

Type: number

Range: 1-2147483647

src-threshold-str

Description Indicator per-src threshold (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto_proto-number-list_indicator-list_zone-threshold-cfg¶

Specification Value

Type object

zone-threshold-num

Description Threshold for the entire zone

Type: number

Range: 1-2147483647

zone-threshold-str

Description Threshold for the entire zone (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto_proto-name-list¶

Specification Value

Type list

Block object keys

indicator-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/ip-proto/proto-name/{protocol}/indicator/{indicator-name}

protocol

Description ‘icmp-v4’: ip-proto icmp-v4; ‘icmp-v6’: ip-proto icmp-v6; ‘gre’: ip-proto gre; ‘ipv4-encap’: ip-proto IPv4 Encapsulation; ‘ipv6-encap’: ip-proto IPv6 Encapsulation;

Type: string

Supported Values: icmp-v4, icmp-v6, gre, ipv4-encap, ipv6-encap

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ip-proto_proto-name-list_indicator-list¶

Specification Value

Type list

Block object keys

indicator-name

Description ‘pkt-rate’: pkt-rate; ‘pkt-drop-rate’: pkt-drop-rate; ‘bit-rate’: bit-rate; ‘pkt-drop-ratio’: pkt-drop-ratio; ‘bytes-to-bytes-from-ratio’: bytes-to-bytes-from-ratio; ‘frag-rate’: frag-rate; ‘cpu-utilization’: cpu-utilization; ‘interface-utilization’: interface-utilization;

Type: string

Supported Values: pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, frag-rate, cpu-utilization, interface-utilization

src-threshold-cfg

Description: src-threshold-cfg is a JSON Block. Please see below for ip-proto_proto-name-list_indicator-list_src-threshold-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

zone-threshold-cfg

Description: zone-threshold-cfg is a JSON Block. Please see below for ip-proto_proto-name-list_indicator-list_zone-threshold-cfg

Type: Object

ip-proto_proto-name-list_indicator-list_src-threshold-cfg¶

Specification Value

Type object

src-threshold-num

Description Indicator per-src threshold

Type: number

Range: 1-2147483647

src-threshold-str

Description Indicator per-src threshold (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-proto_proto-name-list_indicator-list_zone-threshold-cfg¶

Specification Value

Type object

zone-threshold-num

Description Threshold for the entire zone

Type: number

Range: 1-2147483647

zone-threshold-str

Description Threshold for the entire zone (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-range-list¶

Specification Value

Type list

Block object keys

indicator-list

Type: List

Reference Object: /axapi/v3/ddos/zone-profile/{profile-name}/port-range/{port-range-start}+{port-range-end}+{protocol}/indicator/{indicator-name}

port-range-end

Description Port-Range End Port Number

Type: number

Range: 2-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; ‘sip-tcp’: SIP-TCP Port; ‘sip-udp’: SIP-UDP Port; ‘quic’: QUIC Port;

Type: string

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

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-range-list_indicator-list¶

Specification Value

Type list

Block object keys

indicator-name

Description ‘pkt-rate’: pkt-rate; ‘pkt-drop-rate’: pkt-drop-rate; ‘bit-rate’: bit-rate; ‘pkt-drop-ratio’: pkt-drop-ratio; ‘bytes-to-bytes-from-ratio’: bytes-to-bytes-from-ratio; ‘concurrent-conns’: concurrent-conns; ‘conn-miss-rate’: conn-miss-rate; ‘syn-rate’: syn-rate; ‘fin-rate’: fin-rate; ‘rst-rate’: rst-rate; ‘small-window-ack-rate’: small-window-ack-rate; ‘empty-ack-rate’: empty-ack-rate; ‘small-payload-rate’: small-payload-rate; ‘syn-fin-ratio’: syn-fin-ratio; ‘cpu-utilization’: cpu-utilization; ‘interface-utilization’: interface-utilization;

Type: string

Supported Values: pkt-rate, pkt-drop-rate, bit-rate, pkt-drop-ratio, bytes-to-bytes-from-ratio, concurrent-conns, conn-miss-rate, syn-rate, fin-rate, rst-rate, small-window-ack-rate, empty-ack-rate, small-payload-rate, syn-fin-ratio, cpu-utilization, interface-utilization

src-threshold-cfg

Description: src-threshold-cfg is a JSON Block. Please see below for port-range-list_indicator-list_src-threshold-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

zone-threshold-cfg

Description: zone-threshold-cfg is a JSON Block. Please see below for port-range-list_indicator-list_zone-threshold-cfg

Type: Object

port-range-list_indicator-list_src-threshold-cfg¶

Specification Value

Type object

src-threshold-num

Description Indicator per-src threshold

Type: number

Range: 1-2147483647

src-threshold-str

Description Indicator per-src threshold (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

port-range-list_indicator-list_zone-threshold-cfg¶

Specification Value

Type object

zone-threshold-num

Description Threshold for the entire zone

Type: number

Range: 1-2147483647

zone-threshold-str

Description Threshold for the entire zone (Non-zero floating point)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters