forked from docs/doc-exports
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: weihongmin1 <weihongmin1@huawei.com> Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
145 lines
12 KiB
HTML
145 lines
12 KiB
HTML
<a name="en-us_topic_0133254023"></a><a name="en-us_topic_0133254023"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body1538020653458"><div class="section" id="en-us_topic_0133254023__section09221041582"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0133254023__p17368157585">This API is used to query the versions of EPS APIs.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254023__section189314416582"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0133254023__p936920595819">GET /</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254023__section997294115812"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0133254023__p7107128162013">Example request</p>
|
|
<pre class="codeblock" id="en-us_topic_0133254023__codeblock191706312131"><strong id="en-us_topic_0133254023__b2044661510423">GET https://{</strong><em id="en-us_topic_0133254023__i6446161517421">EPS endpoint</em><strong id="en-us_topic_0133254023__b8447171524211">}/</strong></pre>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254023__section1097374185817"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0133254023__p165182016166"><strong id="en-us_topic_0133254023__b1867246141914">Status code: 200</strong></p>
|
|
<ul id="en-us_topic_0133254023__ul0371755581"><li id="en-us_topic_0133254023__li1937113514580">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254023__table18987104115819" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0133254023__row7371195195812"><th align="left" class="cellrowborder" valign="top" width="23.45765423457654%" id="mcps1.3.4.3.1.1.2.4.1.1"><p id="en-us_topic_0133254023__p5371165165813"><strong id="en-us_topic_0133254023__b03118191503">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.92740725927407%" id="mcps1.3.4.3.1.1.2.4.1.2"><p id="en-us_topic_0133254023__p1537113519582"><strong id="en-us_topic_0133254023__b9311141919018">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.614938506149386%" id="mcps1.3.4.3.1.1.2.4.1.3"><p id="en-us_topic_0133254023__p113732585810"><strong id="en-us_topic_0133254023__b4311141916011">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254023__row93739575817"><td class="cellrowborder" valign="top" width="23.45765423457654%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="en-us_topic_0133254023__p937395155811">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.92740725927407%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="en-us_topic_0133254023__p18373958581">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.614938506149386%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="en-us_topic_0133254023__p337310525812">Specifies the list of all versions.</p>
|
|
<p id="en-us_topic_0133254023__p7718492171">For details, see <a href="#en-us_topic_0133254023__table14997943587">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254023__li937314545810"><strong id="en-us_topic_0133254023__b6699296094725">versions</strong> field data structure
|
|
<div class="tablenoborder"><a name="en-us_topic_0133254023__table14997943587"></a><a name="table14997943587"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254023__table14997943587" frame="border" border="1" rules="all"><caption><b>Table 2 </b>versions field data structure</caption><thead align="left"><tr id="en-us_topic_0133254023__row15373205155810"><th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.4.3.2.2.2.4.1.1"><p id="en-us_topic_0133254023__p23734575810">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.4.3.2.2.2.4.1.2"><p id="en-us_topic_0133254023__p537355135819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.2.2.4.1.3"><p id="en-us_topic_0133254023__p13731157581">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254023__row937310520584"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p1337318555817">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p153732516582">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p1137375165813">Specifies the version ID, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row937318575818"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p537316518581">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p63734525816">List<Link></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p537311518582">Specifies the API URL.</p>
|
|
<p id="en-us_topic_0133254023__p033634714183">For details, see <a href="#en-us_topic_0133254023__table9352054589">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row2037312514582"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p2373559582">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p1337325115811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p5373255585">Specifies the microversion. If the API version supports microversions, the maximum microversion supported is returned. If microversions are not supported, this field is left empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row113731055582"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p33732510580">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p1837319555813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p33733512581">Specifies the version status. The options are as follows:</p>
|
|
<ul id="en-us_topic_0133254023__ul849319591358"><li id="en-us_topic_0133254023__li19493135943515"><strong id="en-us_topic_0133254023__b842352706192132">CURRENT</strong>: indicates a primary version.</li><li id="en-us_topic_0133254023__li461820118368"><strong id="en-us_topic_0133254023__b842352706192150">SUPPORTED</strong>: indicates an old version that is still supported.</li><li id="en-us_topic_0133254023__li109053383613"><strong id="en-us_topic_0133254023__b13952181212273">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row1937395185810"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p1937325145816">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p237355195811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p1450025291916">Specifies the version release time, which is a UTC time. For example, the release time of v1.0 is 2016-12-09T00:00:00Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row437311575818"><td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254023__p103731511589">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254023__p133735518587">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254023__p23756516581">Specifies the microversion. If the API version supports microversions, the system returns the supported minimum microversion. If microversions are not supported, the system returns an empty value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254023__li173759555815"><strong id="en-us_topic_0133254023__b867447554">Link</strong> field data structure
|
|
<div class="tablenoborder"><a name="en-us_topic_0133254023__table9352054589"></a><a name="table9352054589"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254023__table9352054589" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Link field data structure</caption><thead align="left"><tr id="en-us_topic_0133254023__row1437517518589"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.3.3.2.2.4.1.1"><p id="en-us_topic_0133254023__p1237510575814">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.929999999999996%" id="mcps1.3.4.3.3.2.2.4.1.2"><p id="en-us_topic_0133254023__p13375105115816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.38%" id="mcps1.3.4.3.3.2.2.4.1.3"><p id="en-us_topic_0133254023__p163751516589">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254023__row93751159588"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="en-us_topic_0133254023__p53752575817">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="en-us_topic_0133254023__p8375155155820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.38%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="en-us_topic_0133254023__p183752512587">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254023__row337520515819"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="en-us_topic_0133254023__p11375851584">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.929999999999996%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="en-us_topic_0133254023__p537535155811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.38%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="en-us_topic_0133254023__p7375551589">self</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254023__li1037515175815">Example response<div class="p" id="en-us_topic_0133254023__p177441611718"><a name="en-us_topic_0133254023__li1037515175815"></a><a name="li1037515175815"></a><strong id="en-us_topic_0133254023__b2420104817190">Status code: 200</strong><pre class="screen" id="en-us_topic_0133254023__screen18499141515">{
|
|
"versions": [
|
|
{
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://<em id="en-us_topic_0133254023__i11146122814312">API URL</em>/v1.0"
|
|
}
|
|
],
|
|
"version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2016-12-09T00:00:00Z",
|
|
"min_version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254023__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133254023__p145228330242">For details, see <a href="en-us_topic_0171146972.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254023__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133254023__p177044331253">For details, see <a href="en-us_topic_0121230887.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0133321991.html">Querying Version Information</a></div>
|
|
</div>
|
|
</div>
|
|
|