tuple-filter¶

Specify a tuple filter

tuple-filter Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name tuple-filter-list

Collection URI /axapi/v3/tuple-filter

Element Name tuple-filter

Element URI /axapi/v3/tuple-filter/{name}

Element Attributes tuple-filter_attributes

Partition Visibility shared

Schema tuple-filter schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/tuple-filter	tuple-filter attributes
POST /axapi/v3/tuple-filter/ Payload: { "tuple-filter": { "filter-type": "ipv4", "name": "a" } }
Create List	POST	/axapi/v3/tuple-filter	tuple-filter attributes
Get Object	GET	/axapi/v3/tuple-filter/{name}	tuple-filter attributes
GET /axapi/v3/tuple-filter/a Reponse: { "tuple-filter": { "name": "a", "filter-type": "ipv4", "uuid": "49c6cca2-5117-11ee-b8e9-001fa0083030", "a10-url": "/axapi/v3/tuple-filter/a" } }
Get List	GET	/axapi/v3/tuple-filter	tuple-filter-list
Modify Object	POST	/axapi/v3/tuple-filter/{name}	tuple-filter attributes
Replace Object	PUT	/axapi/v3/tuple-filter/{name}	tuple-filter attributes
Replace List	PUT	/axapi/v3/tuple-filter	tuple-filter-list
Delete Object	DELETE	/axapi/v3/tuple-filter/{name}	tuple-filter attributes

tuple-filter attributes¶

filter-rule-list

Type: List

Reference Object: /axapi/v3/tuple-filter/{name}/filter-rule/{id}

filter-type

Description ‘ipv4’: IPv4 tuple filter; ‘ipv6’: IPv6 tuple filter;

Type: string

Supported Values: ipv4, ipv6

name

Description Tuple filter name

Type: string

Maximum Length: 31 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-rule-list¶

Specification Value

Type list

Block object keys

dst-addr

Description Destination IPv4 address with prefix

Type: string

Format: ipv4-cidr

dst-port

Description Destination port

Type: number

Range: 1-65535

dst-v6-addr

Description Destination IPv6 address with prefix

Type: string

Format: ipv6-address-plen

dst-v6-port

Description Destination port

Type: number

Range: 1-65535

id

Description filter rule id

Type: number

Range: 1-4

src-addr

Description Source IPv4 address with prefix

Type: string

Format: ipv4-cidr

src-port

Description Source port

Type: number

Range: 1-65535

src-v6-addr

Description Source IPv6 address with prefix

Type: string

Format: ipv6-address-plen

src-v6-port

Description Source port

Type: number

Range: 1-65535

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters