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>
165 lines
12 KiB
HTML
165 lines
12 KiB
HTML
<a name="vpcep_06_0101"></a><a name="vpcep_06_0101"></a>
|
|
|
|
<h1 class="topictitle1">Querying Versions of VPCEP APIs</h1>
|
|
<div id="body1556242041280"><div class="section" id="vpcep_06_0101__section911804819271"><a name="vpcep_06_0101__section911804819271"></a><a name="section911804819271"></a><h4 class="sectiontitle">Function</h4><p id="vpcep_06_0101__p8060118">This API is used to query versions of VPCEP APIs.</p>
|
|
<div class="note" id="vpcep_06_0101__note136501740101710"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="vpcep_06_0101__p7651640111719">v2 cannot be used.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0101__section8252172943111"><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0101__p18516022121414">GET /</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0101__section4451152618322"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0101__ul205244381213"><li id="vpcep_06_0101__li1658864520126">Example request<p id="vpcep_06_0101__p1678014717125"><a name="vpcep_06_0101__li1658864520126"></a><a name="li1658864520126"></a>GET https://{endpoint}/</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0101__section17102195273319"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0101__ul17322125818333"><li id="vpcep_06_0101__li1532255815338">Parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0101__table173673267343" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0101__row6419026173412"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0101__p6419426123416"><strong id="vpcep_06_0101__b79351534181412">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0101__p841911268345"><strong id="vpcep_06_0101__b391323541416">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.51%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0101__p1241982643410"><strong id="vpcep_06_0101__b18898113610143">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0101__row1841962613418"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0101__p184199268345">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0101__p4419426193412">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0101__p1941992619345">Lists the versions of VPCEP APIs. For details, see <a href="#vpcep_06_0101__table13687304356">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0101__table13687304356"></a><a name="table13687304356"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0101__table13687304356" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpcep_06_0101__b270119413142">VersionModel</strong> parameters</caption><thead align="left"><tr id="vpcep_06_0101__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_0101__p12148163012355"><strong id="vpcep_06_0101__b5941859181415">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_0101__p21481930173516"><strong id="vpcep_06_0101__b14023511169">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_0101__p191487308357"><strong id="vpcep_06_0101__b199114616165">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0101__row13148730103514"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p15148130173519">Specifies the version status.</p>
|
|
<ul id="vpcep_06_0101__ul12195132314920"><li id="vpcep_06_0101__li1619512316493"><strong id="vpcep_06_0101__b345764344013">CURRENT</strong>: indicates a major version.</li><li id="vpcep_06_0101__li41951123144914"><strong id="vpcep_06_0101__b842352706115419">SUPPORT</strong>: indicates an earlier version which is still supported.</li><li id="vpcep_06_0101__li219562324917"><strong id="vpcep_06_0101__b11835470403">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row2148153033517"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p214943013351">Specifies the version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row61491030163510"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p4149830103515">Specifies the time when the API version was released.</p>
|
|
<p id="vpcep_06_0101__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row17149930163514"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p214923015359">Specifies the supported version. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row138921150194"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p378134613518">Specifies the microversion number. If the APIs do not support microversions, the value is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row101495301354"><td class="cellrowborder" valign="top" width="18.62%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p6149113014357">Specifies the API URL. For details, see <a href="#vpcep_06_0101__table2072420713363">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0101__table2072420713363"></a><a name="table2072420713363"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0101__table2072420713363" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpcep_06_0101__b13910181681813">VersionLink</strong> parameters</caption><thead align="left"><tr id="vpcep_06_0101__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_0101__p6795975366"><strong id="vpcep_06_0101__b282411211183">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_0101__p9795127193619"><strong id="vpcep_06_0101__b73128148187">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_0101__p147955719369"><strong id="vpcep_06_0101__b1448217851810">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0101__row187958715368"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p779520783617">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row879514763612"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__p5712332143113">Specifies the MIME type of the entity sending the request. The value is <strong id="vpcep_06_0101__b1842810364613">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0101__row079519743614"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0101__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_0101__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_0101__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_0101__ul812835713617"><li id="vpcep_06_0101__li91288579361"><a name="vpcep_06_0101__li91288579361"></a><a name="li91288579361"></a>Example response<pre class="screen" id="vpcep_06_0101__screen19482419594">{
|
|
"versions": [
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v1",
|
|
"updated": "2018-09-30T00:00:00Z",
|
|
"version": "1",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://{vpcep_uri}/v1",
|
|
"type": "application/json"
|
|
}
|
|
],
|
|
"min_version": ""
|
|
},
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v2",
|
|
"updated": "2020-03-30T00:00:00Z",
|
|
"version": "2",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://{vpcep_uri}/v2",
|
|
"type": "application/json"
|
|
}
|
|
],
|
|
"min_version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0101__section88561438153717"><h4 class="sectiontitle">Status Codes</h4><p id="vpcep_06_0101__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>
|
|
|