slb template dns

DNS template

dns Specification

Type	Collection
Object Key(s)	name
Collection Name	dns-list
Collection URI	/axapi/v3/slb/template/dns
Element Name	dns
Element URI	/axapi/v3/slb/template/dns/{name}
Element Attributes	dns_attributes
Schema	dns schema

Operations Allowed:

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

dns-list

dns-list is JSON List of dns attributes

dns-list : [

{ dns attributes },

{ dns attributes },

…

]

dns attributes

class-list

Description: class-list is a JSON Block. Please see below for class-list

Type: Object

Reference Object: /axapi/v3/slb/template/dns/{name}/class-list

default-policy

Description ‘nocache’: Cache disable; ‘cache’: Cache enable;

Type: string

Supported Values: nocache, cache

Default: nocache

disable-dns-template

Description Disable DNS template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dnssec-service-group

Description Use different service group if DNSSEC DO bit set (Service Group Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/service-group

drop

Description Drop the malformed query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: drop and forward are mutually exclusive

enable-cache-sharing

Description Enable DNS cache sharing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

forward

Description Forward to service group (Service group name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: forward and drop are mutually exclusive

Reference Object: /axapi/v3/slb/service-group

max-cache-entry-size

Description Define maximum cache entry size (Maximum cache entry size per VIP)

Type: number

Range: 1-4096

max-cache-size

Description Define maximum cache size (Maximum cache entry per VIP)

Type: number

max-query-length

Description Define Maximum DNS Query Length, default is unlimited (Specify Maximum Length)

Type: number

Range: 1-4095

name

Description DNS Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

period

Description Period in minutes

Type: number

Range: 1-10000

query-id-switch

Description Use DNS query ID to create sesion

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redirect-to-tcp-port

Description Direct the client to retry with TCP for DNS UDP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

response-rate-limiting

Description: response-rate-limiting is a JSON Block. Please see below for response-rate-limiting

Type: Object

Reference Object: /axapi/v3/slb/template/dns/{name}/response-rate-limiting

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

class-list

Specification
Type	object

lid-list

Type: List

Reference Object: /axapi/v3/slb/template/dns/{name}/class-list/lid/{lidnum}

name

Description Specify a class list name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

class-list_lid-list

Specification
Type	list
Block object keys

action-value

Description ‘dns-cache-disable’: Disable DNS cache when it exceeds limit; ‘dns-cache-enable’: Enable DNS cache when it exceeds limit; ‘forward’: Forward the traffic even it exceeds limit;

Type: string

Supported Values: dns-cache-disable, dns-cache-enable, forward

conn-rate-limit

Description Connection rate limit

Type: number

Range: 1-2147483647

dns

Description: dns is a JSON Block. Please see below for class-list_lid-list_dns

Type: Object

lidnum

Description Specify a limit ID

Type: number

Range: 1-1023

lockout

Description Don’t accept any new connection for certain time (Lockout duration in minutes)

Type: number

Range: 1-1023

log

Description Log a message

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-interval

Description Log interval (minute, by default system will log every over limit instance)

Type: number

Range: 1-255

over-limit-action

Description Action when exceeds limit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

per

Description Per (Number of 100ms)

Type: number

Range: 1-65535

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

class-list_lid-list_dns

Specification
Type	object

cache-action

Description ‘cache-disable’: Disable dns cache; ‘cache-enable’: Enable dns cache;

Type: string

Supported Values: cache-disable, cache-enable

Default: cache-disable

honor-server-response-ttl

Description Honor the server reponse TTL

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description TTL for cache entry (TTL in seconds)

Type: number

Range: 1-65535

weight

Description Weight for cache entry

Type: number

Range: 1-7

response-rate-limiting

Specification
Type	object

action

Description ‘log-only’: Only log rate-limiting, do not actually rate limit. Requires enable-log configuration; ‘rate-limit’: Rate-Limit based on configuration (Default); ‘whitelist’: Whitelist, disable rate-limiting;

Type: string

Supported Values: log-only, rate-limit, whitelist

Default: rate-limit

enable-log

Description Enable logging

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

filter-response-rate

Description Maximum allowed request rate for the filter. This should match average traffic. (default 20 per two seconds)

Type: number

Range: 1-1000

Default: 20

response-rate

Description Responses exceeding this rate within the window will be dropped (default 5 per second)

Type: number

Range: 1-1000

Default: 5

slip-rate

Description Every n’th response that would be rate-limited will be let through instead

Type: number

Range: 2-10

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

window

Description Rate-Limiting Interval in Seconds (default is one)

Type: number

Range: 1-60

Default: 1