gslb zone service

Adds service information for the GSLB zone.

service Specification

Type Collection
Object Key(s) service-port, service-name
Collection Name service-list
Collection URI /axapi/v3/gslb/zone/{name}/service/
Element Name service
Element URI /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}
Element Attributes service_attributes
Statistics Data URI /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/stats
Operational Data URI /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/oper
Schema service schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

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

service Attributes

Create List

POST

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

service Attributes

Get Object

GET

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

service Attributes

Get List

GET

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

service-list

Modify Object

POST

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

service Attributes

Replace Object

PUT

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

service Attributes

Replace List

PUT

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

service-list

Delete Object

DELETE

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

service Attributes

Get Stats

GET

/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/stats

stats data

Get Oper

GET

/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/oper

operational data

service-list

service-list is JSON List of service Attributes

service-list : [

service Attributes

action

Description: Specifies the action to perform for DNS traffic.

  • drop : Drops DNS queries from the local DNS server.
  • forward : Forwards packets based on forward-type .
  • ignore : Ignores the request.
  • reject : Rejects DNS queries from the local DNS server and returns the “Refused” message in replies.

Type: string

Supported Values: drop, forward, ignore, reject

disable

Description: Disables all services in the GSLB zone.

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 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 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 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 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 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 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: For use with forward action. Forwards requests or queries, as follows.

  • both : Forwards queries to the Authoritative DNS server, and forwards responses to the local DNS server.
  • query : Forwards queries to the Authoritative DNS server, but does not forward responses to the local DNS server.
  • response : Forwards responses to the local DNS server, but does not forward queries to the Authoritative DNS server.

Type: string

Supported Values: both, query, response

geo-location-list

Description: geo-location-list is a JSON List . Please see below for 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 or disable a health-check gateway for the service.

Type: string

Supported Values: enable, disable

Default: enable

health-check-port

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

Type: List

policy

Description: Applies the specified GSLB policy to the service. If the service policy is the default policy, then the service will automatically inherit the policy configured for the overall GSLB Zone. Any non-default policy configured for the service specifically will be honored over the GSLB Zone policy.

Type: string

sampling-enable

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

Type: List

service-name

Description: Specify the service name for the zone. For any or null-label , it’s not a service name but a comment.

Type: string

Format: string-rlx

Required: Yes

service-port

Description: Specifies the service port number.

Type: number

Range: 0-65534

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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 l717_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 l717_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 l717_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}

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 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

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

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 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

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

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 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

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

health-check-port

Specification
Type list
Block object keys

health-check-port

Description: Check Related Port Status (Port Number)

Type: number

Range: 0-65534

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 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

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

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 sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

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

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

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 sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

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

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

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 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

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

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 sampling-enable

Type: List

ttl

Description: Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description: uuid of the object

Type: string

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

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

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 l717_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

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

stats data

Counter Size Description
received-query 8 Number of DNS queries received for the service
sent-response 8 Number of DNS replies sent to clients for the service
sticky-mode-response 8 Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies only if
server-mode-response 8 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
cache-mode-response 8 Number of cached DNS replies sent to clients by the ACOS device for the service. (This statistic applies only if the DNS cache
backup-mode-response 8 help Number of DNS replies sent to clients by the ACOS device in backup mode
proxy-mode-response 8 Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the service

operational data

Name Type Description
total-sessions number total-sessions
cache-list cache-list
state string state
session-list session-list
matched number matched