domain-group¶

Configure Domain group consisting of domain-lists

domain-group Specification¶

Type Collection

Object Key(s) name

Collection Name domain-group-list

Collection URI /axapi/v3/domain-group

Element Name domain-group

Element URI /axapi/v3/domain-group/{name}

Element Attributes domain-group_attributes

Operational Data URI /axapi/v3/domain-group/{name}/oper

Schema domain-group schema

Operations Allowed:

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

domain-group-list¶

domain-group-list is JSON List of domain-group attributes

domain-group-list : [

{ domain-group attributes },

{ domain-group attributes },

…

]

domain-group attributes¶

domain-group-list

Type: List

domain-rate-list

Type: List

Refernce Object: /axapi/v3/domain-group/{name}/domain-rate/{dummy-name}

name

Description Specify name of the domain group

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

domain-group-list¶

Specification

Type list

Block object keys

action

Description ‘permit’: permit; ‘deny’: deny;

Type: string

Supported Values: permit, deny

Default: permit

domain-list-name

Description Specify domain-list

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

domain-rate-list¶

Specification

Type list

Block object keys

domain-list-list

Type: List

Refernce Object: /axapi/v3/domain-group/{name}/domain-rate/{dummy-name}/domain-list/{name}

dummy-name

Description ‘configuration’: Configure domain group rate limit;

Type: string

Supported Values: configuration

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

domain-rate-list_domain-list-list¶

Specification

Type list

Block object keys

name

Description Specify name of the domain list

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

per-suffix-rate

Description Per suffix domain rate limit

Type: number

Range: 1-16000000

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

operational data¶

Counter	Size	Description

displayed-count	number	displayed-count
domain-group-name-filter	string	domain-group-name-filter
domain-groups		domain-groups
domain-group-entries		domain-group-entries
domain-name-filter	string	domain-name-filter