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>
418 lines
30 KiB
HTML
418 lines
30 KiB
HTML
<a name="nat_api_0016"></a><a name="nat_api_0016"></a>
|
||
|
||
<h1 class="topictitle1">Querying NAT Gateways by Tag</h1>
|
||
<div id="body1527752404173"><div class="section" id="nat_api_0016__section15317711195716"><h4 class="sectiontitle">Function</h4><p id="nat_api_0016__p123401928155718">This API is used to filter NAT gateways by tag.</p>
|
||
<p id="nat_api_0016__p73402028155716">TMS uses this API to filter and list NAT gateways by tag.</p>
|
||
<p id="nat_api_0016__p14340728115710">By default, NAT gateways and tags are sorted in descending order of creation time.</p>
|
||
</div>
|
||
<div class="section" id="nat_api_0016__section1564893795710"><h4 class="sectiontitle">URI</h4><ul id="nat_api_0016__ul159733294212"><li id="nat_api_0016__li1959753214212">URI format</li></ul>
|
||
<p id="nat_api_0016__p96751110174115">POST /v2.0/{project_id}/nat_gateways/resource_instances/action</p>
|
||
<ul id="nat_api_0016__ul11570135211572"><li id="nat_api_0016__li105701752205713">Parameter description</li></ul>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table10505115255714" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nat_api_0016__row20571652155711"><th align="left" class="cellrowborder" valign="top" width="20.23%" id="mcps1.3.2.5.2.5.1.1"><p id="nat_api_0016__p14571145235710">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="12.9%" id="mcps1.3.2.5.2.5.1.2"><p id="nat_api_0016__p1957165265719">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="31.630000000000003%" id="mcps1.3.2.5.2.5.1.3"><p id="nat_api_0016__p12571652105712">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="35.24%" id="mcps1.3.2.5.2.5.1.4"><p id="nat_api_0016__p175711552125710">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row05710527573"><td class="cellrowborder" valign="top" width="20.23%" headers="mcps1.3.2.5.2.5.1.1 "><p id="nat_api_0016__p1957111528570">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.9%" headers="mcps1.3.2.5.2.5.1.2 "><p id="nat_api_0016__p1457155212572">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="31.630000000000003%" headers="mcps1.3.2.5.2.5.1.3 "><p id="nat_api_0016__p05712525577">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.24%" headers="mcps1.3.2.5.2.5.1.4 "><p id="nat_api_0016__p35711252175718">Specifies the project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="nat_api_0016__section11978172510586"><h4 class="sectiontitle">Request</h4><p id="nat_api_0016__p559016579427"><a href="#nat_api_0016__table1215426155818">Table 2</a> describes the request parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="nat_api_0016__table1215426155818"></a><a name="table1215426155818"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table1215426155818" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="nat_api_0016__row19308162615812"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.3.2.5.1.1"><p id="nat_api_0016__p1830812614585">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="12.47%" id="mcps1.3.3.3.2.5.1.2"><p id="nat_api_0016__p530812625819">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13.71%" id="mcps1.3.3.3.2.5.1.3"><p id="nat_api_0016__p230812262583">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="53.769999999999996%" id="mcps1.3.3.3.2.5.1.4"><p id="nat_api_0016__p43081026105814">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row14308202614581"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p73083267581">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p6308142615817">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p10309826185810">Array<Object></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p143091426125814">Specifies the included tags. Each tag contains a maximum of 20 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. Resources identified by different keys are in AND relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row1530918269586"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p8309626185814">tags_any</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p16309102618587">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p87772381452">Array<Object></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p630982645816">Specifies any included tags. Each tag contains a maximum of 20 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. Resources identified by different keys are in OR relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row1230913261581"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p19309626145811">not_tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p530902645812">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p1237194216513">Array<Object></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p1631022617581">Specifies the excluded tags. Each tag contains a maximum of 20 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. Resources not identified by different keys are in AND relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row193105261587"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p831016265583">not_tags_any</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p15310132675816">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p53906449510">Array<Object></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p11310326135811">Specifies any excluded tags. Each tag contains a maximum of 20 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. Resources not identified by different keys are in OR relationship, and values in one tag are in OR relationship. If no tag filtering criteria is specified, full data is returned.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row173109266587"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p12310202615587">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p63106262582">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p18310426105814">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p6310826115818">Number of records. This parameter is not available when <strong id="nat_api_0016__b842352706112419">action</strong> is set to <strong id="nat_api_0016__b842352706112428">count</strong>. The default value is <strong id="nat_api_0016__b842352706112654">1000</strong> when <strong id="nat_api_0016__b39236199214364">action</strong> is set to <strong id="nat_api_0016__b132640505514364">filter</strong>. The maximum value is <strong id="nat_api_0016__b842352706112658">1000</strong>, and the minimum value is <strong id="nat_api_0016__b842352706112710">1</strong>. The value cannot be a negative number.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row18310162619582"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p231032635814">offset</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p16310162619581">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p9310826115817">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p4310152635815">Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when <strong id="nat_api_0016__b84235270621521">action</strong> is set to <strong id="nat_api_0016__b84235270621525">count</strong>. If <strong id="nat_api_0016__b84235270621528">action</strong> is set to <strong id="nat_api_0016__b84235270621532">filter</strong>, the value must be a number, and the default value is <strong id="nat_api_0016__b84235270621539">0</strong>. The value cannot be a negative number.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row1331082665815"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p153111126135811">action</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p531113268587">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p831212268582">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p7312152645819">Specifies the operation to perform. The value can only be <strong id="nat_api_0016__b842352706145527">filter</strong> (filtering) or <strong id="nat_api_0016__b842352706145557">count</strong> (querying the total number).</p>
|
||
<p id="nat_api_0016__p531214266584">The value <strong id="nat_api_0016__b842352706112921">filter</strong> indicates pagination query. The value <strong id="nat_api_0016__b84235270611312">count</strong> indicates that the total number of query results meeting the search criteria will be returned. Returning other fields is not allowed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row731262615585"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nat_api_0016__p11312192625819">matches</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nat_api_0016__p1731232695820">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.71%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nat_api_0016__p1444813151965">Array<match></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.769999999999996%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nat_api_0016__p12312526145815">Specifies the search criteria. The tag key is the field to match, for example, <strong id="nat_api_0016__b1815994217155439">resource_name</strong>. The tag value indicates the matched value. This field is a fixed dictionary value.</p>
|
||
<p id="nat_api_0016__p16312426185817">Determine whether fuzzy match is required based on different fields. For example, if <strong id="nat_api_0016__b8423527062245">key</strong> is <strong id="nat_api_0016__b842352706123028">resource_name</strong>, fuzzy search (case insensitive) is used by default. If <strong id="nat_api_0016__b842352706123110">value</strong> is an empty string, exact match is used. If <strong id="nat_api_0016__b84235270622448">key</strong> is <strong id="nat_api_0016__b842352706123558">resource_id</strong>, exact match is used.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table14982192555816" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="nat_api_0016__b84235270695528">tag</strong></caption><thead align="left"><tr id="nat_api_0016__row1731222614587"><th align="left" class="cellrowborder" valign="top" width="20.23%" id="mcps1.3.3.4.2.5.1.1"><p id="nat_api_0016__p431292695811">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="11.68%" id="mcps1.3.3.4.2.5.1.2"><p id="nat_api_0016__p1231242617581">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.219999999999999%" id="mcps1.3.3.4.2.5.1.3"><p id="nat_api_0016__p1331252618582">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="53.87%" id="mcps1.3.3.4.2.5.1.4"><p id="nat_api_0016__p113131526195810">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row11313182615588"><td class="cellrowborder" valign="top" width="20.23%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nat_api_0016__p131320263586">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nat_api_0016__p1313426165815">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.219999999999999%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nat_api_0016__p3313182618581">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nat_api_0016__p43136265583">Specifies the tag key. A key contains a maximum of 127 Unicode characters and cannot be blank. (The system does not check the parameter when searching a tag.) The key cannot be empty or an empty string, and cannot contain spaces. Before verification, delete spaces before and after the value.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row1331311269589"><td class="cellrowborder" valign="top" width="20.23%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nat_api_0016__p1931392625819">values</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="11.68%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nat_api_0016__p19313182610584">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.219999999999999%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nat_api_0016__p111411457169">Array<String></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nat_api_0016__p1631420266585">Specifies the tag values. Each value contains a maximum of 255 Unicode characters and cannot contain spaces. Before verification, delete spaces before and after the value.</p>
|
||
<p id="nat_api_0016__p33145261584">The asterisk (*) is a reserved character. The value can be empty but cannot be left blank.</p>
|
||
<p id="nat_api_0016__p1531442616582">If the value starts with an asterisk (*), the string following the asterisk is fuzzy matched.</p>
|
||
<p id="nat_api_0016__p13141026165813">If the values are null, it indicates <strong id="nat_api_0016__b842352706175623">any_value</strong> (querying any value). The values are in OR relationship. </p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table9192619582" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="nat_api_0016__b17437104775120">match</strong></caption><thead align="left"><tr id="nat_api_0016__row1331562610583"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.5.2.5.1.1"><p id="nat_api_0016__p531520263589">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10.68%" id="mcps1.3.3.5.2.5.1.2"><p id="nat_api_0016__p629315162470">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16.38%" id="mcps1.3.3.5.2.5.1.3"><p id="nat_api_0016__p21981358470">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="53.239999999999995%" id="mcps1.3.3.5.2.5.1.4"><p id="nat_api_0016__p831519261583">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row17315326185810"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.5.2.5.1.1 "><p id="nat_api_0016__p2315326125811">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10.68%" headers="mcps1.3.3.5.2.5.1.2 "><p id="nat_api_0016__p153151626185817">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.38%" headers="mcps1.3.3.5.2.5.1.3 "><p id="nat_api_0016__p819818534712">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.239999999999995%" headers="mcps1.3.3.5.2.5.1.4 "><p id="nat_api_0016__p19316726125815">Specifies the tag key. The value is fixed at <strong id="nat_api_0016__b842352706195317">resource_name</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row5317122695814"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.5.2.5.1.1 "><p id="nat_api_0016__p931713266585">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10.68%" headers="mcps1.3.3.5.2.5.1.2 "><p id="nat_api_0016__p1931752614581">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.38%" headers="mcps1.3.3.5.2.5.1.3 "><p id="nat_api_0016__p11199858471">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53.239999999999995%" headers="mcps1.3.3.5.2.5.1.4 "><p id="nat_api_0016__p1231710266582">Specifies the key value. It can contain a maximum of 255 Unicode characters.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="nat_api_0016__section10266081148"><h4 class="sectiontitle">Response</h4><p id="nat_api_0016__p710812355017"><a href="#nat_api_0016__table9270786414">Table 5</a> lists response parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="nat_api_0016__table9270786414"></a><a name="table9270786414"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table9270786414" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="nat_api_0016__row2425485415"><th align="left" class="cellrowborder" valign="top" width="26.31736826317368%" id="mcps1.3.4.3.2.4.1.1"><p id="nat_api_0016__p1242520819417">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="35.52644735526447%" id="mcps1.3.4.3.2.4.1.2"><p id="nat_api_0016__p44251081041">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="38.15618438156184%" id="mcps1.3.4.3.2.4.1.3"><p id="nat_api_0016__p10425786412">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row84259819419"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nat_api_0016__p15425168746">resources</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nat_api_0016__p29823109712">Array<resource></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nat_api_0016__p642648548">Specifies the resource object list. For details, see <a href="#nat_api_0016__table5281587411">Table 6</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row64268819418"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nat_api_0016__p64269814410">total_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nat_api_0016__p13426689415">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nat_api_0016__p114269812410">Specifies the total number of resources.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="nat_api_0016__table5281587411"></a><a name="table5281587411"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table5281587411" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure description of field <strong id="nat_api_0016__b7642103510720">resource</strong></caption><thead align="left"><tr id="nat_api_0016__row4427118643"><th align="left" class="cellrowborder" valign="top" width="26.31736826317368%" id="mcps1.3.4.4.2.4.1.1"><p id="nat_api_0016__p10427781542">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="35.52644735526447%" id="mcps1.3.4.4.2.4.1.2"><p id="nat_api_0016__p144271781945">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="38.15618438156184%" id="mcps1.3.4.4.2.4.1.3"><p id="nat_api_0016__p24277815420">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row15428183415"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0016__p134281889417">resource_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0016__p74281781445">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0016__p104289811414">Specifies the resource ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row204281281947"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0016__p7428782420">resouce_detail</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0016__p742858944">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0016__p16428081647">Provides details about the resource. The value is a resource object, used for extension. This parameter is left blank by default.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row164281881345"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0016__p174281881543">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0016__p15428581242">Array<resource_tag></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0016__p84291481741">Specifies the list of queried tags. If no tag is matched, an empty array is returned. For details, see <a href="#nat_api_0016__table18303783416">Table 7</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="nat_api_0016__row1429788416"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nat_api_0016__p943015819413">resource_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nat_api_0016__p74301381413">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nat_api_0016__p84301881846">Specifies the resource name. This parameter is an empty string by default if there is no resource name.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="nat_api_0016__table18303783416"></a><a name="table18303783416"></a><table cellpadding="4" cellspacing="0" summary="" id="nat_api_0016__table18303783416" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="nat_api_0016__b1896465465">resource_tag</strong></caption><thead align="left"><tr id="nat_api_0016__row6432168146"><th align="left" class="cellrowborder" valign="top" width="26.31736826317368%" id="mcps1.3.4.5.2.4.1.1"><p id="nat_api_0016__p643214813412">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="35.52644735526447%" id="mcps1.3.4.5.2.4.1.2"><p id="nat_api_0016__p443228144">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="38.15618438156184%" id="mcps1.3.4.5.2.4.1.3"><p id="nat_api_0016__p9433787412">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="nat_api_0016__row114331183410"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.5.2.4.1.1 "><p id="nat_api_0016__p13433584411">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.5.2.4.1.2 "><p id="nat_api_0016__p9434168743">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.5.2.4.1.3 "><p id="nat_api_0016__p043415817413">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_0016__row204341281540"><td class="cellrowborder" valign="top" width="26.31736826317368%" headers="mcps1.3.4.5.2.4.1.1 "><p id="nat_api_0016__p643458648">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="35.52644735526447%" headers="mcps1.3.4.5.2.4.1.2 "><p id="nat_api_0016__p114342087414">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="38.15618438156184%" headers="mcps1.3.4.5.2.4.1.3 "><p id="nat_api_0016__p164341883411">Specifies the key value. The value can contain a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII characters (0–31) and the following characters: *<>\=</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="nat_api_0016__section11248407413"><h4 class="sectiontitle">Examples</h4><ul id="nat_api_0016__ul5175189115412"><li id="nat_api_0016__li2017516919540">Example request<ol id="nat_api_0016__ol71213203541"><li id="nat_api_0016__li1812118206546">Request body when <strong id="nat_api_0016__b10196191610518">action</strong> is set to <strong id="nat_api_0016__b131972162056">filter</strong></li></ol>
|
||
<pre class="screen" id="nat_api_0016__screen1415913402412">POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action
|
||
{
|
||
"offset": "100",
|
||
"limit": "100",
|
||
"action": "filter",
|
||
"matches": [
|
||
{
|
||
"key": "resource_name",
|
||
"value": "nat_gateways"
|
||
}
|
||
],
|
||
"not_tags": [
|
||
{
|
||
"key": "key1",
|
||
"values": [
|
||
"*value1",
|
||
"value2"
|
||
]
|
||
}
|
||
],
|
||
"tags": [
|
||
{
|
||
"key": "key2",
|
||
"values": [
|
||
"*value3",
|
||
"value4"
|
||
]
|
||
}
|
||
],
|
||
"tags_any": [
|
||
{
|
||
"key": "key3",
|
||
"values": [
|
||
"*value5",
|
||
"value6"
|
||
]
|
||
}
|
||
],
|
||
"not_tags_any": [
|
||
{
|
||
"key": "key4",
|
||
"values": [
|
||
"*value7",
|
||
"value8"
|
||
]
|
||
}
|
||
]
|
||
}</pre>
|
||
<ol start="2" id="nat_api_0016__ol1246645105414"><li id="nat_api_0016__li102461545155418">Request body when <strong id="nat_api_0016__b119162241713">action</strong> is set to <strong id="nat_api_0016__b1091619245713">count</strong></li></ol>
|
||
<pre class="screen" id="nat_api_0016__screen81625401747">POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action {
|
||
"action": "count",
|
||
"matches": [
|
||
{
|
||
"key": "resource_name",
|
||
"value": "nat_gateways"
|
||
}
|
||
],
|
||
"not_tags": [
|
||
{
|
||
"key": "key1",
|
||
"values": [
|
||
"*value1",
|
||
"value2"
|
||
]
|
||
}
|
||
],
|
||
"tags": [
|
||
{
|
||
"key": "key2",
|
||
"values": [
|
||
"*value3",
|
||
"value4"
|
||
]
|
||
}
|
||
],
|
||
"tags_any": [
|
||
{
|
||
"key": "key3",
|
||
"values": [
|
||
"*value5",
|
||
"value6"
|
||
]
|
||
}
|
||
],
|
||
"not_tags_any": [
|
||
{
|
||
"key": "key4",
|
||
"values": [
|
||
"*value7",
|
||
"value8"
|
||
]
|
||
}
|
||
]
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<ul id="nat_api_0016__ul1630816355516"><li id="nat_api_0016__li18300734553">Example response<ol id="nat_api_0016__ol84882013165519"><li id="nat_api_0016__li1848817133554">Response body when <strong id="nat_api_0016__b8423527069924">action</strong> is set to <strong id="nat_api_0016__b8423527069921">filter</strong></li></ol>
|
||
<pre class="screen" id="nat_api_0016__screen10386132618555">{
|
||
"resources": [
|
||
{
|
||
"resource_detail": null,
|
||
"resource_id": "e5ad289f-9c56-4daf-b08b-2e53a983473a",
|
||
"resource_name": "nat_gateways",
|
||
"tags": [
|
||
{
|
||
"key": "key2",
|
||
"value": "value4"
|
||
},
|
||
{
|
||
"key": "key2",
|
||
"value": "value3"
|
||
}
|
||
]
|
||
}
|
||
],
|
||
"total_count": 1000
|
||
}</pre>
|
||
<ol start="2" id="nat_api_0016__ol13274164817557"><li id="nat_api_0016__li427412485552">Response body when <strong id="nat_api_0016__b842352706203143">action</strong> is set to <strong id="nat_api_0016__b842352706203145">count</strong></li></ol>
|
||
<pre class="screen" id="nat_api_0016__screen13434426105520">{
|
||
"total_count": 1000
|
||
}</pre>
|
||
</li></ul>
|
||
<div class="section" id="nat_api_0016__section1153181111115"><h4 class="sectiontitle">Status Code</h4><p id="nat_api_0016__p11991911191118">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>
|
||
|