forked from docs/doc-exports
Wang , Deng Ke
60010eb9d0
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
141 lines
11 KiB
HTML
141 lines
11 KiB
HTML
<a name="dds_api_0019"></a><a name="dds_api_0019"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Version Information</h1>
|
|
<div id="body13251620"><div class="section" id="dds_api_0019__section50404481154838"><h4 class="sectiontitle">Function</h4><p id="dds_api_0019__p56231143154838">This API is used to query the specified API version.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0019__section36318247154838"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0019__ul173666483286"><li id="dds_api_0019__li43668481287">URI format<p id="dds_api_0019__p10145134631815"><a name="dds_api_0019__li43668481287"></a><a name="li43668481287"></a>GET https://{Endpoint}/{version}</p>
|
|
</li><li id="dds_api_0019__li771939193611">Parameter description<p id="dds_api_0019__p652175093617"><a name="dds_api_0019__li771939193611"></a><a name="li771939193611"></a>N/A</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0019__section47398739154838"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0019__ul6575065367"><li id="dds_api_0019__li15575186183612">Example request<p id="dds_api_0019__p98119923617"><a name="dds_api_0019__li15575186183612"></a><a name="li15575186183612"></a>GET https://dds.eu-de.otc.t-systems.com/v3</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0019__section59724852154838"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0019__ul18241230105616"><li id="dds_api_0019__li28551847105616">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table62971306105515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0019__row21185732105515"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0019__p19221610105536"><strong id="dds_api_0019__b842352706102328_3">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0019__p13446610105536">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0019__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0019__row3452848511416"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0019__p4534392511416">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0019__p146911450319">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0019__p790243911416">Indicates the list of detailed API version information. For more information, see <a href="#dds_api_0019__table57914909154838">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0019__table57914909154838"></a><a name="table57914909154838"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table57914909154838" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="dds_api_0019__b835152931112">version</strong> field data structure description</caption><thead align="left"><tr id="dds_api_0019__row17905664154838"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0019__p41072674154838"><strong id="dds_api_0019__b842352706102328_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0019__p38552284154838">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0019__p35727319154838">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0019__row8231739154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p62791086154838">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p52913243154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p58114280154838">Indicates the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row83118291298"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p2684540212911">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p121791290324">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p16707192915253">Indicates the API version link information. For more information, see <a href="#dds_api_0019__table630875915440">Table 3</a>.</p>
|
|
<div class="note" id="dds_api_0019__note1766615256328"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0019__p566620258325">If the version is <strong id="dds_api_0019__b178932184317">v3</strong>, the value is <strong id="dds_api_0019__b1191332194310">[]</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row53266474154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p19617131154838">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p45483744154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p60304625154838">Indicates the version status. The value <strong id="dds_api_0019__b1392026309">CURRENT</strong> indicates that the version has been released.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row1144294017433"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p154811524144020">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p10856104114111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p44820241403">Indicates the subversion of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row17567134264316"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p12508727124012">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p468916534116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p050922734018">Indicates the minimum API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row5870720154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0019__p5766344154838">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0019__p64420704154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0019__p50694512154838">Indicates the version update time.</p>
|
|
<p id="dds_api_0019__p53597429154838">The format is yyyy-mm-ddThh:mm:ssZ.</p>
|
|
<p id="dds_api_0019__p12614817154838"><strong id="dds_api_0019__b124899218206">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0019__b174898242017">Z</strong> indicates the UTC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0019__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table630875915440" frame="border" border="1" rules="all"><caption><b>Table 3 </b>links field data structure description</caption><thead align="left"><tr id="dds_api_0019__row4191288815440"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0019__p3950073415440"><strong id="dds_api_0019__b842352706102328_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0019__p4544288515440">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0019__p5699506015440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0019__row5319717215440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0019__p1400369315440">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.800000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0019__p6055731815440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0019__p619568715440">Indicates the API URL and the value is <strong id="dds_api_0019__b842352706181135">""</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0019__row5576118615440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0019__p2036224315440">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.800000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0019__p3872902515440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0019__p5004333115440">Its value is <strong id="dds_api_0019__b6291128112011">self</strong>, indicating that URL is a local link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0019__ul49821912154838"><li id="dds_api_0019__li45744025154838">Response example<pre class="codeblock" id="dds_api_0019__codeblock41037819152920">{
|
|
"version": {
|
|
"id": "v3",
|
|
"links": [],
|
|
"status": "CURRENT",
|
|
"version": "",
|
|
"min_version": "",
|
|
"updated": "2017-02-07T17:34:02Z"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0019__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0019__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0019__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0019__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0019__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_version.html">Querying the API Version</a></div>
|
|
</div>
|
|
</div>
|
|
|