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

140 lines
11 KiB
HTML

<a name="dns_api_61001"></a><a name="dns_api_61001"></a>
<h1 class="topictitle1">Listing All DNS API Versions</h1>
<div id="body1479345538968"><div class="section" id="dns_api_61001__section3569153217343"><h4 class="sectiontitle">Function</h4><p id="dns_api_61001__p2420228517348">List all DNS API versions.</p>
<p id="dns_api_61001__p1565602592328">To be interconnected with a third-party system, the current DNS version supports 1024- and 2048-bit DH key exchange algorithms, and the 2048-bit algorithm is recommended.</p>
</div>
<div class="section" id="dns_api_61001__section6163262617350"><h4 class="sectiontitle">URI</h4><p id="dns_api_61001__p5527305017659">GET /</p>
</div>
<div class="section" id="dns_api_61001__section84941832125012"><h4 class="sectiontitle">Request</h4><ul id="dns_api_61001__ul35351571269"><li id="dns_api_61001__li1053565782615">Request parameters<p id="dns_api_61001__p1815201642711"><a name="dns_api_61001__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_61001__li4109190182715">Example request<p id="dns_api_61001__p1651121054613"><a name="dns_api_61001__li4109190182715"></a><a name="li4109190182715"></a>List all DNS API versions.</p>
<pre class="codeblock" id="dns_api_61001__codeblock1354910278390">GET https://{DNS_Endpoint}/</pre>
</li></ul>
</div>
<div class="section" id="dns_api_61001__section2142173017358"><h4 class="sectiontitle">Response</h4><ul id="dns_api_61001__ul24043226171010"><li id="dns_api_61001__li61921720171010">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61001__table6255205892049" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter in the response</caption><thead align="left"><tr id="dns_api_61001__row1727035092049"><th align="left" class="cellrowborder" valign="top" width="20.247975202479754%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_61001__p5672109992049"><strong id="dns_api_61001__b162774213314533_1">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.568043195680435%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_61001__p3100628892049"><strong id="dns_api_61001__b84235270619112_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.18398160183982%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_61001__p2848141492049"><strong id="dns_api_61001__b842352706112423_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_61001__row2529320492049"><td class="cellrowborder" valign="top" width="20.247975202479754%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_61001__p3548368392049">versions</p>
</td>
<td class="cellrowborder" valign="top" width="19.568043195680435%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_61001__p5560610792049">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60.18398160183982%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_61001__p780080392049">Version object. For details, see <a href="#dns_api_61001__table2788528392049">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_61001__table2788528392049"></a><a name="table2788528392049"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61001__table2788528392049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of the <strong>versions</strong> field</caption><thead align="left"><tr id="dns_api_61001__row100602392049"><th align="left" class="cellrowborder" valign="top" width="20.437956204379564%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dns_api_61001__p1437906692049"><strong id="dns_api_61001__b162774213314533_3">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.37806219378062%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dns_api_61001__p2385367792049"><strong id="dns_api_61001__b84235270619112_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.18398160183982%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dns_api_61001__p5309965692049"><strong id="dns_api_61001__b842352706112423_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_61001__row610488492049"><td class="cellrowborder" valign="top" width="20.437956204379564%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61001__p2473359292049">values</p>
</td>
<td class="cellrowborder" valign="top" width="19.37806219378062%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61001__p5726396592049">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="60.18398160183982%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61001__p786961192049">Version list. For details, see <a href="#dns_api_61001__table3345872992049">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_61001__table3345872992049"></a><a name="table3345872992049"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61001__table3345872992049" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_61001__b1298123714016">values</strong> field</caption><thead align="left"><tr id="dns_api_61001__row4161787792049"><th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_61001__p1560490192049"><strong id="dns_api_61001__b162774213314533_5">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.189999999999998%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_61001__p5603748692049"><strong id="dns_api_61001__b84235270619112_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.629999999999995%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_61001__p4274248792049"><strong id="dns_api_61001__b842352706112423_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_61001__row3958938492049"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_61001__p5262353092049">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_61001__p3464752492049">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_61001__p848217563142">Version status, which can be:</p>
<ul id="dns_api_61001__ul19911143415371"><li id="dns_api_61001__li1691203453711"><strong id="dns_api_61001__b842352706115252">CURRENT</strong>: widely used version</li><li id="dns_api_61001__li10912153414378"><strong id="dns_api_61001__b965321614118">SUPPORTED</strong>: earlier version which is still supported</li><li id="dns_api_61001__li491212349371"><strong id="dns_api_61001__b842352706115458">DEPRECATED</strong>: deprecated version which may be deleted later</li></ul>
</td>
</tr>
<tr id="dns_api_61001__row2511266892049"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_61001__p2086025192049">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_61001__p1195876692049">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_61001__p2913599892049">Version number</p>
</td>
</tr>
<tr id="dns_api_61001__row6089739292049"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_61001__p3374170192049">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_61001__p4872327592049">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_61001__p5427120992049">URL of the current version. For details, see <a href="#dns_api_61001__table0172144213344">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_61001__table0172144213344"></a><a name="table0172144213344"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61001__table0172144213344" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_61001__b948719365414">links</strong> field</caption><thead align="left"><tr id="dns_api_61001__row917304253418"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="dns_api_61001__p101731742153416"><strong id="dns_api_61001__b61661641440">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="dns_api_61001__p0174542163418"><strong id="dns_api_61001__b1041951998">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.74999999999999%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="dns_api_61001__p7174194243414"><strong id="dns_api_61001__b13281552192019">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_61001__row1917494211345"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_61001__p13174134215348">href</p>
</td>
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_61001__p181741642173417">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_61001__p1017434223419">Link address</p>
</td>
</tr>
<tr id="dns_api_61001__row455095771113"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_61001__p10551115771111">rel</p>
</td>
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_61001__p17552957121114">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_61001__p14552657201118">Link marker name</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_61001__li7863653171013">Example response<pre class="screen" id="dns_api_61001__screen36798461171411">{
"versions": {
"values": [
{
"status": "CURRENT",
"id": "v2",
"links": [
{
"href": "https://<em id="dns_api_61001__i45374312141510">Endpoint</em>/v2",
"rel": "self"
}
]
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="dns_api_61001__section1917896317411"><h4 class="sectiontitle">Returned Value</h4><p id="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_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_61000.html">Version Management</a></div>
</div>
</div>