.. _gslb_zone_service_geo_location:

gslb zone service geo-location
==============================

Geo location settings


geo-location Specification
--------------------------

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

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

	 **Object Key(s)**                     *geo-name*

	 **Collection Name**                   :ref:`1806_geo-location_list`

	 **Collection URI**                    /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/geo-location

	                                       

	 **Element Name**                      geo-location

	 **Element URI**                       /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/geo-location/{geo-name}

	 **Element Attributes**                geo-location_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`geo-location schema <gslb-zone-service-geo-location/gslb-zone-service-geo-location.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}/service/{service-port}+{service-name}/geo-location



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location/{geo-name}



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location/{geo-name}



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location/{geo-name}



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location



.. raw:: html

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


:ref:`1806_geo-location_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}/service/{service-port}+{service-name}/geo-location/{geo-name}



.. raw:: html

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


:ref:`1806_geo-location_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1806_geo-location_list:

geo-location-list
-----------------


    geo-location-list is **JSON List** of :ref:`1806_geo-location_attributes` 

        geo-location-list : [

             { :ref:`1806_geo-location_attributes` },

             { :ref:`1806_geo-location_attributes` },

             ...

         ]

.. _1806_geo-location_attributes:

geo-location attributes
-----------------------

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

.. _1806_alias:

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