forked from docs/doc-exports
Qin Ying, Fan
a79d5bdbdb
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
167 lines
13 KiB
HTML
167 lines
13 KiB
HTML
<a name="dns_api_61002"></a><a name="dns_api_61002"></a>
|
|
|
|
<h1 class="topictitle1">Querying the DNS API Version</h1>
|
|
<div id="body1537426938220"><div class="section" id="dns_api_61002__section3569153217343"><h4 class="sectiontitle">Function</h4><p id="dns_api_61002__p2420228517348">Query a specified DNS API version.</p>
|
|
<p id="dns_api_61002__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_61002__section6163262617350"><h4 class="sectiontitle">URI</h4><p id="dns_api_61002__p5527305017659">GET /{version}</p>
|
|
<div class="p" id="dns_api_61002__p4739112314582">For details, see <a href="#dns_api_61002__table14024165">Table 1</a>.
|
|
<div class="tablenoborder"><a name="dns_api_61002__table14024165"></a><a name="table14024165"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61002__table14024165" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter in the URI</caption><thead align="left"><tr id="dns_api_61002__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_61002__p6471942"><strong id="dns_api_61002__b162774213314533_1">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.459999999999999%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_61002__p54465313"><strong id="dns_api_61002__b593421527191713">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.53%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_61002__p49614245"><strong id="dns_api_61002__b7804141120356_1">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_61002__p59330872"><strong id="dns_api_61002__b842352706112423_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dns_api_61002__row41071365"><td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_61002__p38446258">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_61002__p27139175">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_61002__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_61002__p20315403">Version to be queried, which starts with <strong id="dns_api_61002__b842352706141446">v</strong>, for example, <strong id="dns_api_61002__b842352706141516">v2</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dns_api_61002__section4207148117353"><h4 class="sectiontitle">Request</h4><ul id="dns_api_61002__ul35351571269"><li id="dns_api_61002__li1053565782615">Request parameters<p id="dns_api_61002__p1815201642711"><a name="dns_api_61002__li1053565782615"></a><a name="li1053565782615"></a>None</p>
|
|
</li><li id="dns_api_61002__li4109190182715">Example request<p id="dns_api_61002__p1651121054613"><a name="dns_api_61002__li4109190182715"></a><a name="li4109190182715"></a>Query information about the v2 API version.</p>
|
|
<pre class="codeblock" id="dns_api_61002__codeblock1354910278390">GET https://{DNS_Endpoint}/v2</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dns_api_61002__section01535143610"><h4 class="sectiontitle">Response</h4><ul id="dns_api_61002__ul1922518111092"><li id="dns_api_61002__li61921720171010">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61002__table6255205892049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter in the response</caption><thead align="left"><tr id="dns_api_61002__row1727035092049"><th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_61002__p5672109992049"><strong id="dns_api_61002__b162774213314533_3">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.189999999999998%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_61002__p3100628892049"><strong id="dns_api_61002__b7804141120356_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.629999999999995%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_61002__p2848141492049"><strong id="dns_api_61002__b842352706112423_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dns_api_61002__row2529320492049"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_61002__p3548368392049">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_61002__p5560610792049">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_61002__p780080392049">Version object. For details, see <a href="#dns_api_61002__table3345872992049">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dns_api_61002__table3345872992049"></a><a name="table3345872992049"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61002__table3345872992049" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_61002__b842352706162841">version</strong> field</caption><thead align="left"><tr id="dns_api_61002__row4161787792049"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dns_api_61002__p1560490192049"><strong id="dns_api_61002__b162774213314533_5">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dns_api_61002__p5603748692049"><strong id="dns_api_61002__b7804141120356_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dns_api_61002__p4274248792049"><strong id="dns_api_61002__b842352706112423_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dns_api_61002__row3958938492049"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p5262353092049">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p3464752492049">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p848217563142">Version status, which can be:</p>
|
|
<ul id="dns_api_61002__ul1897113391488"><li id="dns_api_61002__li4972193911812"><strong id="dns_api_61002__b04019265257">CURRENT</strong>: widely used version</li><li id="dns_api_61002__li1497210391282"><strong id="dns_api_61002__b176585275259">SUPPORTED</strong>: earlier version which is still supported</li><li id="dns_api_61002__li997217391284"><strong id="dns_api_61002__b16212132942515">DEPRECATED</strong>: deprecated version which may be deleted later</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row2511266892049"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p2086025192049">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p1195876692049">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p2913599892049">Version number, for example, <strong id="dns_api_61002__b84235270614227">v2</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row15102829192914"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p5102192912291">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p1710232902916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p1410222992917">Time when the API version was released</p>
|
|
<p id="dns_api_61002__p1481431019435">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row6155145713164"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p81562578165">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p161560570169">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p138029367173">Maximum micro-version number. If the APIs do not support micro-versions, the value is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row5867187131816"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p586811716185">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p1686820701814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p8453122951815">Minimum micro-version number. If the APIs do not support micro-versions, the value is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row6089739292049"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_61002__p3374170192049">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_61002__p4872327592049">Array of object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_61002__p5427120992049">URL of the current version. For details, see <a href="#dns_api_61002__table0172144213344">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dns_api_61002__table0172144213344"></a><a name="table0172144213344"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_61002__table0172144213344" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_61002__b135362034142618">links</strong> field</caption><thead align="left"><tr id="dns_api_61002__row917304253418"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_61002__p101731742153416"><strong id="dns_api_61002__b72591837112616">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_61002__p0174542163418"><strong id="dns_api_61002__b932797988">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.74999999999999%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_61002__p7174194243414"><strong id="dns_api_61002__b116191914172617">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dns_api_61002__row1917494211345"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_61002__p13174134215348">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_61002__p181741642173417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_61002__p1017434223419">Link address</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dns_api_61002__row455095771113"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_61002__p10551115771111">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_61002__p17552957121114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.74999999999999%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_61002__p14552657201118">Link marker name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dns_api_61002__li7863653171013">Example response<pre class="screen" id="dns_api_61002__screen36798461171411">{
|
|
"version":
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v2",
|
|
"links": [
|
|
{
|
|
"href": "https://<em id="dns_api_61002__i45374312141510">Endpoint</em>/v2/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"updated": "2018-09-18T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dns_api_61002__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_61002__dns_api_61001_p711102924515">If the API call returns a code of 2<em id="dns_api_61002__dns_api_61001_i113378598177">xx</em>, for example, 200, 202, or 204, the request is successful.</p>
|
|
<p id="dns_api_61002__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>
|
|
|