.. _gslb_zone: gslb zone ========= Specify the DNS zone name for which global SLB is provided zone Specification ------------------ ===================================== ========================================================= **Parameter** **Value** ===================================== ========================================================= **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`1811_zone_list` **Collection URI** /axapi/v3/gslb/zone **Element Name** zone **Element URI** /axapi/v3/gslb/zone/{name} **Element Attributes** zone_attributes **Partition Visibility** shared **Statistics Data URI** /axapi/v3/gslb/zone/{name}/stats **Operational Data URI** /axapi/v3/gslb/zone/{name}/oper **Schema** :download:`zone schema ` ===================================== ========================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/gslb/zone .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/gslb/zone .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/gslb/zone/{name} .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/gslb/zone .. raw:: html :ref:`1811_zone_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/gslb/zone/{name} .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/gslb/zone/{name} .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/gslb/zone .. raw:: html :ref:`1811_zone_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/gslb/zone/{name} .. raw:: html :ref:`1811_zone_attributes` .. raw:: html
.. _1811_zone_list: zone-list --------- zone-list is **JSON List** of :ref:`1811_zone_attributes` zone-list : [ { :ref:`1811_zone_attributes` }, { :ref:`1811_zone_attributes` }, ... ] .. _1811_zone_attributes: zone attributes --------------- **disable** **Description** Disable all services in the GSLB zone **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns-caa-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata} ` **dns-mx-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name} ` **dns-ns-record-list** **Type:** List **Reference Object:** :doc:`/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 :ref:`1811_dns-soa-record` **Type:** Object **name** **Description** Specify the name for the DNS zone **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **policy** **Description** Specify the policy for this zone (Specify policy name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** default **sampling-enable** **Type:** List **service-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name} ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1811_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 **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1811_dns-ns-record-list: 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1811_dns-ns-record-list_sampling-enable: 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 .. _1811_dns-caa-record-list: 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 .. _1811_dns-caa-record-list_sampling-enable: dns-caa-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 .. _1811_dns-mx-record-list: 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1811_dns-mx-record-list_sampling-enable: 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 .. _1811_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'received-query': Total Number of DNS queries received for the zone; 'sent-response': Total Number of DNS replies sent to clients for the zone; 'proxy-mode-response': Total Number of DNS replies sent to clients by the ACOS device as a DNS proxy for the zone; 'cache-mode-response': Total Number of cached DNS replies sent to clients by the ACOS device for the zone. (This statistic applies only if the DNS cac; 'server-mode-response': Total Number of DNS replies sent to clients by the ACOS device as a DNS server for the zone. (This statistic applies only if th; 'sticky-mode-response': Total Number of DNS replies sent to clients by the ACOS device to keep the clients on the same site. (This statistic applies on; 'backup-mode-response': Total 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 .. _1811_template: template ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dnssec** **Description** Specify DNSSEC template (Specify template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1811_dns-soa-record: dns-soa-record ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **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** Specify Expire Time Interval, default is 1209600 **Type:** number **Range:** 0-2147483647 **Default:** 1209600 **external** **Description** Specify External SOA Record (DNS Server Name) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **mail** **Description** Mailbox **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **refresh** **Description** Specify Refresh Time Interval, default is 3600 **Type:** number **Range:** 0-2147483647 **Default:** 3600 **retry** **Description** Specify Retry Time Interval, default is 900 **Type:** number **Range:** 0-2147483647 **Default:** 900 **serial** **Description** Specify Serial Number, default is Current Time (Time Interval) **Type:** number **Range:** 0-2147483647 **soa-name** **Description** DNS Server Name **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **soa-ttl** **Description** Specify Negative caching TTL, default is Zone TTL **Type:** number **Range:** 0-2147483647 .. _1811_service-list: service-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 :ref:`1811_service-list_dns-a-record` **Type:** Object **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record ` **dns-caa-record-list** **Type:** List **Reference Object:** :doc:`/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:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name} ` **dns-mx-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-mx-record/{mx-name} ` **dns-naptr-record-list** **Type:** List **Reference Object:** :doc:`/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:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ns-record/{ns-name} ` **dns-ptr-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-ptr-record/{ptr-name} ` **dns-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-record/{type} ` **dns-srv-record-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-srv-record/{srv-name}+{port} ` **dns-txt-record-list** **Type:** List **Reference Object:** :doc:`/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:** :doc:`/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 .. _1811_service-list_dns-ptr-record-list: service-list_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 .. _1811_service-list_dns-ptr-record-list_sampling-enable: service-list_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 .. _1811_service-list_geo-location-list: service-list_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 .. _1811_service-list_geo-location-list_alias: service-list_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 .. _1811_service-list_dns-cname-record-list: service-list_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 .. _1811_service-list_dns-cname-record-list_sampling-enable: service-list_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 .. _1811_service-list_dns-txt-record-list: service-list_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 .. _1811_service-list_dns-txt-record-list_sampling-enable: service-list_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 .. _1811_service-list_dns-naptr-record-list: service-list_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 .. _1811_service-list_dns-naptr-record-list_sampling-enable: service-list_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 .. _1811_service-list_health-check-port: service-list_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 .. _1811_service-list_dns-record-list: service-list_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 .. _1811_service-list_dns-a-record: service-list_dns-a-record ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dns-a-record-ipv4-list** **Type:** List **Reference Object:** :doc:`/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:** :doc:`/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:** :doc:`/axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-a-record/dns-a-record-srv/{svrname} ` .. _1811_service-list_dns-a-record_dns-a-record-ipv6-list: service-list_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 .. _1811_service-list_dns-a-record_dns-a-record-ipv4-list: service-list_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 .. _1811_service-list_dns-a-record_dns-a-record-srv-list: service-list_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:** :doc:`/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 .. _1811_service-list_dns-ns-record-list: service-list_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 .. _1811_service-list_dns-ns-record-list_sampling-enable: service-list_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 .. _1811_service-list_dns-caa-record-list: service-list_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 .. _1811_service-list_dns-caa-record-list_sampling-enable: service-list_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 .. _1811_service-list_dns-mx-record-list: service-list_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 .. _1811_service-list_dns-mx-record-list_sampling-enable: service-list_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 .. _1811_service-list_sampling-enable: service-list_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 .. _1811_service-list_dns-srv-record-list: service-list_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 .. _1811_service-list_dns-srv-record-list_sampling-enable: service-list_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