.. _gslb_service_matching_rules:

gslb service-matching-rules
===========================

Configure service-matching rules for a GSLB zone


service-matching-rules Specification
------------------------------------

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

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

	 **Object Key(s)**                     *zone*

	 **Collection Name**                   :ref:`1807_service-matching-rules_list`

	 **Collection URI**                    /axapi/v3/gslb/service-matching-rules

	                                       

	 **Element Name**                      service-matching-rules

	 **Element URI**                       /axapi/v3/gslb/service-matching-rules/{zone}

	 **Element Attributes**                service-matching-rules_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`service-matching-rules schema <gslb-service-matching-rules/gslb-service-matching-rules.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/service-matching-rules



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules/{zone}



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules/{zone}



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules/{zone}



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules



.. raw:: html

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


:ref:`1807_service-matching-rules_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/service-matching-rules/{zone}



.. raw:: html

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


:ref:`1807_service-matching-rules_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1807_service-matching-rules_list:

service-matching-rules-list
---------------------------


    service-matching-rules-list is **JSON List** of :ref:`1807_service-matching-rules_attributes` 

        service-matching-rules-list : [

             { :ref:`1807_service-matching-rules_attributes` },

             { :ref:`1807_service-matching-rules_attributes` },

             ...

         ]

.. _1807_service-matching-rules_attributes:

service-matching-rules attributes
---------------------------------

    **disable**

        **Description** Disable rule matching on associated zone (default is enabled)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **hitcount-enable**

        **Description** Enable hit count of rule matching

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **rule-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/gslb/service-matching-rules/{zone}/rule/{seq-num} <gslb_service_matching_rules>`

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

    **zone**

        **Description** GSLB zone name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/zone <gslb_zone>`

.. _1807_rule-list:

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

	 **Block object keys**             

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

    **domain-match-string**

        **Description** Domain name string

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **domain-match-type**

        **Description** 'equals': Domain name equals to string; 'contains': Domain name contains string; 'starts-with': Domain name starts with string; 'ends-with': Domain name ends with string; 

        **Type:** string

        **Supported Values:** equals, contains, starts-with, ends-with

    **health-state**

        **Type:** List

    **seq-num**

        **Description** Sequence number of rule

        **Type:** number

        **Range:** 1-32

    **service**

        **Description** Name of zone service to be redirected

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **src-ipv4**

        **Description** Client source IPv4 subnet

        **Type:** string

        **Format:** ipv4-cidr

        **Mutual Exclusion:** src-ipv4 and src-ipv6 are mutually exclusive

    **src-ipv6**

        **Description** Client source IPv6 subnet

        **Type:** string

        **Format:** ipv6-address-plen

        **Mutual Exclusion:** src-ipv6 and src-ipv4 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

.. _1807_rule-list_health-state:

rule-list_health-state
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **gslb-service-ip**

        **Description** Health state of GSLB service-ip (GSLB service-ip name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/service-ip <gslb_service_ip>`

    **gslb-site**

        **Description** Health state of GSLB site (GSLB site name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/gslb/site <gslb_site>`

    **service-ip-state**

        **Description** 'Up': Up; 'Down': Down; 

        **Type:** string

        **Supported Values:** Up, Down

    **site-state**

        **Description** 'AllUp': AllUp; 'Down': Down; 'AllUp-or-PartUp': AllUp-or-PartUp; 'Down-or-PartUp': Down-or-PartUp; 

        **Type:** string

        **Supported Values:** AllUp, Down, AllUp-or-PartUp, Down-or-PartUp

    **slb-server**

        **Description** Health state of SLB server (SLB server name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/server <slb_server>`

    **slb-svr-state**

        **Description** 'Up': Up; 'Down': Down; 

        **Type:** string

        **Supported Values:** Up, Down