ddos dns-cache sharded-domain-group¶

DNS Sharded Domain Group

sharded-domain-group Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name sharded-domain-group-list

Collection URI /axapi/v3/ddos/dns-cache/{name}/sharded-domain-group

Element Name sharded-domain-group

Element URI /axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}

Element Attributes sharded-domain-group_attributes

Partition Visibility shared

Schema sharded-domain-group schema

Operations Allowed:

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

sharded-domain-group-list¶

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

sharded-domain-group-list : [

{ sharded-domain-group attributes },

{ sharded-domain-group attributes },

…

]

sharded-domain-group attributes¶

encap-template

Description DDOS encap template to sepcify the tunnel endpoint

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

match-action

Description ‘forward’: Forward query to server (default); ‘tunnel-encap’: Encapsulate the query and send on a tunnel;

Type: string

Supported Values: forward, tunnel-encap

Default: forward

name

Description DNS sharded domain group

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

sharded-domain-list-policy-list

Type: List

Reference Object: /axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}/sharded-domain-list-policy/{name}

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

sharded-domain-list-policy-list¶

Specification Value

Type list

Block object keys

client-ipv4

Description Client ipv4 address

Type: string

Format: ipv4-address

client-ipv6

Description Client ipv6 address

Type: string

Format: ipv6-address

force

Description Force update even the serial is the same

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

manual-refresh

Description Manually refresh the particular zone

Type: string

Format: string-rlx

Maximum Length: 253 characters

Maximum Length: 1 characters

name

Description DNS sharded domain list policy

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

packet-capturing

Description: packet-capturing is a JSON Block. Please see below for sharded-domain-list-policy-list_packet-capturing

Type: Object

Reference Object: /axapi/v3/ddos/dns-cache/{name}/sharded-domain-group/{name}/sharded-domain-list-policy/{name}/packet-capturing

refresh-interval-hours

Description Zone transfer refresh rate in hours (Default 4). 0 means no refresh

Type: number

Range: 0-24

Default: 4

server-ipv4

Description Master ipv4 address

Type: string

Format: ipv4-address

server-ipv6

Description Master ipv6 address

Type: string

Format: ipv6-address

server-v4-port

Description Port number (default 53)

Type: number

Range: 1-65535

Default: 53

server-v6-port

Description Port number (default 53)

Type: number

Range: 1-65535

Default: 53

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

sharded-domain-list-policy-list_packet-capturing¶

Specification Value

Type object

root-zone-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sharded-domain-list-policy-list_packet-capturing_root-zone-list¶

Specification Value

Type list

Block object keys

capture-config

Description Capture-config name

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/capture-config

capture-mode

Description ‘regular’: Capture packet anyway; ‘capture-on-failure’: Capture packet if last XFR was failed;

Type: string

Supported Values: regular, capture-on-failure

root-zone

Description Specify root zone to be captured

Type: string

Format: string-rlx

Maximum Length: 253 characters

Maximum Length: 1 characters