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>
125 lines
8.4 KiB
HTML
125 lines
8.4 KiB
HTML
<a name="nat_api_0020"></a><a name="nat_api_0020"></a>
|
||
|
||
<h1 class="topictitle1">Querying NAT Gateway Tags</h1>
|
||
<div id="body1527752489237"><div class="section" id="nat_api_0020__section2023119943610"><h4 class="sectiontitle">Function</h4><p id="nat_api_0020__p14486914369">This API is used to query tags of a specified NAT gateway.</p>
|
||
<p id="nat_api_0020__p14448159103611">TMS uses this API to query all tags of a specified NAT gateway.</p>
|
||
</div>
|
||
<div class="section" id="nat_api_0020__section142327912366"><h4 class="sectiontitle">URI</h4><p id="nat_api_0020__p118593231012">GET /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0020__table72439973610" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0020__row544969183612"><th align="left" class="cellrowborder" valign="top" width="23.282328232823282%" id="mcps1.3.2.3.2.5.1.1"><p id="nat_api_0020__p624815530312">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="24.76247624762476%" id="mcps1.3.2.3.2.5.1.2"><p id="nat_api_0020__p1936450184812">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21.88218821882188%" id="mcps1.3.2.3.2.5.1.3"><p id="nat_api_0020__p15018439484">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="30.073007300730076%" id="mcps1.3.2.3.2.5.1.4"><p id="nat_api_0020__p1124817538319">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0020__row54490903611"><td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.2.3.2.5.1.1 "><p id="nat_api_0020__p144929163616">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.76247624762476%" headers="mcps1.3.2.3.2.5.1.2 "><p id="nat_api_0020__p448202825014">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.2.3.2.5.1.3 "><p id="nat_api_0020__p25911524155011">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="30.073007300730076%" headers="mcps1.3.2.3.2.5.1.4 "><p id="nat_api_0020__p644915973619">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0020__row7449139193610"><td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.2.3.2.5.1.1 "><p id="nat_api_0020__p154491963617">nat_gateway_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.76247624762476%" headers="mcps1.3.2.3.2.5.1.2 "><p id="nat_api_0020__p169853312509">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.2.3.2.5.1.3 "><p id="nat_api_0020__p1591112425017">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="30.073007300730076%" headers="mcps1.3.2.3.2.5.1.4 "><p id="nat_api_0020__p54499914369">Specifies the NAT gateway ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="nat_api_0020__section1826312973618"><h4 class="sectiontitle">Request</h4><p id="nat_api_0020__p944915913367">None</p>
|
||
</div>
|
||
<div class="section" id="nat_api_0020__section15264159173610"><h4 class="sectiontitle">Response</h4><p id="nat_api_0020__p5211011399"><a href="#nat_api_0020__table22681993615">Table 2</a> lists response parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="nat_api_0020__table22681993615"></a><a name="table22681993615"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0020__table22681993615" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="nat_api_0020__row44506963616"><th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.4.3.2.5.1.1"><p id="nat_api_0020__p12241926122610">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="24.560000000000002%" id="mcps1.3.4.3.2.5.1.2"><p id="nat_api_0020__p224162613265">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20.02%" id="mcps1.3.4.3.2.5.1.3"><p id="nat_api_0020__p13241162622617">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="32.05%" id="mcps1.3.4.3.2.5.1.4"><p id="nat_api_0020__p224111267268">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0020__row845069103619"><td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nat_api_0020__p104501398361">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.560000000000002%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nat_api_0020__p1981364235017">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nat_api_0020__p1280916372509">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="32.05%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nat_api_0020__p144511994368">Specifies tags.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0020__table16280179113613" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="nat_api_0020__b83671749845">tags</strong></caption><thead align="left"><tr id="nat_api_0020__row54515915367"><th align="left" class="cellrowborder" valign="top" width="23.799999999999997%" id="mcps1.3.4.4.2.5.1.1"><p id="nat_api_0020__p115692813267">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="24.22%" id="mcps1.3.4.4.2.5.1.2"><p id="nat_api_0020__p12561288263">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.4.2.5.1.3"><p id="nat_api_0020__p20566283265">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="32.28%" id="mcps1.3.4.4.2.5.1.4"><p id="nat_api_0020__p1856132817269">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0020__row4452209183620"><td class="cellrowborder" valign="top" width="23.799999999999997%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nat_api_0020__p54521963619">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.22%" headers="mcps1.3.4.4.2.5.1.2 "><p id="nat_api_0020__p368162125118">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nat_api_0020__p135701458195011">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="32.28%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nat_api_0020__p245269163615">Specifies the tag key. It contains a maximum of 36 Unicode characters. It cannot be left empty or contain ASCII characters (0-31) and the following special characters: *<>\=</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0020__row11452119173610"><td class="cellrowborder" valign="top" width="23.799999999999997%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nat_api_0020__p11452189113610">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.22%" headers="mcps1.3.4.4.2.5.1.2 "><p id="nat_api_0020__p1645314933618">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nat_api_0020__p17570155845017">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="32.28%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nat_api_0020__p1945312923615">Specifies the key value. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain non-printable ASCII characters (0–31) or the following special characters: *<>\=</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="nat_api_0020__section173021295361"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0020__ul18292111124118"><li id="nat_api_0020__li8292171115415">Example request<pre class="screen" id="nat_api_0020__screen9453109133612">GET https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags</pre>
|
||
</li></ul>
|
||
</div>
|
||
<ul id="nat_api_0020__ul636443720414"><li id="nat_api_0020__li53644378411">Example response<pre class="screen" id="nat_api_0020__screen9453149123615">{
|
||
"tags": [
|
||
{
|
||
"key": "key1",
|
||
"value": "value1"
|
||
},
|
||
{
|
||
"key": "key2",
|
||
"value": "value2"
|
||
}
|
||
]
|
||
}</pre>
|
||
</li></ul>
|
||
<div class="section" id="nat_api_0020__section1732699183618"><h4 class="sectiontitle">Status Code</h4><p id="nat_api_0020__p1145411923610">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_0015.html">Tags</a></div>
|
||
</div>
|
||
</div>
|
||
|