forked from docs/doc-exports
weihongmin1
89457a7fa8
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>
190 lines
16 KiB
HTML
190 lines
16 KiB
HTML
<a name="en-us_topic_0133254024"></a><a name="en-us_topic_0133254024"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an API Version</h1>
|
|
<div id="body1538020653458"><div class="section" id="en-us_topic_0133254024__section1384084212213"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0133254024__p73262431022">This API is used to query details about an API version.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254024__section884219422212"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0133254024__p1032810434213">GET /{api_version}</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254024__section1687594219210"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0133254024__ul43290431327"><li id="en-us_topic_0133254024__li1672516395215">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254024__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="en-us_topic_0133254024__row1214833561117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0133254024__p1149835101117">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0133254024__p0149193512114">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0133254024__p515015352112">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0133254024__p115023513118">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254024__row1614817354115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0133254024__p121501235171110">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0133254024__p1515193519112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0133254024__p13151143513113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0133254024__p101511635141111">Specifies the user token. EPS is a global service. When calling the IAM API to obtain a user token, set <strong id="en-us_topic_0133254024__b1777441417267">scope</strong> to <strong id="en-us_topic_0133254024__b07751414162615">domain</strong>. The value of <strong id="en-us_topic_0133254024__b117111922172616">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254024__table358514682113" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request</caption><thead align="left"><tr id="en-us_topic_0133254024__row463404692110"><th align="left" class="cellrowborder" valign="top" width="22.517748225177485%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0133254024__p136341646172115">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.788021197880212%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0133254024__p4634246162114">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.637336266373367%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0133254024__p663419461215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.056894310568943%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0133254024__p763414615219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254024__row663464622116"><td class="cellrowborder" valign="top" width="22.517748225177485%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0133254024__p963464611219">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.788021197880212%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0133254024__p10634346182115">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.637336266373367%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0133254024__p663419469218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.056894310568943%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0133254024__p663474616213">Specifies the version ID, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254024__li232920431216">Example request<pre class="codeblock" id="en-us_topic_0133254024__codeblock91739102155"><strong id="en-us_topic_0133254024__b3838217154413">GET https://{</strong><em id="en-us_topic_0133254024__i283816171443">EPS endpoint</em><strong id="en-us_topic_0133254024__b12839317144418">}/v1.0</strong></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254024__section1288084215219"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0133254024__p165182016166"><strong id="en-us_topic_0133254024__b12543105251917">Status code: 200</strong></p>
|
|
<ul id="en-us_topic_0133254024__ul6329134319214"><li id="en-us_topic_0133254024__li732915431123">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254024__table89083428216" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0133254024__row9329243426"><th align="left" class="cellrowborder" valign="top" width="26.51%" id="mcps1.3.4.3.1.1.2.4.1.1"><p id="en-us_topic_0133254024__p1232904313216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.58%" id="mcps1.3.4.3.1.1.2.4.1.2"><p id="en-us_topic_0133254024__p53292431329">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.91%" id="mcps1.3.4.3.1.1.2.4.1.3"><p id="en-us_topic_0133254024__p13329543728">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254024__row132944316213"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="en-us_topic_0133254024__p832934310213">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.58%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="en-us_topic_0133254024__p5656959181">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.91%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="en-us_topic_0133254024__p153292438219">Specifies the version details.</p>
|
|
<p id="en-us_topic_0133254024__p14598204063110">For details, see <a href="#en-us_topic_0133254024__table1928194220218">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254024__li153293432023"><strong id="en-us_topic_0133254024__b6699296094725_1">version</strong> field data structure
|
|
<div class="tablenoborder"><a name="en-us_topic_0133254024__table1928194220218"></a><a name="table1928194220218"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254024__table1928194220218" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="en-us_topic_0133254024__b16103518133015">version</strong> field data structure description</caption><thead align="left"><tr id="en-us_topic_0133254024__row232915431123"><th align="left" class="cellrowborder" valign="top" width="22.092209220922093%" id="mcps1.3.4.3.2.2.2.4.1.1"><p id="en-us_topic_0133254024__p8329154313212">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.092209220922093%" id="mcps1.3.4.3.2.2.2.4.1.2"><p id="en-us_topic_0133254024__p163291443225">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.81558155815583%" id="mcps1.3.4.3.2.2.2.4.1.3"><p id="en-us_topic_0133254024__p16329743925">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254024__row3329443228"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p8329543822">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p153290431212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p332920434215">Specifies the version ID, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254024__row1732912431325"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p143297431211">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p1432954316216">List<Link></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p10329104316217">Specifies the API URL.</p>
|
|
<p id="en-us_topic_0133254024__p93217593215">For details, see <a href="#en-us_topic_0133254024__table69851542624">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254024__row1132916431127"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p43297436218">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p9329144316214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p832912430218">Specifies the microversion. If APIs of a version support 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_0133254024__row6329154320216"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p153294432210">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p83291743126">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p153294434219">Specifies the version status. The options are as follows:</p>
|
|
<ul id="en-us_topic_0133254024__ul3995102174417"><li id="en-us_topic_0133254024__li699417215445"><strong id="en-us_topic_0133254024__b842352706192132">CURRENT</strong>: indicates a primary version.</li><li id="en-us_topic_0133254024__li1185032464412"><strong id="en-us_topic_0133254024__b842352706192150">SUPPORTED</strong>: indicates an old version that is still supported.</li><li id="en-us_topic_0133254024__li278422619442"><strong id="en-us_topic_0133254024__b84235270619220">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254024__row1132911431220"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p832964316217">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p173298431527">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p13558810103316">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_0133254024__row10330743325"><td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="en-us_topic_0133254024__p933094311220">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.092209220922093%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="en-us_topic_0133254024__p633014431124">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81558155815583%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="en-us_topic_0133254024__p333010435213">Specifies the microversion. If APIs of a version support microversions, the minimum microversion supported is returned. If microversions are not supported, this field is left empty.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133254024__li1333018431724"><strong id="en-us_topic_0133254024__b6699296094725_3">Link</strong> field data structure
|
|
<div class="tablenoborder"><a name="en-us_topic_0133254024__table69851542624"></a><a name="table69851542624"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133254024__table69851542624" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Link field data structure</caption><thead align="left"><tr id="en-us_topic_0133254024__row63305433218"><th align="left" class="cellrowborder" valign="top" width="27.71%" id="mcps1.3.4.3.3.2.2.4.1.1"><p id="en-us_topic_0133254024__p1733019431216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.12%" id="mcps1.3.4.3.3.2.2.4.1.2"><p id="en-us_topic_0133254024__p1433011439216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.17%" id="mcps1.3.4.3.3.2.2.4.1.3"><p id="en-us_topic_0133254024__p3330643328">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133254024__row933044317214"><td class="cellrowborder" valign="top" width="27.71%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="en-us_topic_0133254024__p833010436213">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="en-us_topic_0133254024__p103304431729">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.17%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="en-us_topic_0133254024__p433011431122">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133254024__row1933014434215"><td class="cellrowborder" valign="top" width="27.71%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="en-us_topic_0133254024__p6330643921">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="en-us_topic_0133254024__p1333014434212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.17%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="en-us_topic_0133254024__p533211431222">self</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0133254024__ul13324431210"><li id="en-us_topic_0133254024__li1933216431824">Example response<div class="p" id="en-us_topic_0133254024__p6142194391714"><a name="en-us_topic_0133254024__li1933216431824"></a><a name="li1933216431824"></a><strong id="en-us_topic_0133254024__b12779125319195">Status code: 200</strong><pre class="screen" id="en-us_topic_0133254024__screen5183194519315">{
|
|
"version": {
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://<em id="en-us_topic_0133254024__i18722943164420">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_0133254024__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133254024__p145228330242">For details, see <a href="en-us_topic_0171146972.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133254024__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133254024__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>
|
|
|