gslb zone service¶

Service information for the GSLB zone

service Specification¶

Parameter Value

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

Partition Visibility shared

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

service-list¶

service-list is JSON List of service attributes

service-list : [

{ service attributes },

{ service attributes },

…

]

service attributes¶

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 dns-a-record

Type: Object

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

dns-caa-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata}

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

Type: List

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

dns-naptr-record-list

Type: List

Reference Object: /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-naptr-record/{naptr-target}+{service-proto}+{flag}

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

Type: List

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

dns-record-list

Type: List

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

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

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

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

Type: List

policy

Description Specify policy for this service (Specify policy name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

sampling-enable

Type: List

service-name

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

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default:

service-port

Description Port number of the service

Type: number

Range: 0-65534

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

dns-ptr-record-list¶

Specification Value

Type list

Block object keys

ptr-name

Description Specify Domain Name

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

sampling-enable

Type: List

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-ptr-record-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

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

Type: string

Supported Values: all, hits

geo-location-list¶

Specification Value

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

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

Maximum Length: 127 characters

Maximum Length: 1 characters

policy

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

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Mutual Exclusion: policy and action are mutually exclusive

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

geo-location-list_alias¶

Specification Value

Type list

Block object keys

alias

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

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

dns-cname-record-list¶

Specification Value

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

Maximum Length: 127 characters

Maximum Length: 1 characters

as-backup

Description As backup when fail

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Specify Weight, default is 1

Type: number

Range: 1-100

Default: 1

dns-cname-record-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘cname-hits’: Number of times the CNAME has been used;

Type: string

Supported Values: all, cname-hits

dns-txt-record-list¶

Specification Value

Type list

Block object keys

record-name

Description Specify the Object Name for TXT Data

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Maximum Length: 1000 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-txt-record-list_sampling-enable¶

Specification Value

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-naptr-record-list¶

Specification Value

Type list

Block object keys

flag

Description Specify the flag (e.g., a, s). Default is empty flag

Type: string

Maximum Length: 1 characters

Maximum Length: 1 characters

Default:

naptr-target

Description Specify the replacement or regular expression

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

order

Description Specify Order

Type: number

Range: 0-65535

preference

Description Specify Preference

Type: number

Range: 0-65535

regexp

Description Return the regular expression

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Type: List

service-proto

Description Specify Service and Protocol

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-naptr-record-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘naptr-hits’: Number of times the NAPTR has been used;

Type: string

Supported Values: all, naptr-hits

health-check-port¶

Specification Value

Type list

Block object keys

health-check-port

Description Check Related Port Status (Port Number)

Type: number

Range: 0-65534

dns-record-list¶

Specification Value

Type list

Block object keys

data

Description Specify DNS Data

Type: string

Format: string-rlx

Maximum Length: 512 characters

Maximum Length: 1 characters

type

Description Specify DNS Type

Type: number

Range: 1-65535

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-a-record¶

Specification Value

Type object

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

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

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 Value

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

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

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

dns-a-record_dns-a-record-ipv4-list¶

Specification Value

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

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

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

dns-a-record_dns-a-record-srv-list¶

Specification Value

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

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

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Specify weight for Service-IP (Weight value)

Type: number

Range: 1-100

dns-ns-record-list¶

Specification Value

Type list

Block object keys

ns-name

Description Specify Domain Name

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

sampling-enable

Type: List

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-ns-record-list_sampling-enable¶

Specification Value

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-caa-record-list¶

Specification Value

Type list

Block object keys

critical-flag

Description Issuer Critical Flag

Type: number

Range: 0-255

property-tag

Description Specify other property tags, only allowed lowercase alphanumeric

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

rdata

Description Specify the Issuer Domain Name or a URL

Type: string

Format: string-rlx

Maximum Length: 1000 characters

Maximum Length: 1 characters

sampling-enable

Type: List

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-caa-record-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

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

Type: string

Supported Values: all, hits

dns-mx-record-list¶

Specification Value

Type list

Block object keys

mx-name

Description Specify Domain Name

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

priority

Description Specify Priority

Type: number

Range: 0-65535

sampling-enable

Type: List

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

dns-mx-record-list_sampling-enable¶

Specification Value

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 Value

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 Value

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

Type: List

srv-name

Description Specify Domain Name

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

ttl

Description Specify TTL

Type: number

Range: 0-2147483647

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Specify Weight, default is 10

Type: number

Range: 0-65535

Default: 10

dns-srv-record-list_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

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

Type: string

Supported Values: all, hits