forked from docs/doc-exports
Zaoxu, Li
1c7fe15e7b
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com> Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
159 lines
12 KiB
HTML
159 lines
12 KiB
HTML
<a name="deh_05_0802"></a><a name="deh_05_0802"></a>
|
|
|
|
<h1 class="topictitle1">Querying an API Version</h1>
|
|
<div id="body1538191403742"><div class="section" id="deh_05_0802__section54478915181842"><h4 class="sectiontitle">Function</h4><p id="deh_05_0802__p40170843">This API is used to query a specified API version.</p>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section53791107181842"><h4 class="sectiontitle">URI</h4><p id="deh_05_0802__p53736847103512">GET /{api_version}</p>
|
|
<p id="deh_05_0802__p11642506530"><a href="#deh_05_0802__table46110007">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="deh_05_0802__table46110007"></a><a name="table46110007"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0802__table46110007" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters description</caption><thead align="left"><tr id="deh_05_0802__row14148614"><th align="left" class="cellrowborder" valign="top" width="20.74%" id="mcps1.3.2.4.2.4.1.1"><p id="deh_05_0802__p5187119"><strong id="deh_05_0802__b114121766204">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.4.2.4.1.2"><p id="deh_05_0802__p17503500"><strong id="deh_05_0802__b15192157132016">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.27%" id="mcps1.3.2.4.2.4.1.3"><p id="deh_05_0802__p8497414"><strong id="deh_05_0802__b29120892011">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0802__row17201924"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.2.4.2.4.1.1 "><p id="deh_05_0802__p51178607">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.4.2.4.1.2 "><p id="deh_05_0802__p51826478">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.2.4.2.4.1.3 "><p id="deh_05_0802__p37195178">Specifies the API version, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section15830195355312"><h4 class="sectiontitle">Request</h4><p id="deh_05_0802__p571913595911">None</p>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section12542181845412"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0802__table932651115402" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="deh_05_0802__row632751144019"><th align="left" class="cellrowborder" valign="top" width="21.562156215621563%" id="mcps1.3.4.2.2.4.1.1"><p id="deh_05_0802__p9860723164019"><strong id="deh_05_0802__b15107145172014">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.092309230923092%" id="mcps1.3.4.2.2.4.1.2"><p id="deh_05_0802__p686082334017"><strong id="deh_05_0802__b18471115222014">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.345534553455344%" id="mcps1.3.4.2.2.4.1.3"><p id="deh_05_0802__p1886092312404"><strong id="deh_05_0802__b1242615510205">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0802__row123275112402"><td class="cellrowborder" valign="top" width="21.562156215621563%" headers="mcps1.3.4.2.2.4.1.1 "><p id="deh_05_0802__p1386092313405">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.092309230923092%" headers="mcps1.3.4.2.2.4.1.2 "><p id="deh_05_0802__p158601237401">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.345534553455344%" headers="mcps1.3.4.2.2.4.1.3 "><p id="deh_05_0802__p1786018231404">Specifies information about a specified API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0802__table10504154684017" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="deh_05_0802__b6348149205411">version</strong> field description</caption><thead align="left"><tr id="deh_05_0802__row195041146114018"><th align="left" class="cellrowborder" valign="top" width="21.74217421742174%" id="mcps1.3.4.3.2.4.1.1"><p id="deh_05_0802__p137391901414"><strong id="deh_05_0802__b128431226101819">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.46224622462246%" id="mcps1.3.4.3.2.4.1.2"><p id="deh_05_0802__p573910018419"><strong id="deh_05_0802__b1527907307">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.79557955795579%" id="mcps1.3.4.3.2.4.1.3"><p id="deh_05_0802__p1773911014111"><strong id="deh_05_0802__b183701457182312">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0802__row10505104624018"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p57409054119">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p574017014114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p6740150164110">Specifies the ID of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row1450512465409"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p77409011419">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p5740170104119">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p147401007419">Specifies the URL of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row1150544617409"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p974015034117">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p574010017412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p11740200134111">Specifies the microversion. If the APIs of this version support micro-versions, set this parameter to the supported minimum micro-version. If the microversion is not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row10505134654015"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p1740160134112">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p57402003413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p157401018419">Specifies the API version status.</p>
|
|
<ul id="deh_05_0802__ul17740207419"><li id="deh_05_0802__li9740205415"><strong id="deh_05_0802__b8172322417">CURRENT</strong>: indicates a primary version.</li><li id="deh_05_0802__li14740120104116"><strong id="deh_05_0802__b9516142419245">SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="deh_05_0802__li1774019024119"><strong id="deh_05_0802__b1889752617249">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row175051146204016"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p167404044114">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p147408016418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p874010004118">Specifies the API version update time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row950574694019"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0802__p12740140154114">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.46224622462246%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0802__p474080164119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.79557955795579%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0802__p107411606414">If the APIs of this version support micro-versions, set this parameter to the maximum micro-version supported. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0802__table9766624134111" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="deh_05_0802__b2507198171914">links</strong> field description</caption><thead align="left"><tr id="deh_05_0802__row87661624114116"><th align="left" class="cellrowborder" valign="top" width="24.172417241724172%" id="mcps1.3.4.4.2.4.1.1"><p id="deh_05_0802__p322644118419"><strong id="deh_05_0802__b8488131191919">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.882588258825876%" id="mcps1.3.4.4.2.4.1.2"><p id="deh_05_0802__p92261941164112"><strong id="deh_05_0802__b758325692">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.94499449944995%" id="mcps1.3.4.4.2.4.1.3"><p id="deh_05_0802__p172268418416"><strong id="deh_05_0802__b158175782413">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0802__row157671324184112"><td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0802__p1822764124113">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.882588258825876%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0802__p62278417416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.94499449944995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0802__p92277418411">Specifies the URL of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0802__row2767724134113"><td class="cellrowborder" valign="top" width="24.172417241724172%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0802__p1122713413410">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.882588258825876%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0802__p19227204112415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.94499449944995%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0802__p13227041124110">Specifies the API URL dependency.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section1768432015261"><h4 class="sectiontitle">Example Request</h4><p id="deh_05_0802__p1622155391415">Query the information about API v1.0 of DeH.</p>
|
|
<pre class="screen" id="deh_05_0802__screen145611292411">GET /v1.0</pre>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section156132912611"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="deh_05_0802__screen62654542181842">{
|
|
"version": {
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"href": "https//deh.xxx.com/v1.0/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "SUPPORTED",
|
|
"updated": "2016-12-01T11:33:21Z",
|
|
"version": ""
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="deh_05_0802__section9992350"><h4 class="sectiontitle">Status Code</h4><p id="deh_05_0802__p5641212">See <a href="deh_02_0016.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="deh_05_0800.html">API Version Query</a></div>
|
|
</div>
|
|
</div>
|
|
|