vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/natgw/api-ref/nat_api_0007.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

321 lines
25 KiB
HTML
Raw Permalink Blame History

<a name="nat_api_0007"></a><a name="nat_api_0007"></a>
<h1 class="topictitle1">Querying SNAT Rules</h1>
<div id="body727517"><div class="section" id="nat_api_0007__section3132024"><h4 class="sectiontitle">Function</h4><p id="nat_api_0007__p58928935">This API is used to query SNAT rules.</p>
</div>
<div class="section" id="nat_api_0007__section28188224"><h4 class="sectiontitle">URI</h4><p id="nat_api_0007__p815091510435">GET /v2.0/snat_rules</p>
<div class="note" id="nat_api_0007__note999417147438"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nat_api_0007__p1915019153437">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_0007__table1994131474314" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0007__row1415051518436"><th align="left" class="cellrowborder" valign="top" width="21.34%" id="mcps1.3.2.4.2.5.1.1"><p id="nat_api_0007__p1415014152437">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.68%" id="mcps1.3.2.4.2.5.1.2"><p id="nat_api_0007__p0314161614916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.09%" id="mcps1.3.2.4.2.5.1.3"><p id="nat_api_0007__p111508151438">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.89%" id="mcps1.3.2.4.2.5.1.4"><p id="nat_api_0007__p215041554317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0007__row1415051517431"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p131501515144316">id</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p1931471624917">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p111507156439">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p191501915184313">Specifies the SNAT rule ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row4353106192713"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p149161116277">limit</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p113141516144920">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p549121120274">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p12495111278">Specifies the number of records on each page.</p>
</td>
</tr>
<tr id="nat_api_0007__row15150121504310"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p915012158432">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p531415165495">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p181501815134315">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p2150101584316">Specifies the project ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row21505159436"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p3150181564316">nat_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p19314131611491">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p11150121518435">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p18150115174314">Specifies the NAT gateway ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row15150215204316"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p1115051534313">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p4314121617497">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p1915071574317">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p10150415104315">Specifies the network ID used by the SNAT rule.</p>
</td>
</tr>
<tr id="nat_api_0007__row1315041519435"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p1115018151435">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p17315101616499">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p51501158433">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p2150201513432">Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.</p>
</td>
</tr>
<tr id="nat_api_0007__row2150215104311"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p1150915124313">source_type</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p2315151644912">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p131508153431">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p1715019154438"><strong id="nat_api_0007__b667415014212">0</strong>: Either <strong id="nat_api_0007__b116749506215">network_id</strong> or <strong id="nat_api_0007__b1767575012212">cidr</strong> can be specified in a VPC.</p>
<p id="nat_api_0007__p4150141514433"><strong id="nat_api_0007__b28466255212">1</strong>: Only <strong id="nat_api_0007__b58469219523">cidr</strong> can be specified over a Direct Connect connection.</p>
<p id="nat_api_0007__p915031534313">If no value is entered, the default value <strong id="nat_api_0007__b14717415339">0</strong> (VPC) is used.</p>
</td>
</tr>
<tr id="nat_api_0007__row15150161513433"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p315011152432">floating_ip_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p131521634914">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p91505152437">String(4096)</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p138311037012">Specifies the <span id="nat_api_0007__text585611983116"></span><span id="nat_api_0007__text1692841915315">EIP</span> ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row1315061516437"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p151501215144310">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p131561619498">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p8150101514314">String(1024)</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p1534335207">Specifies the <span id="nat_api_0007__text14569133511510"></span><span id="nat_api_0007__text1856903515159">EIP</span>.</p>
</td>
</tr>
<tr id="nat_api_0007__row1182641525718"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p1082661515717">description</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p6826171575715">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p6826141516574">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p982614152571">Provides supplementary information about the SNAT rule.</p>
</td>
</tr>
<tr id="nat_api_0007__row3150131544312"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p181509154430">status</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p3315111614912">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p201505152437">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="nat_api_0007__ul1815011157431"><li id="nat_api_0007__li41501115144316">Specifies the status of the SNAT rule.</li><li id="nat_api_0007__li6150141584311">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_0007__row101509151439"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p111506155432">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p031511684912">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p1764614265487">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><ul id="nat_api_0007__ul71858556358"><li id="nat_api_0007__li132051838164415">Specifies whether the SNAT rule is enabled or disabled.</li><li id="nat_api_0007__li12205203804411">The state can be:<ul id="nat_api_0007__ul16205638124410"><li id="nat_api_0007__li16206163884415"><strong id="nat_api_0007__b125089485567">true</strong>: The SNAT rule is enabled.</li><li id="nat_api_0007__li102063382449"><strong id="nat_api_0007__b8456349165617">false</strong>: The SNAT rule is disabled.</li></ul>
</li></ul>
</td>
</tr>
<tr id="nat_api_0007__row14150121515435"><td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nat_api_0007__p16150615184312">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nat_api_0007__p13315181620498">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nat_api_0007__p11150215184311">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.89%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nat_api_0007__p39521571301">Specifies when the SNAT rule 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>
<p id="nat_api_0007__p1515091510434"></p>
</div>
<div class="section" id="nat_api_0007__section1544804"><h4 class="sectiontitle">Request</h4><p id="nat_api_0007__p13571806">None</p>
</div>
<div class="section" id="nat_api_0007__section13903243"><h4 class="sectiontitle">Response</h4><p id="nat_api_0007__p56430435561"><a href="#nat_api_0007__table25574495">Table 2</a> lists response parameters.</p>
<div class="tablenoborder"><a name="nat_api_0007__table25574495"></a><a name="table25574495"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0007__table25574495" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="nat_api_0007__row6316572"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.4.3.2.4.1.1"><p id="nat_api_0007__p41880308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.050000000000004%" id="mcps1.3.4.3.2.4.1.2"><p id="nat_api_0007__p36861764">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.3.2.4.1.3"><p id="nat_api_0007__p56800622">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0007__row37447704"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nat_api_0007__p13365211">snat_rules</p>
</td>
<td class="cellrowborder" valign="top" width="28.050000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nat_api_0007__p8840286">List (SNAT rules)</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nat_api_0007__p19058885">Specifies the SNAT rule objects. For details, see <a href="#nat_api_0007__table589411291812">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nat_api_0007__table589411291812"></a><a name="table589411291812"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0007__table589411291812" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="nat_api_0007__b1879863591416">snat_rule</strong> field</caption><thead align="left"><tr id="nat_api_0007__row78949281818"><th align="left" class="cellrowborder" valign="top" width="20.92209220922092%" id="mcps1.3.4.4.2.4.1.1"><p id="nat_api_0007__p144282010346">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.162816281628167%" id="mcps1.3.4.4.2.4.1.2"><p id="nat_api_0007__p1742881017412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.91509150915091%" id="mcps1.3.4.4.2.4.1.3"><p id="nat_api_0007__p1442813106416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nat_api_0007__row158941625183"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p1059722885319">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p1859722895314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p759782812534">Specifies the SNAT rule ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row189413213184"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p1759782816538">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p959719287534">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p15597328145316">Specifies the project ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row17894326185"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p75979285538">nat_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p4597152810532">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p7597202805311">Specifies the NAT gateway ID.</p>
</td>
</tr>
<tr id="nat_api_0007__row8894121185"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p17597828105318">network_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p159732815535">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p11597182885319">Specifies the network ID used by the SNAT rule.</p>
</td>
</tr>
<tr id="nat_api_0007__row1689422131813"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p7597152814536">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p1959752813534">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p85971428135313">Specifies a subset of the VPC subnet CIDR block or a CIDR block of Direct Connect connection.</p>
</td>
</tr>
<tr id="nat_api_0007__row17894229186"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p1859718289538">source_type</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p19597152810533">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p2597142811539"><strong id="nat_api_0007__b1287868360">0</strong>: Either <strong id="nat_api_0007__b233097477">network_id</strong> or <strong id="nat_api_0007__b139213317">cidr</strong> can be specified in a VPC.</p>
<p id="nat_api_0007__p175971428185312"><strong id="nat_api_0007__b216113591626">1</strong>: Only <strong id="nat_api_0007__b141612591429">cidr</strong> can be specified over a Direct Connect connection.</p>
<p id="nat_api_0007__p159762875319">If no value is entered, the default value <strong id="nat_api_0007__b1729817579">0</strong> (VPC) is used.</p>
</td>
</tr>
<tr id="nat_api_0007__row1189413211817"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p4597152810537">floating_ip_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p13597128105319">String(4096)</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0007__ul95970283530"><li id="nat_api_0007__li1659716280537">Specifies the <span id="nat_api_0007__text383585621101228"></span><span id="nat_api_0007__text1004145694101228">EIP</span> ID. Use commas (,) to separate multiple IDs.</li><li id="nat_api_0007__li1859712865311">The maximum length of the ID is 4,096 bytes.</li><li id="nat_api_0007__li12597528125312">Constraints: The number of <span id="nat_api_0007__text1312125103320"></span><span id="nat_api_0007__text912851173319">EIP</span> IDs cannot exceed 20.</li></ul>
</td>
</tr>
<tr id="nat_api_0007__row1214011791212"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p7890161710129">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p19890917111215">String(1024)</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0007__ul12890181721213"><li id="nat_api_0007__li98904178125">Specifies the <span id="nat_api_0007__text76542055113310"></span><span id="nat_api_0007__text136546558335">EIP</span>. Use commas (,) to separate multiple <span id="nat_api_0007__text183807419108"></span><span id="nat_api_0007__text838024111108">EIP</span>s.</li><li id="nat_api_0007__li589051771217">The maximum length is 1,024 bytes.</li></ul>
</td>
</tr>
<tr id="nat_api_0007__row65931115125"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p389019177125">freezed_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p4890141751210">String(1024)</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0007__ul0890917131214"><li id="nat_api_0007__li1189061781210">Specifies the frozen EIP. Use commas (,) to separate frozen EIPs.</li><li id="nat_api_0007__li18900175121">The maximum length is 1,024 bytes.</li></ul>
</td>
</tr>
<tr id="nat_api_0007__row14894172111816"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p125971728125310">description</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p10597122819535">String(255)</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p12597162875313">Provides supplementary information about the SNAT rule.</p>
</td>
</tr>
<tr id="nat_api_0007__row68941219185"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p185971828135312">status</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p16597228135314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0007__ul105971428125319"><li id="nat_api_0007__li205971128175317">Specifies the status of the SNAT rule.</li><li id="nat_api_0007__li4597152825314">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_0007__row689419281813"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p1759792811533">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p10798165216111">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="nat_api_0007__ul121279715562"><li id="nat_api_0007__li1212812765613">Specifies whether the SNAT rule is enabled or disabled.</li><li id="nat_api_0007__li81283725618">The state can be:<ul id="nat_api_0007__ul151281773564"><li id="nat_api_0007__li8128197155615"><strong id="nat_api_0007__b1551310137583">true</strong>: The SNAT rule is enabled.</li><li id="nat_api_0007__li612817714567"><strong id="nat_api_0007__b13888161445815">false</strong>: The SNAT rule is disabled.</li></ul>
</li></ul>
</td>
</tr>
<tr id="nat_api_0007__row4894182171813"><td class="cellrowborder" valign="top" width="20.92209220922092%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0007__p7382183916534">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="28.162816281628167%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0007__p1238211390533">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.91509150915091%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0007__p1748651410013">Specifies when the SNAT rule 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_0007__section58020329"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0007__ul13831202214573"><li id="nat_api_0007__li1683112235713">Example request<pre class="screen" id="nat_api_0007__screen40294661103024">GET https://{Endpoint}/v2.0/snat_rules?limit=10</pre>
</li></ul>
</div>
<ul id="nat_api_0007__ul104310349576"><li id="nat_api_0007__li043134155713">Example response<pre class="screen" id="nat_api_0007__screen7959551205715">{
"snat_rules": [
{
"floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
"status": "ACTIVE",
"nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
"admin_state_up": true,
"network_id": "9a469561-daac-4c94-88f5-39366e5ea193",
"cidr": "null",
"source_type":0,
"tenant_id": "abc",
"created_at": "2017-11-15 15:44:42.595173",
"id": "79195d50-0271-41f1-bded-4c089b2502ff",
"floating_ip_address": "5.21.11.242",
"freezed_ip_address": "",
"description": "description"
},
{
"floating_ip_id": "6e496fba-abe9-4f5e-9406-2ad8c809ac8c",
"status": "ACTIVE",
"nat_gateway_id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
"admin_state_up": true,
"network_id": "97e89905-f9c8-4ae3-9856-392b0b2fbe7f",
"cidr": "null",
"source_type":0,
"tenant_id": "abc",
"created_at": "2017-11-17 07:43:44.830845",
"id": "4a1a10d7-0d9f-4846-8cda-24cffeffef5c",
"floating_ip_address": "5.21.11.142",
"freezed_ip_address": "",
"description": "description"
}
]
}</pre>
</li></ul>
<div class="section" id="nat_api_0007__section13981185113572"><h4 class="sectiontitle">Status Codes</h4><p id="nat_api_0007__p13981151105711">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_0005.html">SNAT Rules</a></div>
</div>
</div>
View Git Blame Copy Permalink