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>
210 lines
16 KiB
HTML
210 lines
16 KiB
HTML
<a name="nat_api_0062"></a><a name="nat_api_0062"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details of a NAT Gateway</h1>
|
|
<div id="body36094934"><div class="section" id="nat_api_0062__section45827181"><h4 class="sectiontitle">Function</h4><p id="nat_api_0062__p38008531">This API is used to query details of a NAT gateway.</p>
|
|
</div>
|
|
<div class="section" id="nat_api_0062__section9791447"><h4 class="sectiontitle">URI</h4><p id="nat_api_0062__p1325124319111">GET /v2.0/nat_gateways/{nat_gateway_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0062__table285161395713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0062__row12912101317577"><th align="left" class="cellrowborder" valign="top" width="22.57%" id="mcps1.3.2.3.2.5.1.1"><p id="nat_api_0062__p791271313579">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="8.649999999999999%" id="mcps1.3.2.3.2.5.1.2"><p id="nat_api_0062__p1391221355716">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.9%" id="mcps1.3.2.3.2.5.1.3"><p id="nat_api_0062__p7912013105718">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.879999999999995%" id="mcps1.3.2.3.2.5.1.4"><p id="nat_api_0062__p1191216131572">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nat_api_0062__row1591281345717"><td class="cellrowborder" valign="top" width="22.57%" headers="mcps1.3.2.3.2.5.1.1 "><p id="nat_api_0062__p69121213115717">nat_gateway_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="8.649999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="nat_api_0062__p1291281325710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.9%" headers="mcps1.3.2.3.2.5.1.3 "><p id="nat_api_0062__p179129138573">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.879999999999995%" headers="mcps1.3.2.3.2.5.1.4 "><p id="nat_api_0062__p20912111395719">Specifies the NAT gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nat_api_0062__section54909781"><h4 class="sectiontitle">Request</h4><p id="nat_api_0062__p32402836">None</p>
|
|
</div>
|
|
<div class="section" id="nat_api_0062__section24425986"><h4 class="sectiontitle">Response</h4><p id="nat_api_0062__p1778921591312"><a href="#nat_api_0062__table129831149144215">Table 2</a> lists response parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="nat_api_0062__table129831149144215"></a><a name="table129831149144215"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0062__table129831149144215" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="nat_api_0062__row2233175015424"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.4.3.2.4.1.1"><p id="nat_api_0062__p112331950124213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.28%" id="mcps1.3.4.3.2.4.1.2"><p id="nat_api_0062__p1023335020429">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.4.3.2.4.1.3"><p id="nat_api_0062__p1123319502426">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nat_api_0062__row1223325010421"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nat_api_0062__p202331450134211">nat_gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nat_api_0062__p12331150184217">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nat_api_0062__p62331505427">Specifies the NAT gateway object. For details, see <a href="#nat_api_0062__table514165011429">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="nat_api_0062__table514165011429"></a><a name="table514165011429"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0062__table514165011429" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="nat_api_0062__b141502017142217">nat_gateway</strong> field</caption><thead align="left"><tr id="nat_api_0062__row1233175044210"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.4.2.4.1.1"><p id="nat_api_0062__p16233350194217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.4.2.4.1.2"><p id="nat_api_0062__p1123375010428">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.4.4.2.4.1.3"><p id="nat_api_0062__p2023313507424">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nat_api_0062__row623313504427"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p162338502421">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p92331950144219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p5233165034219">Specifies the NAT gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row72331550164211"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p1123335024220">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p8233450174216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p172332504428">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row17233185084220"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p323355014426">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p323355044218">String(64)</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p42331650144212">Specifies the NAT gateway name.</p>
|
|
<p id="nat_api_0062__p72333505429">The name can contain only digits, letters, underscores (_), and hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1623315018422"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p19233145020424">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p423318503426">String(255)</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p923335014212">Provides supplementary information about the NAT gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1623315506427"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p18233350184218">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p15233105018428">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p1023385084218">Specifies the NAT gateway specifications.</p>
|
|
<p id="nat_api_0062__p1223319508422">The value can be:</p>
|
|
<ul id="nat_api_0062__ul191213405211"><li id="nat_api_0062__li191264175216"><strong id="nat_api_0062__b17762182510512">0</strong>: micro type, which supports up to 1,000 SNAT connections.</li></ul>
|
|
<ul id="nat_api_0062__ul132334508424"><li id="nat_api_0062__li7233105010422"><strong id="nat_api_0062__b558515263517">1</strong>: small type, which supports up to 10,000 SNAT connections.</li><li id="nat_api_0062__li523319506424"><strong id="nat_api_0062__b415211717227">2</strong>: medium type, which supports up to 50,000 SNAT connections.</li><li id="nat_api_0062__li4233205094211"><strong id="nat_api_0062__b121523172224">3</strong>: large type, which supports up to 200,000 SNAT connections.</li><li id="nat_api_0062__li10233185011425"><strong id="nat_api_0062__b915231718225">4</strong>: extra-large type, which supports up to 1,000,000 SNAT connections.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row42331050144212"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p1723325015428">router_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p3233115094213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p102331150144211">Specifies the router ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row72331650164215"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p8233195017429">internal_network_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p223314508421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p4233125084214">Specifies the network ID of the downstream interface (the next hop of the DVR) of the NAT gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row102339502423"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p82331150114212">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p1823311508429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0062__ul9233155034214"><li id="nat_api_0062__li123311501426">Specifies the NAT gateway status.</li><li id="nat_api_0062__li823315013427">For details about all its values, see <a href="nat_api_0042.html#nat_api_0042__table1390614366107">Table 1</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row20233450104210"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p32333502427">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p1764614265487">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0062__ul71858556358"><li id="nat_api_0062__li132051838164415">Specifies whether the NAT gateway is up or down.</li><li id="nat_api_0062__li12205203804411">The value can be:<ul id="nat_api_0062__ul16205638124410"><li id="nat_api_0062__li16206163884415"><strong id="nat_api_0062__b951617194433">true</strong>: The NAT gateway is up.</li><li id="nat_api_0062__li102063382449"><strong id="nat_api_0062__b44261220114312">false</strong>: The NAT gateway is down.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row22331050154211"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p723305014427">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p423312509427">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p16351227165916">Specifies when the NAT gateway was created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1262419245917"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p262417249915">billinginfo</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p76242024791">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p562482411913">Specifies the order information. This parameter is left blank by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1677818271491"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p1377813271912">freeze_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p27788271797">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p57781327191">Specifies information about the frozen NAT gateway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1814112351094"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p1114114353914">sys_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p15141133514918">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p12141133514918">Specifies the ID of the enterprise project associated with the NAT gateway when the NAT gateway is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row1724416481121"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p13244948191214">snat_rule_public_ip_limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p2245848101211">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p8245648191219">Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is <strong id="nat_api_0062__b833911387191">20</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nat_api_0062__row13697381191"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0062__p1769163814911">dnat_rules_limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0062__p19691238699">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0062__p5699381990">Specifies the maximum number of DNAT rules on a NAT gateway. The default value is <strong id="nat_api_0062__b15920748191920">200</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nat_api_0062__section18507287"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0062__ul641713519145"><li id="nat_api_0062__li641753515142">Example request<pre class="screen" id="nat_api_0062__screen35111148102342">GET https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-1654-4710-8742-3fc49d5f04f8</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="nat_api_0062__ul11436721510"><li id="nat_api_0062__li24310715158">Example response<pre class="screen" id="nat_api_0062__screen20430758102359">{
|
|
"nat_gateway": {
|
|
"router_id": "d84f345c-80a1-4fa2-a39c-d0d397c3f09a",
|
|
"status": "ACTIVE",
|
|
"description": "my nat gateway 01",
|
|
"admin_state_up": true,
|
|
"tenant_id": "27e25061336f4af590faeabeb7fcd9a3",
|
|
"created_at": "2017-11-18 07:34:32.203044",
|
|
"spec": "1",
|
|
"internal_network_id": "89d66639-aacb-4929-969d-07080b0f9fd9",
|
|
"id": "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
|
|
"billinginfo": "",
|
|
"dnat_rules_limit": 200,
|
|
"snat_rule_public_ip_limit": 20,
|
|
"freeze_info": null,
|
|
"sys_tags": [
|
|
"_sys_enterprise_project_id=0"
|
|
],
|
|
"name": "nat_001"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="nat_api_0062__section22695302"><h4 class="sectiontitle">Status Codes</h4><p id="nat_api_0062__p6669271919540">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_0001.html">NAT Gateway Service</a></div>
|
|
</div>
|
|
</div>
|
|
|