forked from docs/doc-exports
Wang , Deng Ke
4828616622
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
165 lines
11 KiB
HTML
165 lines
11 KiB
HTML
<a name="ShowApiVersion"></a><a name="ShowApiVersion"></a>
|
|
|
|
<h1 class="topictitle1">Querying Version Information of an API</h1>
|
|
<div id="body1747122215584"><div class="section" id="ShowApiVersion__section114752235810"><h4 class="sectiontitle">Function</h4><p id="ShowApiVersion__p6486229586">This API is used to query version information of a specified API.</p>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section104919224581"><h4 class="sectiontitle">URI</h4><p id="ShowApiVersion__p050112235813">GET https://{Endpoint}/{versionId}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowApiVersion__table1252152211588" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ShowApiVersion__row85172245816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowApiVersion__p75317225589">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowApiVersion__p18537223589">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowApiVersion__p1548223581">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowApiVersion__p15412215584">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowApiVersion__row45172285812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowApiVersion__p255182255817">versionId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowApiVersion__p1756192275811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowApiVersion__p25716225585">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowApiVersion__p3581922205813">API version</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section55922214583"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowApiVersion__p1459822135812">None</p>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section1760022155814"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowApiVersion__p7617229583"><strong id="ShowApiVersion__b1262034612394">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowApiVersion__response_ShowApiVersionResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowApiVersion__row261322155818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowApiVersion__p1163132210585">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowApiVersion__p863172265814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowApiVersion__p146482245819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowApiVersion__row17627225580"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowApiVersion__p1965422135810">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowApiVersion__p26511226580"><a href="#ShowApiVersion__response_ApiVersionResponse">ApiVersionResponse</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowApiVersion__p066102285817">API version information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowApiVersion__response_ApiVersionResponse"></a><a name="response_ApiVersionResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowApiVersion__response_ApiVersionResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ApiVersionResponse</caption><thead align="left"><tr id="ShowApiVersion__row56772215586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowApiVersion__p2691122135814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowApiVersion__p1070142265818">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowApiVersion__p197012235816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowApiVersion__row1967142235818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p1772222145813">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p873722195819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p1073322165815">API version number</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row867522145818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p3744224588">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p13751922135812">Array of <a href="#ShowApiVersion__response_Links">Links</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p77562285812">API link information</p>
|
|
<div class="note" id="ShowApiVersion__note1677112225811"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ShowApiVersion__p277112211583">If the version is v3, the value is <strong id="ShowApiVersion__b9952154734018">[]</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row156792216586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p8783225586">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p9791822185820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p47992210584">Version status</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row16882245811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p1680142213580">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p1981192265813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p128112224581">Subversion information of the API version</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row106802211585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p782162245815">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p1383132215816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p983192265816">Minimum API version number</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row14681222115817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowApiVersion__p1784152265818">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowApiVersion__p1185102218586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowApiVersion__p1685192265815">Version update time</p>
|
|
<p id="ShowApiVersion__p986172217585">The format is yyyy-mm-dd Thh:mm:ssZ.</p>
|
|
<p id="ShowApiVersion__p78752225811"><strong id="ShowApiVersion__b946611116419">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="ShowApiVersion__b1446641115414">Z</strong> indicates the UTC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowApiVersion__response_Links"></a><a name="response_Links"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowApiVersion__response_Links" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Links</caption><thead align="left"><tr id="ShowApiVersion__row488192215817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowApiVersion__p190222125814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowApiVersion__p990222125819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowApiVersion__p7911322115817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowApiVersion__row1088152213588"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowApiVersion__p1291422155812">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowApiVersion__p20921422185815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowApiVersion__p14931122135817">API URL. The value is <strong id="ShowApiVersion__b192601024124113">""</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowApiVersion__row12881226585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowApiVersion__p189412211589">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowApiVersion__p29592205814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowApiVersion__p1295322155811">The value is <strong id="ShowApiVersion__b185228154117">self</strong>, indicating that URL is a local link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section696142211584"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="ShowApiVersion__p111501658152111">URI example<pre class="screen" id="ShowApiVersion__screen95044915155">GET https://{Endpoint}/v3</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section6100112245818"><h4 class="sectiontitle">Example Response</h4><p id="ShowApiVersion__p141001422195810"><strong id="ShowApiVersion__b13646174119410">Status code: 200</strong></p>
|
|
<p id="ShowApiVersion__p1710122210583">Success</p>
|
|
<pre class="screen" id="ShowApiVersion__screen8102152220580">{
|
|
"version" : {
|
|
"id" : "v3",
|
|
"links" : [ ],
|
|
"status" : "CURRENT",
|
|
"version" : "",
|
|
"min_version" : "",
|
|
"updated" : "2019-10-30T17:34:02Z"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowApiVersion__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="ShowApiVersion__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowApiVersion__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">API Versions</a></div>
|
|
</div>
|
|
</div>
|
|
|