doc-exports/docs/dns/api-ref/dns_api_62002.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

222 lines
18 KiB
HTML

<a name="dns_api_62002"></a><a name="dns_api_62002"></a>
<h1 class="topictitle1">Querying a Public Zone</h1>
<div id="body8420641"><div class="section" id="dns_api_62002__section55898385"><h4 class="sectiontitle">Function</h4><p id="dns_api_62002__p10983320">Query a public zone.</p>
</div>
<div class="section" id="dns_api_62002__section33323423"><h4 class="sectiontitle">URI</h4><p id="dns_api_62002__p474934217154">GET /v2/zones/{zone_id}</p>
<div class="p" id="dns_api_62002__p135317011616">For details, see <a href="#dns_api_62002__table14024165">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_62002__table14024165"></a><a name="table14024165"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62002__table14024165" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter in the URI</caption><thead align="left"><tr id="dns_api_62002__row26592044"><th align="left" class="cellrowborder" valign="top" width="15.459999999999999%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_62002__p6471942"><strong id="dns_api_62002__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.09%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_62002__p54465313"><strong id="dns_api_62002__b55611459112110">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_62002__p49614245"><strong id="dns_api_62002__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.55%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_62002__p59330872"><strong id="dns_api_62002__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62002__row41071365"><td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_62002__p38446258">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_62002__p27139175">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_62002__p50789581">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.55%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_62002__p20315403">Zone ID</p>
<p id="dns_api_62002__p1669018482183">You can obtain the value by calling the API in <a href="dns_api_62003.html">Querying Public Zones</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dns_api_62002__section31475357"><h4 class="sectiontitle">Request</h4><ul id="dns_api_62002__ul35351571269"><li id="dns_api_62002__li1053565782615">Request parameters<p id="dns_api_62002__p1815201642711"><a name="dns_api_62002__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_62002__li4109190182715">Example request<p id="dns_api_62002__p16901225154816"><a name="dns_api_62002__li4109190182715"></a><a name="li4109190182715"></a>Query the zone whose ID is 2c9eb155587194ec01587224c9f90149:</p>
<pre class="codeblock" id="dns_api_62002__codeblock1127113564398">GET https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149</pre>
</li></ul>
</div>
<div class="section" id="dns_api_62002__section14842765"><h4 class="sectiontitle">Response</h4><ul id="dns_api_62002__ul8135151"><li id="dns_api_62002__li6107499">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62002__table54967495" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_62002__rcb8f5a6dbdc841d5b61b57c9a7f3946c"><th align="left" class="cellrowborder" valign="top" width="17.990000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_62002__a562463c38c994a46a5042605cbae16a2"><strong id="dns_api_62002__b1272512714015">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.77%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_62002__a037a944fa232408f9eb6d06f523458c3"><strong id="dns_api_62002__b474282814011">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.239999999999995%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_62002__ab503838cab8b41b5aacf832f2abc24e4"><strong id="dns_api_62002__b1356514305010">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62002__r90f043c750eb4b4e8d242b7f8db14709"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a8bb1298f194542789a4889ca1ecb0500">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__ae7f12de3cd5143d9b7c81746c73de547">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__af2aa29bf11dc4ede8a83ffe698c6d015">Zone ID, which is a UUID used to identify the zone</p>
</td>
</tr>
<tr id="dns_api_62002__rd94a8eae3993428ba58b7935d38f2c42"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a5b7f90ac0e964a4e8d5c3b54801a0263">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a7f54cec7482f402295ad3e3bbf884023">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a84a47ec529944403bd51bd1a130bfa9a">Zone name</p>
</td>
</tr>
<tr id="dns_api_62002__r8a93c0d071624062b4332156e7c1afd3"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__ac8461d5571384d2f99735f4dd17f36e4">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__ac782ad392b6549dc9a55042f0e89e799">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__abf3153770d0a4cf8a9ee79c8455167d5">Zone description</p>
</td>
</tr>
<tr id="dns_api_62002__rd2df7eeb23d348c3825c57d44911c2c0"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a5228458b23264d239a4eee40c3001c4f">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__en-us_topic_0057310891_p336297171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a72bf01280e51418ea295143d10e30fdb">Email address of the administrator managing the zone</p>
</td>
</tr>
<tr id="dns_api_62002__rf57ffed6121d407da625ad56b3b3741f"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__ac0b14f3593ff4331b7cd6056c8d36a44">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__aab451733f1be44f8ac79d479ca1093f3">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a57638dc3c92f4e10850d4d6ad42a846e">Zone type, which can be <strong id="dns_api_62002__b1910912018181">public</strong> or <strong id="dns_api_62002__b611062017181">private</strong></p>
</td>
</tr>
<tr id="dns_api_62002__ra6a15f87215c470e8c2fa6d2aa4a8ccc"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a2e889a776aeb42f59e288b92b372bd70">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a292032dd82fe4a0dbf0ff69bfd93d876">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__ab96c3883e8424c3187881c9ea265794f">TTL value of the SOA record set in the zone</p>
<p id="dns_api_62002__p0662131993410">The value ranges from <strong id="dns_api_62002__dns_api_62001_b2613115265713">1</strong> to <strong id="dns_api_62002__dns_api_62001_b662035245714">2147483647</strong>.</p>
<p id="dns_api_62002__p7662111973418">The default value is <strong id="dns_api_62002__dns_api_62001_b19778105913578">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_62002__r6f01d44c0047469b9ee578db3ae2e925"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__ac99c652f1d284ec496be4ad0b5364a1a">serial</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__ae5ee649ac6aa4bb4a20e678d9a24e19a">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__p1786474013426">Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server</p>
<p id="dns_api_62002__p7524749171039">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_62002__r50c368b3aa0b46f38a4617b7f797786f"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a1d2ec6fad225464f9732756d33a337b2">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a62bc066b1f5844588aa3d383f46fe71f">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__aa34a63cd4c824904be6636a6daaa09a9">Resource status</p>
<p id="dns_api_62002__a0a74025bb90644338ac11860b3ef9f42">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_62002__r3d7c6c02e04d40c0bdd0ef0a8a6045f9"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a4873ee3d3c85419b9aba19243d2c84a7">record_num</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a162e7c19e8be4764a2becf7706a46e6e">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__ab88a87d30e8e491f99661f9757711d6d">Number of record sets in the zone</p>
</td>
</tr>
<tr id="dns_api_62002__rfba699f600ef424cadbca2cd85b60887"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a2271452821c249cb9f3a445fcf60a03f">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a3fbd39a058f042e190756f9b4f941e56">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a8caf365222c34b929a1501acd4493bd1">Pool ID of the zone, which is assigned by the system</p>
</td>
</tr>
<tr id="dns_api_62002__ra366d35afa104cab8a41e36b89ca0e82"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a3026f7c44fdc4ca887f0469710558f47">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__ac54288dbf5be47a98690cfeff1e25721">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__ad419bb0aafcd4bd2adf188dbd375f71e">Project ID of the zone</p>
</td>
</tr>
<tr id="dns_api_62002__r3bb52953237f4d90883feb17321b3754"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__aa1ed0627514440769d59691c0297bb20">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a5131a3345de141acba4d51eceb924480">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a4c5d9647086944e888608bc848e37e4c">Time when the zone was created</p>
<p id="dns_api_62002__a0d1ae2e82e4645939f6aa3d118f88914">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_62002__rf0e8562b23244c968c21c2f7ffc1e376"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a27068ff11a0443f9ad9964f4934f1be6">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__a8d6c4b16bc5c4b42a86e2ea9ebdff263">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a904e167e17d0450aa1f324b045fb7f4f">Time when the zone was updated</p>
<p id="dns_api_62002__en-us_topic_0057310891_p583516468316">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_62002__rc71d074f37b143968b8b33fb7d0887c8"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__en-us_topic_0057310891_p288749251572">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__en-us_topic_0057310891_p571676251572">Object</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__en-us_topic_0057310891_p660161572">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_62002__b84235270695245">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_62002__p286121420434">For details, see <a href="#dns_api_62002__table0172144213344">Table 3</a>.</p>
</td>
</tr>
<tr id="dns_api_62002__r5a57c1dba2934130a772bfc188e27c7b"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_62002__a414da27796154a8ea0f3f5d155266ce6">masters</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_62002__ac58ddffcdd4b4db48b9da9a1aa4b94b8">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_62002__a67f94f4a1cee4d80ad3886d215def3de">Master DNS servers, from which the slave servers get DNS information</p>
<p id="dns_api_62002__en-us_topic_0057310891_p05918233215">This parameter is not used currently.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_62002__table0172144213344"></a><a name="table0172144213344"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_62002__table0172144213344" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_62002__b44111326409">links</strong> field</caption><thead align="left"><tr id="dns_api_62002__row917304253418"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dns_api_62002__p101731742153416"><strong id="dns_api_62002__b1213524512194">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dns_api_62002__p0174542163418"><strong id="dns_api_62002__b735924611918">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.74999999999999%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dns_api_62002__p7174194243414"><strong id="dns_api_62002__b1812694711911">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_62002__row1390694871216"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_62002__p8907184881217">self</p>
</td>
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_62002__p9907184891219">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_62002__p1890754813127">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_62002__row1999616550462"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_62002__p136561245153620">next</p>
</td>
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_62002__p19656144517367">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_62002__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dns_api_62002__ul2026335"><li id="dns_api_62002__li18237015">Example response<pre class="screen" id="dns_api_62002__screen6709033920539">{
"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_62002__i34642236141555">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
}
</pre>
</li></ul>
</div>
<div class="section" id="dns_api_62002__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_62002__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_62002__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>