.. _fw_service_group_stats:

fw service-group stats
======================

Statistics for the object service-group


service-group Specification
---------------------------

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

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

	 **Collection Name**                   :ref:`1668_service-group_list`

	 **Collection URI**                    /axapi/v3/fw/service-group/{name}

	                                       

	 **Element Name**                      service-group

	 **Element URI**                       /axapi/v3/fw/service-group/{name}/stats

	 **Element Attributes**                service-group_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`service-group schema <fw-service-group-stats/fw-service-group-stats.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/fw/service-group/{name}



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}/stats



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}/stats



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}/stats



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}



.. raw:: html

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


:ref:`1668_service-group_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/fw/service-group/{name}/stats



.. raw:: html

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


:ref:`1668_service-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1668_service-group_list:

service-group-list
------------------


    service-group-list is **JSON List** of :ref:`1668_service-group_attributes` 

        service-group-list : [

             { :ref:`1668_service-group_attributes` },

             { :ref:`1668_service-group_attributes` },

             ...

         ]

.. _1668_service-group_attributes:

service-group attributes
------------------------

    **member-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/fw/service-group/{name}/member/{name}+{port} <fw_service_group>`

    **name**

        **Description** FW Service Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1668_stats` 

        **Type:** Object

.. _1668_member-list:

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

	 **Block object keys**             

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

    **name**

        **Description** Member name

        **Type:** string

        **Format:** comp-string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 1-65534

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1668_member-list_stats` 

        **Type:** Object

.. _1668_member-list_stats:

member-list_stats
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **curr_conn**

        **Description** Current connections

        **Type:** number

        **Format:** counter

    **curr_conn_overflow**

        **Description** Current connection counter overflow count

        **Type:** number

        **Format:** counter

    **curr_req**

        **Description** Current requests

        **Type:** number

        **Format:** counter

    **curr_ssl_conn**

        **Description** Current SSL connections

        **Type:** number

        **Format:** counter

    **fastest_rsp_time**

        **Description** Fastest response time

        **Type:** number

        **Format:** counter

    **peak_conn**

        **Description** Peak connections

        **Type:** number

        **Format:** counter

    **response_time**

        **Description** Response time

        **Type:** number

        **Format:** counter

    **slowest_rsp_time**

        **Description** Slowest response time

        **Type:** number

        **Format:** counter

    **state_flaps**

        **Description** State flaps count

        **Type:** number

        **Format:** counter

    **total_conn**

        **Description** Total connections

        **Type:** number

        **Format:** counter

    **total_fwd_bytes**

        **Description** Total forward bytes

        **Type:** number

        **Format:** counter

    **total_fwd_pkts**

        **Description** Total forward packets

        **Type:** number

        **Format:** counter

    **total_req**

        **Description** Total requests

        **Type:** number

        **Format:** counter

    **total_req_succ**

        **Description** Total requests success

        **Type:** number

        **Format:** counter

    **total_rev_bytes**

        **Description** Total reverse bytes

        **Type:** number

        **Format:** counter

    **total_rev_pkts**

        **Description** Total reverse packets

        **Type:** number

        **Format:** counter

    **total_rev_pkts_inspected**

        **Description** Total reverse packets inspected

        **Type:** number

        **Format:** counter

    **total_rev_pkts_inspected_status_code_2xx**

        **Description** Total reverse packets inspected status code 2xx

        **Type:** number

        **Format:** counter

    **total_rev_pkts_inspected_status_code_non_5xx**

        **Description** Total reverse packets inspected status code non 5xx

        **Type:** number

        **Format:** counter

    **total_ssl_conn**

        **Description** Total SSL connections

        **Type:** number

        **Format:** counter

.. _1668_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **server_selection_fail_drop**

        **Description** Service selection fail drop

        **Type:** number

        **Format:** counter

    **server_selection_fail_reset**

        **Description** Service selection fail reset

        **Type:** number

        **Format:** counter

    **service_peak_conn**

        **Description** Service peak connection

        **Type:** number

        **Format:** counter