forked from laiweijian4/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>
143 lines
10 KiB
HTML
143 lines
10 KiB
HTML
<a name="dds_api_0018"></a><a name="dds_api_0018"></a>
|
|
|
|
<h1 class="topictitle1">Querying the API Version List</h1>
|
|
<div id="body42915540"><div class="section" id="dds_api_0018__section9793815440"><h4 class="sectiontitle">Function</h4><p id="dds_api_0018__p793298915440">This API is used to query the currently supported API version list.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0018__section428804115440"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0018__ul1178707715440"><li id="dds_api_0018__li3897482915440">URI format<p id="dds_api_0018__p1165414212274"><a name="dds_api_0018__li3897482915440"></a><a name="li3897482915440"></a>GET https://{Endpoint}/</p>
|
|
</li><li id="dds_api_0018__li2560149615440">Parameter description<p id="dds_api_0018__p2908688015440"><a name="dds_api_0018__li2560149615440"></a><a name="li2560149615440"></a>N/A</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0018__section2907369315440"><h4 class="sectiontitle">Requests</h4><p id="dds_api_0018__p32410269289">None</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0018__section5543006115440"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0018__ul6064993315440"><li id="dds_api_0018__li897849015440">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table3575976715440" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0018__row5028223115440"><th align="left" class="cellrowborder" valign="top" width="26.26262626262626%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0018__p4632888215440">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.40404040404041%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0018__p6165196615440">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_0018__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0018__row3342858315440"><td class="cellrowborder" valign="top" width="26.26262626262626%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0018__p2336072515440">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0018__p94851531275">Array of objects</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_0018__p476126915440">Indicates the list of detailed API version information. For more information, see <a href="#dds_api_0018__table37479565104653">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0018__table37479565104653"></a><a name="table37479565104653"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table37479565104653" frame="border" border="1" rules="all"><caption><b>Table 2 </b>versions field data structure description</caption><thead align="left"><tr id="dds_api_0018__row65790814104653"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0018__p27455703104653">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.23%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0018__p9319469104653">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.239999999999995%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0018__p1143415283591">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0018__row8861837104653"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p46720233104653">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p26242496104653">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p45267452104653">Indicates the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row1548795912115"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p26342211121111">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p18625313281">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p31978734121111">Indicates the API link information. For more information, see <a href="#dds_api_0018__table630875915440">Table 3</a>.</p>
|
|
<div class="note" id="dds_api_0018__note1766615256328"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0018__p566620258325">If the version is <strong id="dds_api_0018__b180722435413">v3</strong>, the value is <strong id="dds_api_0018__b7463134518547">[]</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row4753892104653"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p49520946104653">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p51773656104653">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p32916607104653">Indicates the version status.</p>
|
|
<p id="dds_api_0018__p15858184432115">The value CURRENT indicates that the version has been released.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row1648012414408"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p154811524144020">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p10856104114111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p44820241403">Indicates the subversion of the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row050892716406"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p12508727124012">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p468916534116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p050922734018">Indicates the minimum API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row27814010104653"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p38342341104653">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p18721892104653">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p40078272104653">Indicates the version update time.</p>
|
|
<p id="dds_api_0018__p25160128104653">The format is yyyy-mm-ddThh:mm:ssZ.</p>
|
|
<p id="dds_api_0018__p25114560104653"><strong id="dds_api_0018__b842352706104536">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0018__b842352706161738">Z</strong> indicates the UTC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0018__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__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_0018__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_0018__p3950073415440">Name</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_0018__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_0018__p2056123485910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0018__row5319717215440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0018__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_0018__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_0018__p619568715440">Indicates the API URL and the value is <strong id="dds_api_0018__b84235270618633">""</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0018__row5576118615440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0018__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_0018__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_0018__p5004333115440">Its value is <strong id="dds_api_0018__b84235270616818">self</strong>, indicating that URL is a local link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0018__ul3468747215440"><li id="dds_api_0018__li4375179915440">Response example<pre class="codeblock" id="dds_api_0018__codeblock47227895154525">{
|
|
"versions": [
|
|
{
|
|
"id": "v3",
|
|
"links": [],
|
|
"status": "CURRENT",
|
|
"version": "",
|
|
"min_version": "",
|
|
"updated": "2017-02-07T17:34:02Z"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0018__section17992204432820"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0018__p16131712193312">Status Code:200.</p>
|
|
<p id="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_0018__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="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>
|
|
|