vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpc/api-ref/vpc_version_0002.html
Qin Ying, Fan 310d2d9eb1 VPC API 20230106 version 
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>
2024-02-06 08:38:37 +00:00

157 lines
11 KiB
HTML
Raw Blame History

<a name="vpc_version_0002"></a><a name="vpc_version_0002"></a>
<h1 class="topictitle1">Querying a Specified API Version</h1>
<div id="body1539253748871"><div class="section" id="vpc_version_0002__section292172513710"><h4 class="sectiontitle">Function</h4><p id="vpc_version_0002__p852715264378">This API is used to query the version of a specified API.</p>
</div>
<div class="section" id="vpc_version_0002__section092618252375"><h4 class="sectiontitle">URI</h4><p id="vpc_version_0002__p76195219224">GET /{api_version}</p>
<p id="vpc_version_0002__p17789155311512"><a href="#vpc_version_0002__table8488410142319">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="vpc_version_0002__table8488410142319"></a><a name="table8488410142319"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0002__table8488410142319" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_version_0002__row9493141018236"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="vpc_version_0002__p94981610102320"><strong id="vpc_version_0002__b842352706193648">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.2"><p id="vpc_version_0002__p12502171018236"><strong id="vpc_version_0002__b842352706193653">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.3"><p id="vpc_version_0002__p0503161052316"><strong id="vpc_version_0002__b8423527061645">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_version_0002__row050661014235"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="vpc_version_0002__p5516910112316">api_version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="vpc_version_0002__p1851919102230">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="vpc_version_0002__p25212100235">Specifies the version number, for example <strong id="vpc_version_0002__b84235270685253">v2.0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_version_0002__section159431125133719"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_version_0002__p655442321511">None</p>
</div>
<div class="section" id="vpc_version_0002__section159572593915"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_version_0002__screen272554182417">GET https://{Endpoint}/v2.0</pre>
</div>
<div class="section" id="vpc_version_0002__section199536251373"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0002__table1595322519378" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_version_0002__row95291726133710"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_version_0002__p1252992613712"><strong id="vpc_version_0002__b375626383">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_version_0002__p55291826163717"><strong id="vpc_version_0002__b1915176706">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_version_0002__p1552913260373"><strong id="vpc_version_0002__b949646275">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_version_0002__row15529326203718"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_version_0002__p8529826133712">resources</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_version_0002__p13529152643712">Array of <a href="#vpc_version_0002__table1195920258372">resource</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_version_0002__p1852902653713">Specifies the <strong id="vpc_version_0002__b84235270685442">resource</strong> object list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_version_0002__table1195920258372"></a><a name="table1195920258372"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0002__table1195920258372" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_version_0002__b84235270685537">resource</strong> object</caption><thead align="left"><tr id="vpc_version_0002__row5529132615373"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_version_0002__p1252920262374"><strong id="vpc_version_0002__b942404585">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_version_0002__p2529126123714"><strong id="vpc_version_0002__b745724880">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_version_0002__p105291226143715"><strong id="vpc_version_0002__b780296855">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_version_0002__row1552919263377"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0002__p10529192611375">name</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0002__p352910264377">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_version_0002__p052918269376">Specifies the resource name.</p>
</td>
</tr>
<tr id="vpc_version_0002__row852942611373"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0002__p1152902613374">collection</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0002__p185293264370">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_version_0002__p8529192614377">Specifies the resource collection name.</p>
</td>
</tr>
<tr id="vpc_version_0002__row6529726133710"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0002__p25291326103715">links</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0002__p2658122615326">Array of <a href="#vpc_version_0002__table4442151110172">link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_version_0002__p1252922613371">Specifies the link list. For details, see <a href="#vpc_version_0002__table4442151110172">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="vpc_version_0002__table4442151110172"></a><a name="table4442151110172"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0002__table4442151110172" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_version_0002__b7788449151218">link</strong> objects</caption><thead align="left"><tr id="vpc_version_0002__row12442181131712"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_version_0002__p044251171713"><strong id="vpc_version_0002__b220024813381">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_version_0002__p4442411201715"><strong id="vpc_version_0002__b1588703320">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_version_0002__p124423117177"><strong id="vpc_version_0002__b9873125010388">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpc_version_0002__row1444331111711"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_version_0002__p164432011131719">href</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_version_0002__p444331114174">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_version_0002__p17443151171713">Specifies the API link.</p>
</td>
</tr>
<tr id="vpc_version_0002__row174431411161711"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_version_0002__p16443191131712">rel</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_version_0002__p2443111117171">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_version_0002__p1944331171712">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="vpc_version_0002__section102921743103911"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_version_0002__screen125631611141616">{
"resources": [
{
"links": [
{
"href": "https://vpc.systems.com/v2.0/subnets",
"rel": "self"
}
],
"name": "subnet",
"collection": "subnets"
},
{
"links": [
{
"href": "https://vpc.systems.com/v2.0/networks",
"rel": "self"
}
],
"name": "network",
"collection": "networks"
},
{
"links": [
{
"href": "https://vpc.systems.com/v2.0/ports",
"rel": "self"
}
],
"name": "port",
"collection": "ports"
}
]
}</pre>
</div>
<div class="section" id="vpc_version_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_version_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="vpc_version_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_version_0002__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_version_0000.html">API Version Information</a></div>
</div>
</div>
View Git Blame Copy Permalink