vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dns/api-ref/dns_api_62003.html
Qin Ying, Fan cf1007c84e DNS API 20240223 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-05-16 13:48:49 +00:00

418 lines
34 KiB
HTML
Raw Permalink Blame History

<a name="dns_api_62003"></a><a name="dns_api_62003"></a>
<h1 class="topictitle1">Querying Public Zones</h1>
<div id="body1473062969376"><div class="section" id="dns_api_62003__section2763065016101"><h4 class="sectiontitle">Function</h4><p id="dns_api_62003__p24276371171754">Query public zones in list.</p>
</div>
<div class="section" id="dns_api_62003__section53701671161015"><h4 class="sectiontitle">URI</h4><p id="dns_api_62003__p71395579472">GET /v2/zones?type={type}&amp;limit={limit}&amp;marker={marker}&amp;offset={offset}&amp;tags={tags}&amp;name={name}&amp;status={status}</p>
<div class="p" id="dns_api_62003__p1097614231469">For details, see <a href="#dns_api_62003__table36421405182556">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_62003__table36421405182556"></a><a name="table36421405182556"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table36421405182556" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_62003__row35113810182556"><th align="left" class="cellrowborder" valign="top" width="17.669999999999998%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_62003__p29205341182624"><strong id="dns_api_62003__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.49%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_62003__p16822416182624"><strong id="dns_api_62003__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.839999999999998%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_62003__p20438464182624"><strong id="dns_api_62003__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_62003__p44902868182624"><strong id="dns_api_62003__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__row7883687182556"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p29178851182717">type</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p2590622182717">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p66359104182717">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p53225083153722">Zone type, which can be <strong id="dns_api_62003__b1982092916111747">public</strong> or <strong id="dns_api_62003__b1971245989111747">private</strong></p>
<ul id="dns_api_62003__ul7470137153957"><li id="dns_api_62003__li58095704153957"><strong id="dns_api_62003__b1702127103733">public</strong>: Public zones are queried.</li><li id="dns_api_62003__li54676736153957"><strong id="dns_api_62003__b2104944103740">private</strong>: Private zones are queried.<p id="dns_api_62003__p47260004103624">If the value is left blank, public zones are queried by default.</p>
</li></ul>
<p id="dns_api_62003__p12624433152816">A fuzzy search will be performed.</p>
<p id="dns_api_62003__p23756351441">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_62003__row12208459182556"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p17456213182720">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p4667185182720">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p42497672182720">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p19759428182720">Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.</p>
</td>
</tr>
<tr id="dns_api_62003__row29489517182630"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p43326778182720">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p19808096182720">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p60951943182720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p230120311413">Number of resources on each page</p>
<p id="dns_api_62003__p147131447514">The value ranges from <strong id="dns_api_62003__b1048819326518">0</strong> to <strong id="dns_api_62003__b145021332259">500</strong>.</p>
<p id="dns_api_62003__p1385813431412">Commonly used values are <strong id="dns_api_62003__b18456154013210">10</strong>, <strong id="dns_api_62003__b1247274073211">20</strong>, and <strong id="dns_api_62003__b15473840143213">50</strong>. The default value is <strong id="dns_api_62003__b1735419618338">500</strong>.</p>
</td>
</tr>
<tr id="dns_api_62003__row56409238193951"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p5745576193951">offset</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p62738535193951">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p48656570193951">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p35951433204916">Start offset of pagination query. The query will start from the next resource of the offset value.</p>
<p id="dns_api_62003__p18898143914915">The value ranges from <strong id="dns_api_62003__b4322238175714">0</strong> to <strong id="dns_api_62003__b1332853885711">2147483647</strong>.</p>
<p id="dns_api_62003__p13209172234718">The default value is 0.</p>
<p id="dns_api_62003__p167712216335">If <strong id="dns_api_62003__b986116195358">marker</strong> is not left blank, the query starts from the resource specified by <strong id="dns_api_62003__b138634197359">marker</strong>.</p>
</td>
</tr>
<tr id="dns_api_62003__row1736769311550"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p1821826211550">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p6639315411550">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p913636111550">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p28691609115519">Resource tag</p>
<p id="dns_api_62003__p6833525115523">The format is as follows: <strong id="dns_api_62003__b8423527069140">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_62003__p32051112114146">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_62003__p15239506115938">The tags are in AND relationship.</p>
<p id="dns_api_62003__p39866681115027">For details, see <a href="dns_api_67001.html">Adding Resource Tags</a>.</p>
<p id="dns_api_62003__p12571115182919">Exact matching will work. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.</p>
<p id="dns_api_62003__p10621449102913">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_62003__row1633012241220"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p1933113222124">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p1833110221120">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p1533162211129">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p113313225126">Zone name</p>
<p id="dns_api_62003__p159771524568">A fuzzy search will be performed.</p>
</td>
</tr>
<tr id="dns_api_62003__row1173792401616"><td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62003__p6738102411167">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62003__p973842401614">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62003__p1173872481613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62003__p08895418160">Resource status</p>
<p id="dns_api_62003__p168892041161615">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dns_api_62003__section44958995161021"><h4 class="sectiontitle">Request</h4><ul id="dns_api_62003__ul35351571269"><li id="dns_api_62003__li1053565782615">Request parameters<p id="dns_api_62003__p1815201642711"><a name="dns_api_62003__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_62003__li4109190182715">Example request<p id="dns_api_62003__p1651121054613"><a name="dns_api_62003__li4109190182715"></a><a name="li4109190182715"></a>Query the first 10 public zones whose tag is &lt;key1, value1&gt;:</p>
<pre class="codeblock" id="dns_api_62003__codeblock1879211104015">GET https://{DNS_Endpoint}/v2/zones?type=public&amp;limit=10&amp;offset=0&amp;tags=key1,value1</pre>
</li></ul>
</div>
<div class="section" id="dns_api_62003__section40090803161031"><h4 class="sectiontitle">Response</h4><ul id="dns_api_62003__ul35717797171848"><li id="dns_api_62003__li32842178171848">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table6655637171923" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_62003__row12436182171923"><th align="left" class="cellrowborder" valign="top" width="18.529999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_62003__p18040723171923"><strong id="dns_api_62003__b1489824763">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.45%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_62003__p12288867171923"><strong id="dns_api_62003__b808596527">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.019999999999996%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_62003__p16021685171923"><strong id="dns_api_62003__b2035660693">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__row1313962617109"><td class="cellrowborder" valign="top" width="18.529999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62003__p1122192813108">links</p>
</td>
<td class="cellrowborder" valign="top" width="30.45%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62003__p1222152817106">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62003__p9225286109">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_62003__b84235270695245">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_62003__p222428171017">For details, see <a href="#dns_api_62003__table0172144213344">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_62003__row33084878171923"><td class="cellrowborder" valign="top" width="18.529999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62003__p10518479171923">zones</p>
</td>
<td class="cellrowborder" valign="top" width="30.45%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62003__p17816324171923">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62003__p64387025171923">Zone list. For details, see <a href="#dns_api_62003__table6348803417233">Table 3</a>.</p>
</td>
</tr>
<tr id="dns_api_62003__row45921614175143"><td class="cellrowborder" valign="top" width="18.529999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62003__p10641344175143">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="30.45%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62003__p24643947175143">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.019999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62003__p50002691175143">Total number of resources that meet the filter criteria. For details, see <a href="#dns_api_62003__table52442344175457">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="dns_api_62003__p10871751191712">
<div class="tablenoborder"><a name="dns_api_62003__table6348803417233"></a><a name="table6348803417233"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table6348803417233" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_62003__b842352706152641">zones</strong> field</caption><thead align="left"><tr id="dns_api_62003__r23fa2da9911a4ee5a769290a0a199439"><th align="left" class="cellrowborder" valign="top" width="18.37%" id="mcps1.3.4.2.1.2.1.2.4.1.1"><p id="dns_api_62003__ab37e0c953c5e4c9f825ae513b4e7be64"><strong id="dns_api_62003__b1398400899">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.4.2.1.2.1.2.4.1.2"><p id="dns_api_62003__acf116b883bc84e0dbdb0aba866af0983"><strong id="dns_api_62003__b1340495574">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.239999999999995%" id="mcps1.3.4.2.1.2.1.2.4.1.3"><p id="dns_api_62003__afc0cd2e5779b4d6aad0629b35d87cfe5"><strong id="dns_api_62003__b1211559818">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__r06a7dd0ecc294dc6882fa08829fe0604"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a4932676eab7a4ea09e37b9ad2db58d31">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a4239fa13387042118443b35b50304e4a">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a6d1b608635744cd292ef147bfd8d3920">Zone ID, which is a UUID used to identify the zone</p>
</td>
</tr>
<tr id="dns_api_62003__r9c08eb7520d44ce98644f20f1655f1c1"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__aefad392b710e479597345abba93e82fa">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a696a900fa4654809880ea1ce0fc0f561">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a5f80a18701844c989e2439936c0652a3">Zone name</p>
</td>
</tr>
<tr id="dns_api_62003__r6b77005ed4224ea0b410678e7912fc97"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__ac6590fa69311427898e8170c48b8fa39">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__adf1b2bc2172e496289cfff6aa994a331">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a2341f4ef85b34a8cad2372164c6686eb">Zone description</p>
</td>
</tr>
<tr id="dns_api_62003__rfdd59b39416a4adc9a8103df0224e716"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a30a87e7422dd4c5cbf5c8b4bbf2a84d8">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__en-us_topic_0037139748_p336297171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a791ad8d88187434094a0eed0a3cbbfb2">Email address of the administrator managing the zone</p>
</td>
</tr>
<tr id="dns_api_62003__r65ed8e5dbe574f5ba73cfb6177c74d51"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a586a45dbdef8419e8fc848941eaa1aa9">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a0f2f0d5daa7b46d5b4e611831fd0c4a8">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a13ac59b267154f24b2d096be4c229e62">Zone type, which can be <strong id="dns_api_62003__b1842196104319">public</strong> or <strong id="dns_api_62003__b1843116114315">private</strong></p>
</td>
</tr>
<tr id="dns_api_62003__rf50e52f024aa428ca2324bdb3719bb1c"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a8a3f46292b0c4874898c63b7a6f80926">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__aafbde4a45c94452aa4ec4e4c0ab151ba">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a10f5e4e2602f4350a2ccfc124a018d34">TTL value of the SOA record set in the zone</p>
<p id="dns_api_62003__p0662131993410">The value ranges from <strong id="dns_api_62003__dns_api_62001_b2613115265713">1</strong> to <strong id="dns_api_62003__dns_api_62001_b662035245714">2147483647</strong>.</p>
<p id="dns_api_62003__p7662111973418">The default value is <strong id="dns_api_62003__dns_api_62001_b19778105913578">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_62003__r6b4647120ecf46eaa33b673e28839d15"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__aebeb87bd362d4a3faacb6ca919e3981e">serial</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a9748d8daa2f947f8921f68add4e991c0">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__p1499913459428">Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server</p>
<p id="dns_api_62003__p7524749171039">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_62003__re8c33e9c430e41e88b42b9ceb94d5803"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__aaf10dc2c1ac64fc5a3da7078cb0596a6">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a687065e2ff0d46e98e1b2942fe23bc3a">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a1bee5fd6826345c1aee2af7b2b331937">Resource status</p>
<p id="dns_api_62003__p15991203153020">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_62003__r80c4f22c27124b56b9f9ee0679394c42"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__aeb15dbe32b604c1fb0ecae447c204c29">record_num</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__ae5c55f656d2f4ee8985921f3c83f738e">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a9cb01b7b03184775b5c98e48b1b3426a">Number of record sets in the zone</p>
</td>
</tr>
<tr id="dns_api_62003__rf994e423aff545899ef9c353685756ff"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a87487f19552d4c12a0ad956bccaa7998">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__adb93a67b81d342d19c3509b6bb845745">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__aaccbb6eaeed64b7096678ae8a7c87e24">Pool ID of the zone, which is assigned by the system</p>
</td>
</tr>
<tr id="dns_api_62003__r60fa51885e2d4d01bd7d47db1ff3bfdd"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__afdd30b1a51354b639ce164b115df339e">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a06917a7a64fa4de693aeb5442109be96">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__p8704812171039">Project ID of the zone</p>
</td>
</tr>
<tr id="dns_api_62003__ra456600e26214cdcbfedd7e42f4a9d73"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a329645c1cf924ea0b3258c9b67f35b59">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a25d2495f1d28446b8e57250347024ecf">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__a3c499e0e732e4eedb2b900eed39a86eb">Time when the zone was created</p>
<p id="dns_api_62003__p16471913102410">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_62003__rf0243379fed8476db1f06e6d2d0d1479"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__a90b33cdf2e7048d9a2c4dbb5a0021423">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__a2f7e47e730f9408ebde639a3e1b65f22">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__acdf6059b171f4930a800e842b314166f">Time when the zone was updated</p>
<p id="dns_api_62003__p465420187241">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_62003__r0eebfd448d94450db6310faee3858418"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__en-us_topic_0037139748_p288749251572">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__en-us_topic_0037139748_p571676251572">Object</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__p20067569143314">Link to the current resource or other related resources</p>
<p id="dns_api_62003__en-us_topic_0037139748_p660161572">When a response is broken into pages, a <strong id="dns_api_62003__b651329162">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_62003__p14741433184311">For details, see <a href="#dns_api_62003__table0172144213344">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_62003__row56817311274"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__p145019941317">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__p75011918138">Array of <a href="#dns_api_62003__table619059185111">tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__p1350114961316">Resource tag.</p>
<p id="dns_api_62003__p111349461418">The format is as follows: <strong id="dns_api_62003__b1630573235">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_62003__p18134744140">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_62003__p18134204181420">The tags are in AND relationship.</p>
<p id="dns_api_62003__p8134749148">For details about resource tags, see <a href="#dns_api_62003__table619059185111">Table 6</a>.</p>
<p id="dns_api_62003__p61341740143">Exact matching will work. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.</p>
<p id="dns_api_62003__p1713404141413">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_62003__re2fe47183e18405d92046423a13cc360"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_62003__aaad74d843b144b02886916b90476b9eb">masters</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_62003__ac58ddffcdd4b4db48b9da9a1aa4b94b8">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_62003__p33087898183618">Master DNS servers, from which the slave servers get DNS information</p>
<p id="dns_api_62003__p052113815317">This parameter is not used currently.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="p" id="dns_api_62003__p6425142816407">
<div class="tablenoborder"><a name="dns_api_62003__table52442344175457"></a><a name="table52442344175457"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table52442344175457" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_62003__b501739735">metadata</strong> field</caption><thead align="left"><tr id="dns_api_62003__row58979189175457"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.1"><p id="dns_api_62003__p46156243175457"><strong id="dns_api_62003__b1997954719">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.2"><p id="dns_api_62003__p47668234175457"><strong id="dns_api_62003__b619599016">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.3"><p id="dns_api_62003__p35921708175457"><strong id="dns_api_62003__b747670760">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__row54859922175457"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.1 "><p id="dns_api_62003__p14468674175457">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.2 "><p id="dns_api_62003__p31111955175457">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.3 "><p id="dns_api_62003__p37040428175457">Number of resources that meet the filter criteria. The number is irrelevant to <strong id="dns_api_62003__b73064363212">limit</strong> or <strong id="dns_api_62003__b8948174963213">offset</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="dns_api_62003__table0172144213344"></a><a name="table0172144213344"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table0172144213344" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_62003__b20690951123219">links</strong> field</caption><thead align="left"><tr id="dns_api_62003__row917304253418"><th align="left" class="cellrowborder" valign="top" width="18.391839183918393%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="dns_api_62003__p101731742153416"><strong id="dns_api_62003__b47794268567">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.55195519551955%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="dns_api_62003__p0174542163418"><strong id="dns_api_62003__b1334337199">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.05620562056207%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="dns_api_62003__p7174194243414"><strong id="dns_api_62003__b1642442812569">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__row1917494211345"><td class="cellrowborder" valign="top" width="18.391839183918393%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_62003__p13174134215348">self</p>
</td>
<td class="cellrowborder" valign="top" width="19.55195519551955%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_62003__p181741642173417">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.05620562056207%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_62003__p1017434223419">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_62003__row88718634719"><td class="cellrowborder" valign="top" width="18.391839183918393%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_62003__p136561245153620">next</p>
</td>
<td class="cellrowborder" valign="top" width="19.55195519551955%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_62003__p19656144517367">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.05620562056207%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_62003__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_62003__table619059185111"></a><a name="table619059185111"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62003__table619059185111" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="dns_api_62003__b89191842183515">tag</strong> field</caption><thead align="left"><tr id="dns_api_62003__row15361836112436"><th align="left" class="cellrowborder" valign="top" width="18.2%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="dns_api_62003__p58707511112436">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.07%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="dns_api_62003__p42210623112436"><strong id="dns_api_62003__b2034717244">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.73%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="dns_api_62003__p63617265112436">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62003__row35684479112436"><td class="cellrowborder" valign="top" width="18.2%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dns_api_62003__p13313439112530">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.07%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dns_api_62003__p35653193112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.73%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dns_api_62003__p011410211144">Tag key</p>
<p id="dns_api_62003__p9534642694">A key can contain up to 36 Unicode characters. The key cannot be empty. </p>
</td>
</tr>
<tr id="dns_api_62003__row20048002112436"><td class="cellrowborder" valign="top" width="18.2%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dns_api_62003__p66095544112533">value</p>
</td>
<td class="cellrowborder" valign="top" width="19.07%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dns_api_62003__p60123528112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.73%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dns_api_62003__p592417401420">Tag value</p>
<p id="dns_api_62003__p3383124915419">Each value can contain up to 43 Unicode characters and can be an empty string. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_62003__li49876906171853">Example response<pre class="screen" id="dns_api_62003__screen1463295220724">{
"links": {
"self": "https://<em id="dns_api_62003__i5614727141617">Endpoint</em>/v2/zones?type=public&amp;limit=11",
"next": "https://<em id="dns_api_62003__i11368134555313">Endpoint</em>/v2/zones?type=public&amp;limit=11&amp;marker=2c9eb155587194ec01587224c9f90149"
},
"zones": [
{
"id": "2c9eb155587194ec01587224c9f90149",
"name": "example.com.",
"description": "This is an example zone.",
"email": "xx@example.com",
"ttl": 300,
"serial": 0,
"masters": [],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_62003__i29356701142027">Endpoint</em>/v2/zones/2c9eb155587194ec01587224c9f90149"
},
"pool_id": "00000000570e54ee01570e9939b20019",
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
"zone_type": "public",
"created_at": "2016-11-17T11:56:03.439",
"updated_at": "2016-11-17T11:56:05.528",
"record_num": 2
},
{
"id": "2c9eb155587228570158722996c50001",
"name": "example.org.",
"description": "This is an example zone.",
"email": "xx@example.org",
"ttl": 300,
"serial": 0,
"masters": [],
"status": "PENDING_CREATE",
"links": {
"self": "https://<em id="dns_api_62003__i46086693142316">Endpoint</em>/v2/zones/2c9eb155587228570158722996c50001"
},
"pool_id": "00000000570e54ee01570e9939b20019",
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
"zone_type": "public",
"created_at": "2016-11-17T12:01:17.996",
"updated_at": "2016-11-17T12:01:18.528",
"record_num": 2
}
],
"metadata": {
"total_count": 2
}
}
</pre>
</li></ul>
</div>
<div class="section" id="dns_api_62003__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_62003__dns_api_61001_p711102924515">If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.</p>
<p id="dns_api_62003__dns_api_61001_p18506102624518">For details, see <a href="dns_api_80002.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dns_api_62000.html">Public Zone Management</a></div>
</div>
</div>
View Git Blame Copy Permalink