gslb zone

Configure a GSLB zone, which identifies the top-level name for the services load balanced by GSLB.

zone Specification

Type Collection
Object Key(s) name
Collection Name zone-list
Collection URI /axapi/v3/gslb/zone/
Element Name zone
Element URI /axapi/v3/gslb/zone/{name}
Element Attributes zone_attributes
Operational Data URI /axapi/v3/gslb/zone/{name}/oper
Schema zone schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/gslb/zone/

zone Attributes

Create List

POST

/axapi/v3/gslb/zone/

zone Attributes

Get Object

GET

/axapi/v3/gslb/zone/{name}

zone Attributes

Get List

GET

/axapi/v3/gslb/zone/

zone-list

Modify Object

POST

/axapi/v3/gslb/zone/{name}

zone Attributes

Replace Object

PUT

/axapi/v3/gslb/zone/{name}

zone Attributes

Replace List

PUT

/axapi/v3/gslb/zone/

zone-list

Delete Object

DELETE

/axapi/v3/gslb/zone/{name}

zone Attributes

Get Oper

GET

/axapi/v3/gslb/zone/{name}/oper

operational data

zone-list

zone-list is JSON List of zone Attributes

zone-list : [

zone Attributes

disable

Description: Disables all services in the GSLB zone.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-mx-record-list

Description: dns-mx-record-list is a JSON List . Please see below for dns-mx-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}

dns-ns-record-list

Description: dns-ns-record-list is a JSON List . Please see below for dns-ns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/dns-ns-record/{ns-name}

dns-soa-record

Description: dns-soa-record is a JSON Block . Please see below for dns-soa-record

Type: Object

name

Description: Specify the name for the DNS zone. You can use lower case characters and upper case characters. However, since Internet domain names are case-insensitive, the ACOS device internally converts all upper case characters in GSLB zone names to lower case.

Type: string

Format: string-rlx

Required: Yes

policy

Description: Applies the specified GSLB policy to the zone. You can specify default for the GSLB policy name, if you have not configured another policy and applied it to the zone. The GSLB policy applied to the zone is also applied to the services in that zone.

Type: string

Default: default

service-list

Description: service-list is a JSON List . Please see below for service-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}

template

Description: template is a JSON Block . Please see below for template

Type: Object

ttl

Description: Specify the zone ttl value (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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

dns-ns-record-list

Specification
Type list
Block object keys

ns-name

Description: Specify Domain Name

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

dns-ns-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

dns-mx-record-list

Specification
Type list
Block object keys

mx-name

Description: Specify Domain Name

Type: string

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

dns-mx-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

template

Specification
Type object

dnssec

Description: Specify the DNSSEC template name to bind to the zone.

Type: string

dns-soa-record

Specification
Type object

ex-expire

Description: Specify Expire Time Interval, default is 1209600

Type: number

Range: 0-2147483647

Default: 1209600

ex-mail

Description: Mailbox

Type: string

ex-refresh

Description: Specify Refresh Time Interval, default is 3600

Type: number

Range: 0-2147483647

Default: 3600

ex-retry

Description: Specify Retry Time Interval, default is 900

Type: number

Range: 0-2147483647

Default: 900

ex-serial

Description: Specify Serial Number, default is Current Time (Time Interval)

Type: number

Range: 0-2147483647

ex-soa-ttl

Description: Specify Negative caching TTL, default is Zone TTL

Type: number

Range: 0-2147483647

expire

Description: Specifies how many seconds GSLB can remain unresponsive to a refresh request before the other DNS server drops responding to queries for the zone.

Type: number

Range: 0-2147483647

Default: 1209600

external

Description: Causes the ACOS device to replace the internal SOA record with an external SOA record when a request is received from an external client. This prevents external clients from gaining access to internal information. The feature must also be enabled in the GSLB policy.

Type: string

mail

Description: Specify the DNS server mailbox name.

Type: string

refresh

Description: Specifies the number of seconds other DNS servers wait before requesting updated information for the GSLB zone.

Type: number

Range: 0-2147483647

Default: 3600

retry

Description: Specifies how many seconds other DNS servers wait before resending a refresh request, if GSLB does not respond to the previous request.

Type: number

Range: 0-2147483647

Default: 900

serial

Description: Specifies the initial serial number of the SOA record. This number is automatically incremented each time a change occurs to any records in the zone file. The default is based on the current system time on the GSLB ACOS device when you create the SOA record.

Type: number

Range: 0-2147483647

soa-name

Description: Specify the DNS server name.

Type: string

soa-ttl

Description: Specifies the number of seconds GSLB will cache and reuse negative replies (NXDOMAIN messages). A negative reply is an error message indicating that a requested domain does not exist.

Type: number

Range: 0-2147483647

service-list

Specification
Type list
Block object keys

action

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

Type: string

Supported Values: drop, forward, ignore, reject

disable

Description: Disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record

Description: dns-a-record is a JSON Block . Please see below for l718_dns-a-record

Type: Object

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record

dns-cname-record-list

Description: dns-cname-record-list is a JSON List . Please see below for l718_dns-cname-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name}

dns-mx-record-list

Description: dns-mx-record-list is a JSON List . Please see below for dns-mx-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-mx-record/{mx-name}

dns-ns-record-list

Description: dns-ns-record-list is a JSON List . Please see below for dns-ns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ns-record/{ns-name}

dns-ptr-record-list

Description: dns-ptr-record-list is a JSON List . Please see below for l718_dns-ptr-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ptr-record/{ptr-name}

dns-record-list

Description: dns-record-list is a JSON List . Please see below for l718_dns-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-record/{type}

dns-srv-record-list

Description: dns-srv-record-list is a JSON List . Please see below for l718_dns-srv-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-srv-record/{srv-name}+{port}

dns-txt-record-list

Description: dns-txt-record-list is a JSON List . Please see below for l718_dns-txt-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-txt-record/{record-name}

forward-type

Description: ‘both’: Forward both query and response; ‘query’: Forward query; ‘response’: Forward response;

Type: string

Supported Values: both, query, response

geo-location-list

Description: geo-location-list is a JSON List . Please see below for l718_geo-location-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/geo-location/{geo-name}

health-check-gateway

Description: ‘enable’: Enable Gateway Status Check; ‘disable’: Disable Gateway Status Check;

Type: string

Supported Values: enable, disable

Default: enable

health-check-port

Description: health-check-port is a JSON List . Please see below for l718_health-check-port

Type: List

policy

Description: Specify policy for this service (Specify policy name)

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

service-name

Description: Specify the service name for the zone, * for wildcard

Type: string

Format: string-rlx

service-port

Description: Port number of the service

Type: number

Range: 0-65534

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-list.dns-a-record

Specification
Type object

dns-a-record-ipv4-list

Description: dns-a-record-ipv4-list is a JSON List . Please see below for l718_dns-a-record-ipv4-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv4/{dns-a-record-ip}

dns-a-record-ipv6-list

Description: dns-a-record-ipv6-list is a JSON List . Please see below for l718_dns-a-record-ipv6-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-ipv6/{dns-a-record-ipv6}

dns-a-record-srv-list

Description: dns-a-record-srv-list is a JSON List . Please see below for l718_dns-a-record-srv-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-srv/{svrname}

service-list.dns-a-record.dns-a-record-ipv6-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record-ipv6

Description: IPV6 address

Type: string

Format: ipv6-address

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

service-list.dns-a-record.dns-a-record-ipv6-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-a-record.dns-a-record-ipv4-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dns-a-record-ip

Description: Specify IP address

Type: string

Format: ipv4-address

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

service-list.dns-a-record.dns-a-record-ipv4-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-a-record.dns-a-record-srv-list

Specification
Type list
Block object keys

admin-ip

Description: Specify admin priority of Service-IP (Specify the priority)

Type: number

Range: 1-255

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

as-replace

Description: Return this Service-IP when enable ip-replace

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description: Disable this Service-IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-resp

Description: Don’t use this Service-IP as DNS response

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

static

Description: Return this Service-IP in DNS server mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

svrname

Description: Specify name

Type: string

Reference Object: /axapi/v3/gslb/service-ip

ttl

Description: Specify TTL for Service-IP

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

service-list.dns-a-record.dns-a-record-srv-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.health-check-port

Specification
Type list
Block object keys

health-check-port

Description: Check Related Port Status (Port Number)

Type: number

Range: 0-65534

service-list.dns-txt-record-list

Specification
Type list
Block object keys

record-name

Description: Specify the Object Name for TXT Data

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

txt-data

Description: Specify TXT Data

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-list.dns-txt-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-mx-record-list

Specification
Type list
Block object keys

mx-name

Description: Specify Domain Name

Type: string

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

service-list.dns-mx-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-record-list

Specification
Type list
Block object keys

data

Description: Specify DNS Data

Type: string

Format: string-rlx

type

Description: Specify DNS Type

Type: number

Range: 1-65535

uuid

Description: uuid of the object

Type: string

service-list.dns-ns-record-list

Specification
Type list
Block object keys

ns-name

Description: Specify Domain Name

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

service-list.dns-ns-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘received-query’: Number of DNS queries received for the service; ‘sent-response’: Number of DNS replies sent to clients for the service; ‘proxy-mode-response’: Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service; ‘cache-mode-response’: Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache; ‘server-mode-response’: Number of DNS replies sent to clients by the ACOS device as a DNS server for the service. (This statistic applies only if the D; ‘sticky-mode-response’: Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if; ‘backup-mode-response’: help Number of DNS replies sent to clients by the ACOS device in backup mode;

Type: string

Supported Values: all, received-query, sent-response, proxy-mode-response, cache-mode-response, server-mode-response, sticky-mode-response, backup-mode-response

service-list.dns-srv-record-list

Specification
Type list
Block object keys

port

Description: Specify Port (Port Number)

Type: number

Range: 0-65534

priority

Description: Specify Priority

Type: number

Range: 0-65535

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

srv-name

Description: Specify Domain Name

Type: string

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

weight

Description: Specify Weight, default is 10

Type: number

Range: 1-100

Default: 10

service-list.dns-srv-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-ptr-record-list

Specification
Type list
Block object keys

ptr-name

Description: Specify Domain Name

Type: string

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l718_sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

service-list.dns-ptr-record-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘hits’: Number of times the record has been used;

Type: string

Supported Values: all, hits

service-list.dns-cname-record-list

Specification
Type list
Block object keys

admin-preference

Description: Specify Administrative Preference, default is 100

Type: number

Range: 0-255

Default: 100

alias-name

Description: Specify the alias name

Type: string

as-backup

Description: As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

weight

Description: Specify Weight, default is 1

Type: number

Range: 1-100

Default: 1

service-list.geo-location-list

Specification
Type list
Block object keys

action

Description: Action for this geo-location

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: action and policy are mutually exclusive

action-type

Description: ‘allow’: Allow query from this geo-location; ‘drop’: Drop query from this geo-location; ‘forward’: Forward packet for this geo-location; ‘ignore’: Send empty response to this geo-location; ‘reject’: Send refuse response to this geo-location;

Type: string

Supported Values: allow, drop, forward, ignore, reject

alias

Description: alias is a JSON List . Please see below for l718_alias

Type: List

forward-type

Description: ‘both’: Forward both query and response; ‘query’: Forward query from this geo-location; ‘response’: Forward response to this geo-location;

Type: string

Supported Values: both, query, response

geo-name

Description: Specify the geo-location

Type: string

policy

Description: Policy for this geo-location (Specify the policy name)

Type: string

Mutual Exclusion: policy and action are mutually exclusive

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

service-list.geo-location-list.alias

Specification
Type list
Block object keys

alias

Description: Send CNAME response for this geo-location (Specify a CNAME record)

Type: string

operational data

Name Type Description
state string state