vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/natgw/api-ref/nat_api_0002.html
Qin Ying, Fan 388d58fc5d NATGW API 20230922 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-01-16 14:31:30 +00:00

328 lines
26 KiB
HTML
Raw Blame History

<a name="nat_api_0002"></a><a name="nat_api_0002"></a>
<h1 class="topictitle1">Querying NAT Gateways</h1>
<div id="body42913595"><div class="section" id="nat_api_0002__section21650537"><h4 class="sectiontitle">Function</h4><p id="nat_api_0002__p53449151">This API is used to query NAT gateways. Unless otherwise specified, exact match is applied.</p>
</div>
<div class="section" id="nat_api_0002__section60637113"><h4 class="sectiontitle">URI</h4><p id="nat_api_0002__p10808131211415">GET /v2.0/nat_gateways</p>
<div class="note" id="nat_api_0002__note4558111204112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nat_api_0002__p480821212414">You can type the question mark (?) and ampersand (&amp;) at the end of the URI to define multiple search criteria. All optional parameters can be filtered. For details, see the example request.</p>
</div></div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0002__table18558131224111" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0002__row1808612184118"><th align="left" class="cellrowborder" valign="top" width="21.35213521352135%" id="mcps1.3.2.4.2.5.1.1"><p id="nat_api_0002__p780881214411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="8.08080808080808%" id="mcps1.3.2.4.2.5.1.2"><p id="nat_api_0002__p1558032915438">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.711671167116712%" id="mcps1.3.2.4.2.5.1.3"><p id="nat_api_0002__p380881220414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.855385538553854%" id="mcps1.3.2.4.2.5.1.4"><p id="nat_api_0002__p1880841274119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0002__row28088123418"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p480891218412">id</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p2580182916436">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p0808181217416">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p7808141219418">Specifies the NAT gateway ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row121171254102416"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p63722013254">limit</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p13764185294314">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p1737212162518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p237217110251">Specifies the number of records on each page.</p>
</td>
</tr>
<tr id="nat_api_0002__row080891254119"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p1880851212411">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p18311175344318">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p198084127419">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p1080810121412">Specifies the project ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row11808111284110"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p1808191244110">name</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p117981853124317">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p2080861264119">String(64)</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p2808112174112">Specifies the NAT gateway name.</p>
<p id="nat_api_0002__p138082126416">The name can contain only digits, letters, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="nat_api_0002__row6808712144114"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p08087126419">description</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p170010548430">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p180811212410">String(255)</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p780817129410">Provides supplementary information about the NAT gateway.</p>
</td>
</tr>
<tr id="nat_api_0002__row16808171215417"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p118081612194112">spec</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p4212155518434">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p2080820126416">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p198081612114114">Specifies the NAT gateway type.</p>
<p id="nat_api_0002__p138081012184115">The type can be:</p>
<ul id="nat_api_0002__ul151911279307"><li id="nat_api_0002__li851917277302"><strong id="nat_api_0002__b3656184813717">0</strong>: micro type, which supports up to 1,000 SNAT connections.</li></ul>
<ul id="nat_api_0002__ul108080122414"><li id="nat_api_0002__li88088126412"><strong id="nat_api_0002__b1464861612413">1</strong>: small type, which supports up to 10,000 SNAT connections.</li><li id="nat_api_0002__li1680881224117"><strong id="nat_api_0002__b765017168415">2</strong>: medium type, which supports up to 50,000 SNAT connections.</li><li id="nat_api_0002__li108087125413"><strong id="nat_api_0002__b11651616145">3</strong>: large type, which supports up to 200,000 SNAT connections.</li><li id="nat_api_0002__li1180891234111"><strong id="nat_api_0002__b10651516249">4</strong>: extra-large type, which supports up to 1,000,000 SNAT connections.</li></ul>
</td>
</tr>
<tr id="nat_api_0002__row178085121417"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p7808181224114">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p695725617435">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p12808121264118">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p108081912194120">Specifies the router ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row18808151274111"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p5808141224118">internal_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p781614578434">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p10808212124113">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p4808171224115">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_0002__row16808412104117"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p1380821214116">status</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p203831458144310">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p6808181284110">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="nat_api_0002__ul68084129415"><li id="nat_api_0002__li4808191218412">Specifies the NAT gateway status.</li><li id="nat_api_0002__li1180813129413">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_0002__row18808141244119"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p1780816122417">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p646565974314">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p1764614265487">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="nat_api_0002__ul71858556358"><li id="nat_api_0002__li132051838164415">Specifies whether the NAT gateway is up or down.</li><li id="nat_api_0002__li12205203804411">The state can be:<ul id="nat_api_0002__ul16205638124410"><li id="nat_api_0002__li16206163884415"><strong id="nat_api_0002__b10363175444018">true</strong>: The NAT gateway is up.</li><li id="nat_api_0002__li102063382449"><strong id="nat_api_0002__b37341155114011">false</strong>: The NAT gateway is down.</li></ul>
</li></ul>
</td>
</tr>
<tr id="nat_api_0002__row138088125411"><td class="cellrowborder" valign="top" width="21.35213521352135%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0002__p1680831254112">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="8.08080808080808%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0002__p173616110445">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.711671167116712%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0002__p1180818124411">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.855385538553854%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0002__p182375159231">Specifies when the NAT gateway is created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nat_api_0002__section12659140"><h4 class="sectiontitle">Request</h4><p id="nat_api_0002__p63247166">None</p>
</div>
<div class="section" id="nat_api_0002__section46823401"><h4 class="sectiontitle">Response</h4><p id="nat_api_0002__p35836588712"><a href="#nat_api_0002__table8843312114313">Table 2</a> lists response parameters.</p>
<div class="tablenoborder"><a name="nat_api_0002__table8843312114313"></a><a name="table8843312114313"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0002__table8843312114313" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="nat_api_0002__row10874912134313"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.4.3.2.4.1.1"><p id="nat_api_0002__p1887410126437">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_0002__p188749126436">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_0002__p14874111234319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0002__row1787461216433"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nat_api_0002__p48741812124312">nat_gateways</p>
</td>
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nat_api_0002__p14874512194313">List (NAT gateways)</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nat_api_0002__p129411120422">Specifies the NAT gateway objects. For details, see <a href="#nat_api_0002__table1810691174217">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nat_api_0002__table1810691174217"></a><a name="table1810691174217"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0002__table1810691174217" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="nat_api_0002__b166012161744">nat_gateway</strong> field</caption><thead align="left"><tr id="nat_api_0002__row15294131114425"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.4.2.4.1.1"><p id="nat_api_0002__p029451114211">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_0002__p18294511134216">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_0002__p102941011144211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0002__row929451134215"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p102941911114216">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p629481118424">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p1429411117423">Specifies the NAT gateway ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row1329471104211"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p82941511164216">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_0002__p17294011144211">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p19294181174214">Specifies the project ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row8294151112421"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p629441174214">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p12294161110426">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_0002__p1329414115428">Specifies the NAT gateway name.</p>
<p id="nat_api_0002__p529420111420">The name can contain only digits, letters, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="nat_api_0002__row229451119425"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p17294411174218">description</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p1629412114426">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_0002__p142947116421">Provides supplementary information about the NAT gateway.</p>
</td>
</tr>
<tr id="nat_api_0002__row1829421134210"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p13294121194215">spec</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p1629411118423">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p1329410119429">Specifies the NAT gateway type.</p>
<p id="nat_api_0002__p1429413113429">The type can be:</p>
<ul id="nat_api_0002__ul191213405211"><li id="nat_api_0002__li191264175216"><strong id="nat_api_0002__b144871586715">0</strong>: micro type, which supports up to 1,000 SNAT connections.</li></ul>
<ul id="nat_api_0002__ul3294191111427"><li id="nat_api_0002__li1294101114421"><strong id="nat_api_0002__b119376581871">1</strong>: small type, which supports up to 10,000 SNAT connections.</li><li id="nat_api_0002__li9294111124210"><strong id="nat_api_0002__b566410163411">2</strong>: medium type, which supports up to 50,000 SNAT connections.</li><li id="nat_api_0002__li2294611184210"><strong id="nat_api_0002__b1166410161548">3</strong>: large type, which supports up to 200,000 SNAT connections.</li><li id="nat_api_0002__li132942111425"><strong id="nat_api_0002__b146651616042">4</strong>: extra-large type, which supports up to 1,000,000 SNAT connections.</li></ul>
</td>
</tr>
<tr id="nat_api_0002__row1329416115424"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p629416117428">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_0002__p329418118427">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p429410118427">Specifies the router ID.</p>
</td>
</tr>
<tr id="nat_api_0002__row9294151184215"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p4294151104220">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_0002__p6294121115424">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p52948115428">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_0002__row182946117421"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p172941011194220">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p172942119421">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0002__ul8294181134219"><li id="nat_api_0002__li15294161117422">Specifies the NAT gateway status.</li><li id="nat_api_0002__li6294211174213">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_0002__row1629421184215"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p2294171112421">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_0002__p159281825725">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0002__ul1238147165311"><li id="nat_api_0002__li1139147175316">Specifies whether the NAT gateway is up or down.</li><li id="nat_api_0002__li339271537">The state can be:<ul id="nat_api_0002__ul1039167155320"><li id="nat_api_0002__li539371532"><strong id="nat_api_0002__b594612310418">true</strong>: The NAT gateway is up.</li><li id="nat_api_0002__li19399725314"><strong id="nat_api_0002__b11714253414">false</strong>: The NAT gateway is down.</li></ul>
</li></ul>
</td>
</tr>
<tr id="nat_api_0002__row19294121144218"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p1529417112428">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_0002__p0294151110422">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p14616181615910">Specifies when the NAT gateway is 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_0002__row18580682589"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p149362017222">billinginfo</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0002__p139369062217">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p13936100172217">Specifies the order information. This parameter is left blank by default.</p>
</td>
</tr>
<tr id="nat_api_0002__row9710122595819"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p5771528182512">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_0002__p17771828132511">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p377192820251">Specifies information about the frozen NAT gateway.</p>
</td>
</tr>
<tr id="nat_api_0002__row974411366412"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p1518616119354">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_0002__p518616163515">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p121861115354">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_0002__row2477039348"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p11694203711366">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_0002__p96948372361">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p6695137133613">Specifies the maximum number of EIPs in an SNAT rule on a NAT gateway. The default value is <strong id="nat_api_0002__b18773134511818">20</strong>.</p>
</td>
</tr>
<tr id="nat_api_0002__row7280142842"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0002__p7617544123719">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_0002__p10617184418373">Long</p>
</td>
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0002__p1861713440377">Specifies the maximum number of DNAT rules on a NAT gateway. The default value is <strong id="nat_api_0002__b752913490186">200</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nat_api_0002__section18757432"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0002__ul1119116511294"><li id="nat_api_0002__li21916519916">Example request<pre class="screen" id="nat_api_0002__screen31155369102132">GET https://{Endpoint}/v2.0/nat_gateways?limit=10</pre>
</li></ul>
</div>
<ul id="nat_api_0002__ul11893103100"><li id="nat_api_0002__li2893108109">Example response<pre class="screen" id="nat_api_0002__screen2011192510107">{
"nat_gateways": [
{
"router_id": "b1d81744-5165-48b8-916e-e56626feb88f",
"status": "ACTIVE",
"description": "",
"admin_state_up": true,
"tenant_id": "27e25061336f4af590faeabeb7fcd9a3",
"created_at": "2017-11-15 14:50:39.505112",
"spec": "2",
"internal_network_id": "5930796a-6026-4d8b-8790-6c6bfc9f87e8",
"id": "a253be25-ae7c-4013-978b-3c0785eccd63",
"billinginfo": "",
"dnat_rules_limit": 200,
"snat_rule_public_ip_limit": 20,
"freeze_info": null,
"sys_tags": [
"_sys_enterprise_project_id=0"
],
"name": "wj3"
},
{
"router_id": "305dc52f-13dd-429b-a2d4-444a1039ba0b",
"status": "ACTIVE",
"description": "",
"admin_state_up": true,
"tenant_id": "27e25061336f4af590faeabeb7fcd9a3",
"created_at": "2017-11-17 07:41:07.538062",
"spec": "2",
"internal_network_id": "fc09463b-4ef8-4c7a-93c8-92d9ca6daf9d",
"id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
"billinginfo": "",
"dnat_rules_limit": 200,
"snat_rule_public_ip_limit": 20,
"freeze_info": null,
"sys_tags": [
"_sys_enterprise_project_id=0"
],
"name": "lyl001"
}
]
}</pre>
</li></ul>
<div class="section" id="nat_api_0002__section42956987"><h4 class="sectiontitle">Status Codes</h4><p id="nat_api_0002__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_0001.html">NAT Gateway Service</a></div>
</div>
</div>
View Git Blame Copy Permalink