forked from docs/doc-exports
Qin Ying, Fan
388d58fc5d
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>
153 lines
11 KiB
HTML
153 lines
11 KiB
HTML
<a name="nat_api_0026"></a><a name="nat_api_0026"></a>
|
|
|
|
<h1 class="topictitle1">Querying an API Version</h1>
|
|
<div id="body1539335120224"><div class="section" id="nat_api_0026__section66578044"><h4 class="sectiontitle">Function</h4><p id="nat_api_0026__p65561530">This API is used to query an API version of NAT Gateway.</p>
|
|
</div>
|
|
<div class="section" id="nat_api_0026__section42428029"><h4 class="sectiontitle">URI</h4><p id="nat_api_0026__p81941504156">GET/{api_version}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0026__table23820074175412" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0026__row17704405175412"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.3.2.4.1.1"><p id="nat_api_0026__p24770673175412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.2.4.1.2"><p id="nat_api_0026__p60267522175412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.2.3.2.4.1.3"><p id="nat_api_0026__p49831152175412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nat_api_0026__row9791522175412"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.2.4.1.1 "><p id="nat_api_0026__p54915841175412">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.2.4.1.2 "><p id="nat_api_0026__p18998132175412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.2.4.1.3 "><p id="nat_api_0026__p62453732175412">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nat_api_0026__section24112512"><h4 class="sectiontitle">Request</h4><p id="nat_api_0026__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="nat_api_0026__section15686020"><h4 class="sectiontitle">Response</h4><p id="nat_api_0026__p207001454131918"><a href="#nat_api_0026__table26246518152631">Table 2</a> lists response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="nat_api_0026__table26246518152631"></a><a name="table26246518152631"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0026__table26246518152631" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="nat_api_0026__row29602547152631"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.3.2.5.1.1"><p id="nat_api_0026__p1143665616354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.3.2.5.1.2"><p id="nat_api_0026__p543845610355">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.4.3.2.5.1.3"><p id="nat_api_0026__p11440156143517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.4.3.2.5.1.4"><p id="nat_api_0026__p244212561357">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nat_api_0026__row56174697152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p4445556153516">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p1044685612352">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p1165613153517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p344911569354">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row4615503152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p8452756123518">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p1045395620354">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p3312552203413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p045585620357">Specifies the version ID, for example, <strong id="nat_api_0026__b132119521229">v1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row9239644152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p9460175653518">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p44601856133514">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p1784101818342">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p746525619351">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row419672501413"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p16283354130">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p139117297139">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p13242332181317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p2269104581219">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row154810286148"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p2139956101218">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p1994102917139">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p824653211138">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p513917563125">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row12929787152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p13468556113518">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p164706561359">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p15130115893410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p11474856173511">Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If the minor versions are not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row39341340152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p647516561358">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p447812565352">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p143925911344">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p104811756113517">Specifies the version status. Possible values are as follows:</p>
|
|
<ul id="nat_api_0026__ul148328408213"><li id="nat_api_0026__li88322401622"><strong id="nat_api_0026__b779063413315">CURRENT</strong>: indicates that the version is the primary version.</li><li id="nat_api_0026__li168010425210"><strong id="nat_api_0026__b1977663518320">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="nat_api_0026__li12938204418217"><strong id="nat_api_0026__b447020371131">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row398200152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p7486145617358">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p1487135693517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p167918023512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p24932056163517">Specifies the version release time, which must be the UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0026__row61549520152631"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0026__p2495115693510">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0026__p14966566355">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0026__p134991256203512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0026__p205014565351">If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nat_api_0026__section33573539387"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0026__ul20112127112215"><li id="nat_api_0026__li141121127152212">Example response</li></ul>
|
|
<pre class="screen" id="nat_api_0026__screen19808142315710">{
|
|
"version": {
|
|
"id": "v2.0",
|
|
"links": [
|
|
{
|
|
"href": "https://x.x.x.x/v2.0/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2018-09-30T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="nat_api_0026__section11326181114390"><h4 class="sectiontitle">Status Codes</h4><p id="nat_api_0026__p1045957">See <a href="nat_api_0038.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="nat_api_0024.html">API Version</a></div>
|
|
</div>
|
|
</div>
|
|
|