.. _gslb_zone_oper:

gslb zone oper
==============

Operational Status for the object zone


zone Specification
------------------

	===================================== ==============================================================
	 **Parameter**                         **Value** 

	===================================== ==============================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`1779_zone_list`

	 **Collection URI**                    /axapi/v3/gslb/zone/{name}

	                                       

	 **Element Name**                      zone

	 **Element URI**                       /axapi/v3/gslb/zone/{name}/oper

	 **Element Attributes**                zone_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`zone schema <gslb-zone-oper/gslb-zone-oper.txt>`
	===================================== ==============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`1779_zone_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1779_zone_list:

zone-list
---------


    zone-list is **JSON List** of :ref:`1779_zone_attributes` 

        zone-list : [

             { :ref:`1779_zone_attributes` },

             { :ref:`1779_zone_attributes` },

             ...

         ]

.. _1779_zone_attributes:

zone attributes
---------------

    **dns-caa-record-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata} <gslb_zone>`

    **dns-mx-record-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name} <gslb_zone>`

    **dns-ns-record-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name} <gslb_zone>`

    **name**

        **Description** Specify the name for the DNS zone

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_oper` 

        **Type:** Object

    **service-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata}/service/{service-port}+{service-name} <gslb_zone>`

.. _1779_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **dns-soa-record-list**

        **Type:** List

    **state**

        **Description** 

        **Type:** string

.. _1779_oper_dns-soa-record-list:

oper_dns-soa-record-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **expire**

        **Description** 

        **Type:** number

    **mx-name**

        **Description** 

        **Type:** string

    **name**

        **Description** 

        **Type:** string

    **refresh**

        **Description** 

        **Type:** number

    **retry**

        **Description** 

        **Type:** number

    **serial**

        **Description** 

        **Type:** number

    **ttl**

        **Description** 

        **Type:** number

    **type**

        **Description** 

        **Type:** string

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_dns-ns-record-list_oper` 

        **Type:** Object

.. _1779_dns-ns-record-list_oper:

dns-ns-record-list_oper
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **hits**

        **Description** 

        **Type:** number

    **last-server**

        **Description** 

        **Type:** string

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_dns-caa-record-list_oper` 

        **Type:** Object

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

.. _1779_dns-caa-record-list_oper:

dns-caa-record-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **last-server**

        **Description** 

        **Type:** string

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_dns-mx-record-list_oper` 

        **Type:** Object

.. _1779_dns-mx-record-list_oper:

dns-mx-record-list_oper
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **hits**

        **Description** 

        **Type:** number

    **last-server**

        **Description** 

        **Type:** string

    **priority**

        **Description** 

        **Type:** number

.. _1779_service-list:

service-list
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **dns-mx-record-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata}/service/{service-port}+{service-name}/dns-mx-record/{mx-name} <gslb_zone>`

    **dns-ns-record-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/zone/{name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name}/dns-caa-record/{critical-flag}+{property-tag}+{rdata}/service/{service-port}+{service-name}/dns-mx-record/{mx-name}/dns-ns-record/{ns-name} <gslb_zone>`

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_service-list_oper` 

        **Type:** Object

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

.. _1779_service-list_oper:

service-list_oper
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **cache-list**

        **Type:** List

    **dns-a-record-list**

        **Type:** List

    **matched**

        **Description** 

        **Type:** number

    **session-list**

        **Type:** List

    **state**

        **Description** 

        **Type:** string

    **total-sessions**

        **Description** 

        **Type:** number

.. _1779_service-list_oper_cache-list:

service-list_oper_cache-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **additional-records**

        **Description** 

        **Type:** number

    **alias**

        **Description** 

        **Type:** string

    **answer-records**

        **Description** 

        **Type:** number

    **authority-records**

        **Description** 

        **Type:** number

    **cache-dns-flag**

        **Description** 

        **Type:** string

    **cache-length**

        **Description** 

        **Type:** number

    **cache-ttl**

        **Description** 

        **Type:** number

    **question-records**

        **Description** 

        **Type:** number

.. _1779_service-list_oper_session-list:

service-list_oper_session-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **aging**

        **Description** 

        **Type:** number

    **best**

        **Description** 

        **Type:** string

    **client**

        **Description** 

        **Type:** string

    **hits**

        **Description** 

        **Type:** number

    **last-second-hits**

        **Description** 

        **Type:** number

    **mode**

        **Description** 

        **Type:** string

    **ttl**

        **Description** 

        **Type:** string

    **update**

        **Description** 

        **Type:** number

.. _1779_service-list_oper_dns-a-record-list:

service-list_oper_dns-a-record-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ip**

        **Description** 

        **Type:** string

    **rec-ttl**

        **Description** 

        **Type:** number

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_service-list_dns-mx-record-list_oper` 

        **Type:** Object

.. _1779_service-list_dns-mx-record-list_oper:

service-list_dns-mx-record-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **hits**

        **Description** 

        **Type:** number

    **last-server**

        **Description** 

        **Type:** string

    **priority**

        **Description** 

        **Type:** number

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1779_service-list_dns-ns-record-list_oper` 

        **Type:** Object

.. _1779_service-list_dns-ns-record-list_oper:

service-list_dns-ns-record-list_oper
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **hits**

        **Description** 

        **Type:** number

    **last-server**

        **Description** 

        **Type:** string