.. _cloud_services_cloud_provider_aws_multi_az_failover_vrid:

cloud-services cloud-provider aws multi-az-failover vrid
========================================================

VRID list


vrid Specification
------------------

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

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

	 **Object Key(s)**                     *vrid-number*

	 **Collection Name**                   :ref:`639_vrid_list`

	 **Collection URI**                    /axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid

	                                       

	 **Element Name**                      vrid

	 **Element URI**                       /axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}

	 **Element Attributes**                vrid_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`vrid schema <cloud-services-cloud-provider-aws-multi-az-failover-vrid/cloud-services-cloud-provider-aws-multi-az-failover-vrid.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/cloud-services/cloud-provider/aws/multi-az-failover/vrid



.. raw:: html

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


:ref:`639_vrid_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/cloud_services_cloud_provider_aws_multi_az_failover_vrid_POST.txt
   :literal:




.. raw:: html

   </div></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/cloud-services/cloud-provider/aws/multi-az-failover/vrid



.. raw:: html

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


:ref:`639_vrid_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/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}



.. raw:: html

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


:ref:`639_vrid_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/cloud_services_cloud_provider_aws_multi_az_failover_vrid_GET.txt
   :literal:




.. raw:: html

   </div></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/cloud-services/cloud-provider/aws/multi-az-failover/vrid



.. raw:: html

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


:ref:`639_vrid_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/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}



.. raw:: html

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


:ref:`639_vrid_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/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}



.. raw:: html

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


:ref:`639_vrid_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/cloud_services_cloud_provider_aws_multi_az_failover_vrid_PUT.txt
   :literal:




.. raw:: html

   </div></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/cloud-services/cloud-provider/aws/multi-az-failover/vrid



.. raw:: html

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


:ref:`639_vrid_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/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}



.. raw:: html

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


:ref:`639_vrid_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/cloud_services_cloud_provider_aws_multi_az_failover_vrid_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _639_vrid_list:

vrid-list
---------


    vrid-list is **JSON List** of :ref:`639_vrid_attributes` 

        vrid-list : [

             { :ref:`639_vrid_attributes` },

             { :ref:`639_vrid_attributes` },

             ...

         ]

.. _639_vrid_attributes:

vrid attributes
---------------

    **fip-dest**

        **Description** Alien FIP Destination CIDR Block

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **fip-interface-id**

        **Description** Data-Out Interface ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **route-table-id**

        **Description** Specifies the route table id of the interface

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

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

    **vip-dest**

        **Description** Alien VIP Destination CIDR Block

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-interface-id**

        **Description** Data-In Interface ID

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}/vip/{vip-number} <cloud_services_cloud_provider_aws_multi_az_failover_vrid>`

    **vrid-number**

        **Description** Specify ha VRRP-A vrid Number

        **Type:** number

        **Range:** 0-31

.. _639_vip-list:

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

	 **Block object keys**             

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

    **elastic-ip**

        **Description** Elastic IP address of VIP

        **Type:** string

        **Format:** ipv4-address

    **private-ip**

        **Description** Private IP address of VIP

        **Type:** string

        **Format:** ipv4-address

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

    **vip-number**

        **Description** Specify ha vip Number

        **Type:** number

        **Range:** 0-2147483647