.. _gslb_zone_service_dns_cname_record:

gslb zone service dns-cname-record
==================================

Specify DNS CNAME Record


dns-cname-record Specification
------------------------------

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

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

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

	 **Collection Name**                   :ref:`1790_dns-cname-record_list`

	 **Collection URI**                    /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record

	                                       

	 **Element Name**                      dns-cname-record

	 **Element URI**                       /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name}

	 **Element Attributes**                dns-cname-record_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/gslb/zone/{name}/service/{service-port}+{service-name}/dns-cname-record/{alias-name}/stats

	 **Schema**                             :download:`dns-cname-record schema <gslb-zone-service-dns-cname-record/gslb-zone-service-dns-cname-record.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}/dns-cname-record



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record/{alias-name}



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record/{alias-name}



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record/{alias-name}



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record



.. raw:: html

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


:ref:`1790_dns-cname-record_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}/dns-cname-record/{alias-name}



.. raw:: html

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


:ref:`1790_dns-cname-record_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1790_dns-cname-record_list:

dns-cname-record-list
---------------------


    dns-cname-record-list is **JSON List** of :ref:`1790_dns-cname-record_attributes` 

        dns-cname-record-list : [

             { :ref:`1790_dns-cname-record_attributes` },

             { :ref:`1790_dns-cname-record_attributes` },

             ...

         ]

.. _1790_dns-cname-record_attributes:

dns-cname-record attributes
---------------------------

    **admin-preference**

        **Description** Specify Administrative Preference, default is 100

        **Type:** number

        **Range:** 0-255

        **Default:** 100

    **alias-name**

        **Description** Specify the alias name

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **as-backup**

        **Description** As backup when fail

        **Type:** boolean

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

        **Default:** 0

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **weight**

        **Description** Specify Weight, default is 1

        **Type:** number

        **Range:** 1-100

        **Default:** 1

.. _1790_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'cname-hits': Number of times the CNAME has been used; 

        **Type:** string

        **Supported Values:** all, cname-hits