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>
141 lines
10 KiB
HTML
141 lines
10 KiB
HTML
<a name="deh_05_0801"></a><a name="deh_05_0801"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions</h1>
|
|
<div id="body1538191403742"><div class="section" id="deh_05_0801__section54478915181842"><h4 class="sectiontitle">Function</h4><p id="deh_05_0801__p40170843">This API is used to query all API versions available to the DeH service.</p>
|
|
</div>
|
|
<div class="section" id="deh_05_0801__section53791107181842"><h4 class="sectiontitle">URI</h4><p id="deh_05_0801__p53736847103512">GET /</p>
|
|
</div>
|
|
<div class="section" id="deh_05_0801__section10595142262918"><h4 class="sectiontitle">Request</h4><p id="deh_05_0801__p11680610135814">None</p>
|
|
</div>
|
|
<div class="section" id="deh_05_0801__section15015447489"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0801__table73128527379" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="deh_05_0801__row431215273714"><th align="left" class="cellrowborder" valign="top" width="25.16251625162516%" id="mcps1.3.4.2.2.4.1.1"><p id="deh_05_0801__p186481257389"><strong id="deh_05_0801__b1629615953015">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.882588258825876%" id="mcps1.3.4.2.2.4.1.2"><p id="deh_05_0801__p264813516384"><strong id="deh_05_0801__b635631017303">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.95489548954895%" id="mcps1.3.4.2.2.4.1.3"><p id="deh_05_0801__p19648555382"><strong id="deh_05_0801__b3311101123019">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0801__row183121523375"><td class="cellrowborder" valign="top" width="25.16251625162516%" headers="mcps1.3.4.2.2.4.1.1 "><p id="deh_05_0801__p186481955388">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.882588258825876%" headers="mcps1.3.4.2.2.4.1.2 "><p id="deh_05_0801__p1864835163814">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.95489548954895%" headers="mcps1.3.4.2.2.4.1.3 "><p id="deh_05_0801__p1649358389">Specifies the API versions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0801__table74931736173815" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="deh_05_0801__b5536197161619">versions</strong> field description</caption><thead align="left"><tr id="deh_05_0801__row549420367383"><th align="left" class="cellrowborder" valign="top" width="21.83218321832183%" id="mcps1.3.4.3.2.4.1.1"><p id="deh_05_0801__p19230857133814"><strong id="deh_05_0801__b18327159201611">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.54235423542354%" id="mcps1.3.4.3.2.4.1.2"><p id="deh_05_0801__p202315573383"><strong id="deh_05_0801__b1313652560">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.625462546254624%" id="mcps1.3.4.3.2.4.1.3"><p id="deh_05_0801__p1523145703813"><strong id="deh_05_0801__b97931348016">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0801__row1549483613384"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p12318572388">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p152311157173816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p1423185713814">Specifies the ID of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0801__row4494336153817"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p182311657193820">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p9231125783814">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p4231357103812">Specifies the URL of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0801__row849419363384"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p92311957113815">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p1023195711384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p132311357163812">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_0801__row449413611382"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p323116579380">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p20231185713818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p223119577382">Specifies the API version status.</p>
|
|
<ul id="deh_05_0801__ul5231115723820"><li id="deh_05_0801__li123155733818"><strong id="deh_05_0801__b8750591114">CURRENT</strong>: indicates a primary version.</li><li id="deh_05_0801__li12232185713810"><strong id="deh_05_0801__b1362524131119">SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="deh_05_0801__li823275715387"><strong id="deh_05_0801__b183298371111">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0801__row549403614386"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p62321457143816">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p12321857183811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p723216575383">Specifies the API version update time, which must be UTC time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0801__row1249410361387"><td class="cellrowborder" valign="top" width="21.83218321832183%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0801__p1232195763819">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0801__p19232557113820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.625462546254624%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0801__p10232135717384">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_0801__table65661119173910" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="deh_05_0801__b2912144161716">links</strong> field description</caption><thead align="left"><tr id="deh_05_0801__row356791918394"><th align="left" class="cellrowborder" valign="top" width="21.74217421742174%" id="mcps1.3.4.4.2.4.1.1"><p id="deh_05_0801__p13801311390"><strong id="deh_05_0801__b171515447178">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.54235423542354%" id="mcps1.3.4.4.2.4.1.2"><p id="deh_05_0801__p183801311399"><strong id="deh_05_0801__b722593748">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.71547154715471%" id="mcps1.3.4.4.2.4.1.3"><p id="deh_05_0801__p1638011315399"><strong id="deh_05_0801__b484994441513">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="deh_05_0801__row15567191914394"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0801__p73811731103916">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0801__p10381173119394">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.71547154715471%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0801__p113819319398">Specifies the URL of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="deh_05_0801__row5567181973910"><td class="cellrowborder" valign="top" width="21.74217421742174%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0801__p83818315392">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54235423542354%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0801__p163811131113917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.71547154715471%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0801__p4381031193915">Specifies the API URL dependency.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="deh_05_0801__section1768432015261"><h4 class="sectiontitle">Example Request</h4><p id="deh_05_0801__p173117478139">Query all available API versions of DeH.</p>
|
|
<pre class="screen" id="deh_05_0801__screen452772885215">GET /</pre>
|
|
</div>
|
|
<div class="section" id="deh_05_0801__section156132912611"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="deh_05_0801__screen62654542181842">{
|
|
"versions": [
|
|
{
|
|
"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_0801__section9992350"><h4 class="sectiontitle">Status Code</h4><p id="deh_05_0801__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>
|
|
|