gslb policy dns¶

DNS related policy

dns Specification¶

Parameter Value

Type Configuration Resource

Element Name dns

Element URI /axapi/v3/gslb/policy/{name}/dns

Element Attributes dns_attributes

Partition Visibility shared

Schema dns schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/gslb/policy/{name}/dns	dns attributes
POST /axapi/v3/gslb/policy/a/dns Payload: { "dns": { "action": 1 } }
Get Object	GET	/axapi/v3/gslb/policy/{name}/dns	dns attributes
GET /axapi/v3/gslb/policy/a/dns Reponse: { "dns": { "action": 1, "active-only": 0, "dns-addition-mx": 0, "dns-auto-map": 0, "backup-alias": 0, "backup-server": 0, "external-ip": 1, "external-soa": 0, "cname-detect": 1, "ip-replace": 0, "geoloc-alias": 0, "geoloc-action": 0, "geoloc-policy": 0, "selected-only": 0, "cache": 0, "delegation": 0, "hint": "addition", "ttl": 10, "server": 0, "block-action": 0, "sticky": 0, "dynamic-preference": 0, "dynamic-weight": 0, "uuid": "42c49bde-4fbc-11ee-90ee-1526419766bc", "a10-url": "/axapi/v3/gslb/policy/a/dns" } }
Modify Object	POST	/axapi/v3/gslb/policy/{name}/dns	dns attributes
Replace Object	PUT	/axapi/v3/gslb/policy/{name}/dns	dns attributes
PUT /axapi/v3/gslb/policy/a/dns Payload: { "dns": { "action": 0 } }
Delete Object	DELETE	/axapi/v3/gslb/policy/{name}/dns	dns attributes
DELETE /axapi/v3/gslb/policy/a/dns Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

dns attributes¶

action

Description Apply DNS action for service

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

action-type

Description ‘drop’: Drop query; ‘reject’: Send refuse response; ‘ignore’: Send empty response;

Type: string

Supported Values: drop, reject, ignore

active-only

Description Only keep active servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

active-only-fail-safe

Description Continue if no candidate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

aging-time

Description Specify aging-time, default is TTL in DNS record, unit: second (Aging time, default 0 means using TTL in DNS record as aging time)

Type: number

Range: 0-1000000000

Default: 0

backup-alias

Description Return alias name when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

backup-server

Description Return fallback server when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

block-action

Description Specify Action

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

block-type

Description

Type: string

Format: enum-list

block-value

Type: List

cache

Description Cache DNS Server response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cname-detect

Description Apply GSLB for DNS Server response when service is Canonical Name (CNAME)

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

delegation

Description Zone Delegation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-addition-mx

Description Append MX Records in Addition Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-auto-map

Description Automatically build DNS Infrastructure

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic-preference

Description Make dynamically change the preference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic-weight

Description dynamically change the weight

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

external-ip

Description Return DNS response with external IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

external-soa

Description Return DNS response with external SOA Record

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-action

Description Apply DNS action by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-alias

Description Return alias name by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geoloc-policy

Description Apply different policy by geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hint

Description ‘none’: None; ‘answer’: Append Hint Records in DNS Answer Section; ‘addition’: Append Hint Records in DNS Addition Section;

Type: string

Supported Values: none, answer, addition

Default: addition

ip-replace

Description Replace DNS Server Response with GSLB Service-IPs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6

Type: List

logging

Description ‘none’: None; ‘query’: DNS Query; ‘response’: DNS Response; ‘both’: Both DNS Query and Response;

Type: string

Supported Values: none, query, response, both

proxy-block-port-range-list

Type: List

selected-only

Description Only keep selected servers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

selected-only-value

Description Answer Number

Type: number

Range: 1-128

server

Description Run GSLB as DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-addition-mx

Description Append MX Records in Addition Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-any

Description Provide All Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server-any and server-any-with-metric are mutually exclusive

server-any-with-metric

Description Provide All Records with GSLB Metrics applied to A/AAAA Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server-any-with-metric and server-any are mutually exclusive

server-authoritative

Description As authoritative server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-auto-ns

Description Provide A-Records for NS-Records automatically

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-auto-ptr

Description Provide PTR Records automatically

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-caa

Description Provide CAA Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-cname

Description Provide CNAME Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-custom

Description Provide Custom Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-full-list

Description Append All A Records in Authoritative Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-mode-only

Description Only run GSLB as DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server-mode-only and zone-owner-mode are mutually exclusive

server-mx

Description Provide MX Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-naptr

Description Provide NAPTR Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ns

Description Provide NS Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ns-list

Description Append All NS Records in Authoritative Section

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-ptr

Description Provide PTR Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-sec

Description Provide DNSSEC support

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-srv

Description Provide SRV Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-txt

Description Provide TXT Records

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sticky

Description Make DNS Record sticky for certain time

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sticky-aging-time

Description Specify aging-time, unit: min, default is 5 (Aging time)

Type: number

Range: 1-65535

Default: 5

sticky-ipv6-mask

Description Specify IPv6 mask length, default is 128

Type: number

Range: 1-128

Default: 128

sticky-mask

Description Specify IP mask, default is /32

Type: string

Format: ipv4-netmask-brief

Default: /32

template

Description Logging template (Logging Template Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/logging

ttl

Description Specify the TTL value contained in DNS record (TTL value, unit: second, default is 10)

Type: number

Range: 0-1000000000

Default: 10

Mutual Exclusion: ttl and use-server-ttl are mutually exclusive

use-server-ttl

Description Use DNS Server Response TTL value in GSLB Proxy mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: use-server-ttl and ttl are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

zone-owner-mode

Description Only run GSLB as DNS server mode with zone ownership

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: zone-owner-mode and server-mode-only are mutually exclusive

block-value¶

Specification Value

Type list

Block object keys

block-value

Description Specify Type Number

Type: number

Range: 1-255

ipv6¶

Specification Value

Type list

Block object keys

dns-ipv6-mapping-type

Description ‘addition’: Append Mapped Record in DNS Addition Section; ‘answer’: Append Mapped Record in DNS Answer Section; ‘exclusive’: Only return AAAA Record; ‘replace’: Replace Record with Mapped Record;

Type: string

Supported Values: addition, answer, exclusive, replace

dns-ipv6-option

Description ‘mix’: Return both AAAA Record and A Record; ‘smart’: Return AAAA Record by DNS Query Type; ‘mapping’: Map A Record to AAAA Record;

Type: string

Supported Values: mix, smart, mapping

proxy-block-port-range-list¶

Specification Value

Type list

Block object keys

proxy-block-range-from

Description Specify Type Range (From)

Type: number

proxy-block-range-to

Description To

Type: number