vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dns/api-ref/dns_api_63006.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

483 lines
36 KiB
HTML
Raw Permalink Blame History

<a name="dns_api_63006"></a><a name="dns_api_63006"></a>
<h1 class="topictitle1">Querying Private Zones</h1>
<div id="body1492847418242"><div class="section" id="dns_api_63006__section2763065016101"><h4 class="sectiontitle">Function</h4><p id="dns_api_63006__p11269573165245">Query private zones in list.</p>
</div>
<div class="section" id="dns_api_63006__section53701671161015"><h4 class="sectiontitle">URI</h4><p id="dns_api_63006__p19393161684816">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_63006__p731562012104">For details, see <a href="#dns_api_63006__table36421405182556">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_63006__table36421405182556"></a><a name="table36421405182556"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table36421405182556" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_63006__row35113810182556"><th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_63006__p29205341182624"><strong id="dns_api_63006__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.869999999999997%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_63006__p16822416182624"><strong id="dns_api_63006__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_63006__p20438464182624"><strong id="dns_api_63006__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.74%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_63006__p44902868182624"><strong id="dns_api_63006__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row7883687182556"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p29178851182717">type</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p2590622182717">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p66359104182717">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p41213064154029">Zone type</p>
<p id="dns_api_63006__p34437364141042">The value is <strong id="dns_api_63006__b19216603">private</strong>, indicating that private zones are queried.</p>
</td>
</tr>
<tr id="dns_api_63006__row12208459182556"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p17456213182720">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p4667185182720">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p42497672182720">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p352216816854">Start resource ID of pagination query</p>
<p id="dns_api_63006__p19759428182720">If the parameter is left blank, only resources on the first page are queried.</p>
<p id="dns_api_63006__p1451994172211">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63006__row29489517182630"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p43326778182720">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p19808096182720">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p60951943182720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p230120311413">Number of resources on each page</p>
<p id="dns_api_63006__p147131447514">The value ranges from <strong id="dns_api_63006__b5391172010518">0</strong> to <strong id="dns_api_63006__b133921620157">500</strong>.</p>
<p id="dns_api_63006__p1385813431412">Commonly used values are <strong id="dns_api_63006__b17273551829">10</strong>, <strong id="dns_api_63006__b1627416516219">20</strong>, and <strong id="dns_api_63006__b9275151421">50</strong>. The default value is <strong id="dns_api_63006__b1669719521421">500</strong>.</p>
</td>
</tr>
<tr id="dns_api_63006__row2721615319547"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p626980719549">offset</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p3809236019549">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p6558235419549">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p35951433204916">Start offset of pagination query. The query will start from the next resource of the offset value.</p>
<p id="dns_api_63006__p18898143914915">The value ranges from <strong id="dns_api_63006__b381115452912">0</strong> to <strong id="dns_api_63006__b2081216451495">2147483647</strong>.</p>
<p id="dns_api_63006__p13209172234718">The default value is <strong id="dns_api_63006__b32677501694">0</strong>.</p>
<p id="dns_api_63006__p167712216335">If <strong id="dns_api_63006__b1088121403916">marker</strong> is not left blank, the query starts from the resource specified by <strong id="dns_api_63006__b1188311433912">marker</strong>.</p>
</td>
</tr>
<tr id="dns_api_63006__row58681680125046"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p47666033125046">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p35743447125046">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p9538131125046">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p34391114125046">Resource tag</p>
<p id="dns_api_63006__p41084576125046">The format is as follows: <strong id="dns_api_63006__b8423527069140">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_63006__p34216870125046">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_63006__p1526014454308">The tags are in AND relationship.</p>
<p id="dns_api_63006__p16628284115121">For details, see <a href="dns_api_67001.html">Adding Resource Tags</a>.</p>
<p id="dns_api_63006__p116996555212">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63006__row7779132921"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p1933113222124">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p1833110221120">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p1533162211129">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p113313225126">Zone name</p>
<p id="dns_api_63006__p159771524568">A fuzzy search will be performed.</p>
</td>
</tr>
<tr id="dns_api_63006__row659075217162"><td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63006__p6738102411167">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63006__p973842401614">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63006__p1173872481613">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.74%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63006__p08895418160">Resource status</p>
<p id="dns_api_63006__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_63006__section44958995161021"><h4 class="sectiontitle">Request</h4><ul id="dns_api_63006__ul35351571269"><li id="dns_api_63006__li1053565782615">Request parameters<p id="dns_api_63006__p1815201642711"><a name="dns_api_63006__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_63006__li4109190182715">Example request<p id="dns_api_63006__p16901225154816"><a name="dns_api_63006__li4109190182715"></a><a name="li4109190182715"></a>Query the first 10 private zones whose tag is &lt;key1, value1&gt;:</p>
<pre class="codeblock" id="dns_api_63006__codeblock76301356114918">GET https://{DNS_Endpoint}/v2/zones?type=private&amp;limit=10&amp;offset=0&amp;tags=key1,value1</pre>
</li></ul>
</div>
<div class="section" id="dns_api_63006__section40090803161031"><h4 class="sectiontitle">Response</h4><ul id="dns_api_63006__ul35717797171848"><li id="dns_api_63006__li32842178171848">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table6655637171923" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_63006__row12436182171923"><th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_63006__p18040723171923"><strong id="dns_api_63006__b286080644">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_63006__p12288867171923"><strong id="dns_api_63006__b1005937664">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_63006__p16021685171923"><strong id="dns_api_63006__b96845297">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row14234124965913"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63006__p121914507594">links</p>
</td>
<td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63006__p119265015599">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_63006__p2192145010591">Link to the current resource or other related resources.</p>
<p id="dns_api_63006__p1419219504593">When a response is broken into pages, a <strong id="dns_api_63006__b324576111310">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_63006__p1619213506597">For details, see <a href="#dns_api_63006__table0172144213344">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_63006__row33084878171923"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63006__p10518479171923">zones</p>
</td>
<td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63006__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_63006__p64387025171923">Zone list. For details, see <a href="#dns_api_63006__table10871190151410">Table 3</a>.</p>
</td>
</tr>
<tr id="dns_api_63006__row45921614175143"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63006__p10641344175143">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63006__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_63006__p50002691175143">Total number of resources that meet the filter criteria. For details, see <a href="#dns_api_63006__table141615131414">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63006__table10871190151410"></a><a name="table10871190151410"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table10871190151410" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_63006__b842352706152641">zones</strong> field</caption><thead align="left"><tr id="dns_api_63006__row1187914015145"><th align="left" class="cellrowborder" valign="top" width="18.38%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dns_api_63006__p488213014145"><strong id="dns_api_63006__b1867158198">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.33%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dns_api_63006__p1388515051418"><strong id="dns_api_63006__b1582948164">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.29%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dns_api_63006__p8887707143"><strong id="dns_api_63006__b37024825">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row14889200191410"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p11890180121420">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p178921305144">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1589419081418">Zone ID, which is a UUID used to identify the zone</p>
</td>
</tr>
<tr id="dns_api_63006__row208952016144"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p198981207149">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p0901205148">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p5904140161420">Zone name</p>
</td>
</tr>
<tr id="dns_api_63006__row1905180111413"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p129067010142">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p1890800161415">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p790916010141">Zone description</p>
</td>
</tr>
<tr id="dns_api_63006__row89101018143"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p791270191413">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p09136021413">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p791613013147">Email address of the administrator managing the zone</p>
</td>
</tr>
<tr id="dns_api_63006__row69166031414"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p179190018143">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p292119018147">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p9394279212">Zone type, which can be <strong id="dns_api_63006__b77961733162">public</strong> or <strong id="dns_api_63006__b14797103101619">private</strong></p>
</td>
</tr>
<tr id="dns_api_63006__row1792616091413"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p109283011142">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p189301209147">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1893460141411">TTL value of the SOA record set in the zone</p>
<p id="dns_api_63006__p0662131993410">The value ranges from <strong id="dns_api_63006__dns_api_63002_b19998125511334">1</strong> to <strong id="dns_api_63006__dns_api_63002_b1899825519334">2147483647</strong>.</p>
<p id="dns_api_63006__p7662111973418">The default value is <strong id="dns_api_63006__dns_api_63002_b1947775585810">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_63006__row49346041419"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p193630171412">serial</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p19940160111416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p201115484116">Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server</p>
<p id="dns_api_63006__p7524749171039">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63006__row1494311013144"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p1394519012141">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p199461401144">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p494720017143">Resource status</p>
<p id="dns_api_63006__p17698116181717">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63006__row1595113017149"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p1395410081413">record_num</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p179551801147">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p595712021413">Number of record sets in the zone</p>
</td>
</tr>
<tr id="dns_api_63006__row69595020143"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p15962150151419">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p6965803142">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1596710031411">Pool ID of the zone, which is assigned by the system</p>
</td>
</tr>
<tr id="dns_api_63006__row49683010141"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p2097010181418">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p1397430121412">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p8704812171039">Project ID of the zone</p>
</td>
</tr>
<tr id="dns_api_63006__row129774031419"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p15980200171419">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p69816019146">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p159835018143">Time when the zone was created</p>
<p id="dns_api_63006__p583516468316">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63006__row1498413011412"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p398715081417">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p1988190121420">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p169905051413">Time when the zone was updated</p>
<p id="dns_api_63006__p1133918273234">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63006__row999050111419"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p8993407142">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p899518011417">Object</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1799719041413">Link to the current resource or other related resources.</p>
<p id="dns_api_63006__p109986017142">When a response is broken into pages, a <strong id="dns_api_63006__b84235270695245">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_63006__p8722659124511">For details, see <a href="#dns_api_63006__table0172144213344">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_63006__row625316427914"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p145019941317">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p75011918138">Array of <a href="#dns_api_63006__table36911165107">tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1350114961316">Resource tag.</p>
<p id="dns_api_63006__p111349461418">The format is as follows: <strong id="dns_api_63006__b1687865170">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_63006__p18134744140">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_63006__p18134204181420">The tags are in AND relationship.</p>
<p id="dns_api_63006__p8134749148">For details, see <a href="#dns_api_63006__table36911165107">Table 6</a>.</p>
<p id="dns_api_63006__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_63006__p1713404141413">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63006__row29991001416"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p1311419142">masters</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p9449603510">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p1876191410">Master DNS servers, from which the slave servers get DNS information</p>
<p id="dns_api_63006__p14810145782211">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63006__row18881161418"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63006__p6114111411">routers</p>
</td>
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_63006__p10131212146">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="62.29%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_63006__p161561141410">Routers (VPCs associated with the zone). For details, see <a href="#dns_api_63006__table4448008117179">Table 7</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63006__table141615131414"></a><a name="table141615131414"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table141615131414" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_63006__b1461620108">metadata</strong> field</caption><thead align="left"><tr id="dns_api_63006__row223813147"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_63006__p1266151412"><strong id="dns_api_63006__b346120632">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_63006__p12286121410"><strong id="dns_api_63006__b1466349953">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_63006__p02911119140"><strong id="dns_api_63006__b1960547177">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row33219131412"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63006__p8341314143">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63006__p123671111420">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63006__p1339111149">Number of resources that meet the filter criteria. The number is irrelevant to <strong id="dns_api_63006__b411033282419">limit</strong> or <strong id="dns_api_63006__b12111332192412">offset</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63006__table0172144213344"></a><a name="table0172144213344"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table0172144213344" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_63006__b17122153752411">links</strong> field</caption><thead align="left"><tr id="dns_api_63006__row917304253418"><th align="left" class="cellrowborder" valign="top" width="18.13181318131813%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="dns_api_63006__p101731742153416"><strong id="dns_api_63006__b129082038152418">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.77197719771977%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="dns_api_63006__p0174542163418"><strong id="dns_api_63006__b1754669712">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.09620962096209%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="dns_api_63006__p7174194243414"><strong id="dns_api_63006__b2785124314242">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row1917494211345"><td class="cellrowborder" valign="top" width="18.13181318131813%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_63006__p13174134215348">self</p>
</td>
<td class="cellrowborder" valign="top" width="19.77197719771977%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_63006__p181741642173417">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.09620962096209%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_63006__p1017434223419">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_63006__row7655245133611"><td class="cellrowborder" valign="top" width="18.13181318131813%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_63006__p136561245153620">next</p>
</td>
<td class="cellrowborder" valign="top" width="19.77197719771977%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_63006__p19656144517367">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.09620962096209%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_63006__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63006__table36911165107"></a><a name="table36911165107"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table36911165107" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="dns_api_63006__b1535020711201">tag</strong> field</caption><thead align="left"><tr id="dns_api_63006__row156918641015"><th align="left" class="cellrowborder" valign="top" width="18.13181318131813%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="dns_api_63006__p569114671016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.77197719771977%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="dns_api_63006__p869118616104"><strong id="dns_api_63006__b1440985413">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.09620962096209%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="dns_api_63006__p369116641013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row869115611106"><td class="cellrowborder" valign="top" width="18.13181318131813%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dns_api_63006__p640435691111">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.77197719771977%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dns_api_63006__p12404656101119">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.09620962096209%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dns_api_63006__p011410211144">Tag key</p>
<p id="dns_api_63006__p12621122816413">A key can contain up to 36 Unicode characters. The key cannot be empty. </p>
</td>
</tr>
<tr id="dns_api_63006__row196911561104"><td class="cellrowborder" valign="top" width="18.13181318131813%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dns_api_63006__p740495612113">value</p>
</td>
<td class="cellrowborder" valign="top" width="19.77197719771977%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dns_api_63006__p2404195691113">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.09620962096209%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dns_api_63006__p592417401420">Tag value</p>
<p id="dns_api_63006__p3383124915419">Each value can contain up to 43 Unicode characters and can be an empty string. </p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63006__table4448008117179"></a><a name="table4448008117179"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63006__table4448008117179" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Description of the <strong id="dns_api_63006__b1186895118244">routers</strong> field</caption><thead align="left"><tr id="dns_api_63006__row6132935617179"><th align="left" class="cellrowborder" valign="top" width="18.32816718328167%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="dns_api_63006__p36588677171719"><strong id="dns_api_63006__b0214152362516">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.878012198780123%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="dns_api_63006__p9906869171719"><strong id="dns_api_63006__b1527344504">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.79382061793821%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="dns_api_63006__p64258954171719"><strong id="dns_api_63006__b595852642518">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63006__row1024510342619"><td class="cellrowborder" valign="top" width="18.32816718328167%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="dns_api_63006__p38120631175524">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.878012198780123%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="dns_api_63006__p57184665175519">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="dns_api_63006__p1635999216648">Resource status</p>
<p id="dns_api_63006__p656495918714">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63006__row266872817179"><td class="cellrowborder" valign="top" width="18.32816718328167%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="dns_api_63006__p25118582171719">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.878012198780123%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="dns_api_63006__p50755907171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="dns_api_63006__p17587794171719">ID of the associated VPC</p>
</td>
</tr>
<tr id="dns_api_63006__row6657832817179"><td class="cellrowborder" valign="top" width="18.32816718328167%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="dns_api_63006__p3709384171719">router_region</p>
</td>
<td class="cellrowborder" valign="top" width="19.878012198780123%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="dns_api_63006__p43861924171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="dns_api_63006__p63154928171719">Region of the VPC</p>
<p id="dns_api_63006__p38645142171939">If it is left blank, the region of the project in the token takes effect by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dns_api_63006__ul51655108172227"><li id="dns_api_63006__li49876906171853">Example response<pre class="screen" id="dns_api_63006__screen26317430184928">{
"links": {
"self": "https://<em id="dns_api_63006__i35530282184928">Endpoint</em>/v2/zones?type=private&amp;limit=11",
"next": "https://<em id="dns_api_63006__i11368134555313">Endpoint</em>/v2/zones?type=private&amp;limit=11&amp;marker=ff8080825b8fc86c015b94bc6f8712c3"
},
"zones": [
{
"id": "ff8080825b8fc86c015b94bc6f8712c3",
"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_63006__i51337090184928">Endpoint</em>/v2/zones/ff8080825b8fc86c015b94bc6f8712c3"
},
"pool_id": "ff8080825ab738f4015ab7513298010e",
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
"zone_type": "private",
"created_at": "2017-04-22T08:17:08.997",
"updated_at": "2017-04-22T08:17:09.997",
"record_num": 2,
"routers": [
{
"status": "ACTIVE",
"router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
"router_region": "xx"
},
{
"status": "ACTIVE",
"router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
"router_region": "xx"
}
]
},
{
"id": "ff8080825b95142f015b951f87280029",
"name": "example.org.",
"description": "This is an example zone.",
"email": "xx@example.org",
"ttl": 300,
"serial": 0,
"masters": [],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_63006__i59380630184928">Endpoint</em>/v2/zones/ff8080825b95142f015b951f87280029"
},
"pool_id": "ff8080825ab738f4015ab7513298010e",
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
"zone_type": "private",
"created_at": "2017-04-22T08:17:08.997",
"updated_at": "2017-04-22T08:17:09.997",
"record_num": 2,
"routers": [
{
"status": "ACTIVE",
"router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
"router_region": "xx"
},
{
"status": "ACTIVE",
"router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
"router_region": "xx"
}
]
}
],
"metadata": {
"total_count": 2
}
}
</pre>
</li></ul>
</div>
<div class="section" id="dns_api_63006__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_63006__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_63006__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_63000.html">Private Zone Management</a></div>
</div>
</div>
View Git Blame Copy Permalink