forked from docs/doc-exports
Qin Ying, Fan
ef5d2cd3cf
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
173 lines
13 KiB
HTML
173 lines
13 KiB
HTML
<a name="vpcep_06_0102"></a><a name="vpcep_06_0102"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Version of a Specified VPCEP API</h1>
|
|
<div id="body1568879804715"><div class="section" id="vpcep_06_0102__section911804819271"><h4 class="sectiontitle">Function</h4><p id="vpcep_06_0102__p8060118">This API is used to query the version of a specified VPCEP API.</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0102__section8252172943111"><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0102__p18516022121414">GET /{version}</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0102__section4451152618322"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0102__ul131341748183210"><li id="vpcep_06_0102__li1913454803211">Parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0102__table5505175211710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter</caption><thead align="left"><tr id="vpcep_06_0102__row1665510521073"><th align="left" class="cellrowborder" valign="top" width="27.347265273472654%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0102__p196553528716"><strong id="vpcep_06_0102__b33951224160">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.328267173282672%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0102__p565513525720"><strong id="vpcep_06_0102__b1267132351613">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.547345265473453%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0102__p1565535214710"><strong id="vpcep_06_0102__b10886524131615">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.777122287771224%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0102__p14655165220712"><strong id="vpcep_06_0102__b414362671614">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0102__row765515219718"><td class="cellrowborder" valign="top" width="27.347265273472654%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0102__p33593591418">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0102__p8359259143">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.547345265473453%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0102__p0655115210718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.777122287771224%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0102__p202009491205">Specifies the version to be queried. The value starts with v, for example, v1.</p>
|
|
<p id="vpcep_06_0102__p7382592141">If this parameter is left blank, versions of all APIs are queried.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="vpcep_06_0102__li838073204815">Example request<p id="vpcep_06_0102__p1146617136380"><a name="vpcep_06_0102__li838073204815"></a><a name="li838073204815"></a>GET https://{endpoint}/v1</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0102__section17102195273319"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0102__ul17322125818333"><li id="vpcep_06_0102__li1532255815338">Parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0102__table173673267343" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpcep_06_0102__row6419026173412"><th align="left" class="cellrowborder" valign="top" width="18.57%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0102__p6419426123416"><strong id="vpcep_06_0102__b7357165321617">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.939999999999998%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0102__p841911268345"><strong id="vpcep_06_0102__b441915411167">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.49%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0102__p1241982643410"><strong id="vpcep_06_0102__b328911551164">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0102__row1841962613418"><td class="cellrowborder" valign="top" width="18.57%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0102__p184199268345">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.939999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0102__p4419426193412">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.49%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0102__p1941992619345">Lists the versions of VPCEP APIs. For details, see <a href="#vpcep_06_0102__table13687304356">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0102__table13687304356"></a><a name="table13687304356"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0102__table13687304356" frame="border" border="1" rules="all"><caption><b>Table 3 </b>VersionModel parameters</caption><thead align="left"><tr id="vpcep_06_0102__row1148330133514"><th align="left" class="cellrowborder" valign="top" width="18.62%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0102__p12148163012355"><strong id="vpcep_06_0102__b13156911151719">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.12%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0102__p21481930173516"><strong id="vpcep_06_0102__b17171171271719">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.26%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0102__p191487308357"><strong id="vpcep_06_0102__b5839111381714">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0102__row13148730103514"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p414873012353">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p19148133018351">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p15148130173519">Specifies the version status.</p>
|
|
<ul id="vpcep_06_0102__ul12195132314920"><li id="vpcep_06_0102__li1619512316493"><strong id="vpcep_06_0102__b15854171891711">CURRENT</strong>: indicates a major version.</li><li id="vpcep_06_0102__li41951123144914"><strong id="vpcep_06_0102__b17262721151713">SUPPORT</strong>: indicates an earlier version which is still supported.</li><li id="vpcep_06_0102__li219562324917"><strong id="vpcep_06_0102__b88408249179">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row2148153033517"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p814815307351">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p181488307350">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p214943013351">Specifies the version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row61491030163510"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p0149143014358">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p121491630183517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p4149830103515">Specifies the time when the API version was released.</p>
|
|
<p id="vpcep_06_0102__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row17149930163514"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p514933013358">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p914923015352">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p214923015359">Specifies the supported version. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row138921150194"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p837715239193">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p193771823181917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p378134613518">Specifies the microversion number. If the APIs do not support microversions, the value is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row101495301354"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0102__p18149173013518">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.12%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0102__p171493308352">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.26%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0102__p6149113014357">Specifies the API URL. For details, see <a href="#vpcep_06_0102__table2072420713363">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0102__table2072420713363"></a><a name="table2072420713363"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0102__table2072420713363" frame="border" border="1" rules="all"><caption><b>Table 4 </b>VersionLink parameters</caption><thead align="left"><tr id="vpcep_06_0102__row1879514712367"><th align="left" class="cellrowborder" valign="top" width="18.67%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpcep_06_0102__p6795975366"><strong id="vpcep_06_0102__b2464165541711">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.04%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpcep_06_0102__p9795127193619"><strong id="vpcep_06_0102__b18795145614170">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.290000000000006%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpcep_06_0102__p147955719369"><strong id="vpcep_06_0102__b146291157141716">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0102__row187958715368"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0102__p197951713612">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.04%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0102__p197951874369">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0102__p779520783617">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row879514763612"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0102__p107951710363">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.04%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0102__p10795472366">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0102__p5712332143113">Specifies the MIME type of the entity sending the request. The value is <strong id="vpcep_06_0102__b977375111820">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0102__row079519743614"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0102__p117951723611">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.04%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0102__p979557123615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.290000000000006%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0102__p1179513753617">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0102__ul812835713617"><li id="vpcep_06_0102__li91288579361">Example response<pre class="screen" id="vpcep_06_0102__screen515010172010">{
|
|
"version":{
|
|
{
|
|
"updated":"2018-09-30T00:00:00Z",
|
|
"version":"1",
|
|
"min_version":"",
|
|
"status":"CURRENT",
|
|
"id":"v1",
|
|
"links":[
|
|
{
|
|
"href":"https://{vpcep_uri}/v1",
|
|
"type":"application/json",
|
|
"rel":"self"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0102__section88561438153717"><h4 class="sectiontitle">Status Codes</h4><p id="vpcep_06_0102__p1230124317376">See <a href="vpcep_08_0001.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0100.html">Version Management</a></div>
|
|
</div>
|
|
</div>
|
|
|