ddos zone-src-port-template tcp¶

TCP template Configuration

tcp Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name tcp-list

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

Element Name tcp

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

Element Attributes tcp_attributes

Partition Visibility shared

Schema tcp schema

Operations Allowed:

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

tcp-list¶

tcp-list is JSON List of tcp attributes

tcp-list : [

{ tcp attributes },

{ tcp attributes },

…

]

tcp attributes¶

filter-list

Type: List

Reference Object: /axapi/v3/ddos/zone-src-port-template/tcp/{name}/filter/{tcp-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

name

Description

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

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

tcp-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: tcp-filter-action and tcp-filter-action-list-name are mutually exclusive

tcp-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: tcp-filter-action-list-name and tcp-filter-action are mutually exclusive

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

tcp-filter-inverse-match

Description Inverse the result of the matching

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-filter-name

Description

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

tcp-filter-regex

Description Regex Expression

Type: string

Format: string-rlx

Maximum Length: 1275 characters

Maximum Length: 1 characters

tcp-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