vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpn/api-ref/vpn_api_1016.html
Hongwei, King Wang 32c06a10a2 vpn_api 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

301 lines
32 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001807370524"></a><a name="EN-US_TOPIC_0000001807370524"></a>
<h1 class="topictitle1">Querying VPNs by Tag</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_section25709437"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p4626311155220">This API is used to query VPNs by tag.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p18626181110528">Tag Management Service (TMS) filters service resource instances by tag and displays them in a list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_section30058349"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p422821810225">POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_section23101291384"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p98511332113011"><a href="#EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table45111823181914">Table 1</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table45111823181914"></a><a name="en-us_topic_0000001591616789_table45111823181914"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table45111823181914" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row88521623101920"><th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p168521123141913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.891089108910892%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p68525234198">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p68524237196">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.42574257425742%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1785232391916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row9852172316195"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p38521123191911">tags</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p198521723191910">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p15852102341915">No</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p2948626174411">Specifies the list of tags.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul928493817443"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li5284133818445">Up to 10 keys are supported.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li14284133813440">Each key can have a maximum of 10 tag values. <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b989365722715">values</strong> of each tag is mandatory and can be an empty array.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li92841438164416">The tag key cannot be left blank or be an empty string.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li122845381447">Each tag key must be unique, and each tag value in a tag must be unique.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row485202331911"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p08523237195">limit</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1285218232197">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1985292314197">No</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p175101224144711">Specifies the maximum number of resources to be queried.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul784594110477"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li78451141104710">If <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b75685529244">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b95805568248">count</strong>, this parameter is not required.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li12306143104717">If <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b14212135916250">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b4693839262">filter</strong>, the default value of <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1199714138262">limit</strong> is <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b3594181952612">1000</strong>.<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p67944611478">Supported range: 1 to 1000</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row14852423111914"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p885219237198">offset</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1985218237191">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p5852132317199">No</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p199311824194817">Specifies the index position. The query starts from the next data record indexed by this parameter.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul8769113914486"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li5769143913481">You do not need to specify this parameter when querying resources on the first page.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li125291854184812">When you query resources on subsequent pages, set <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1732089397451">offset</strong> to the location returned in the response body for the previous query.<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul010735754811"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li13784415496">If <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1049493916314">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b13494103993110">count</strong>, this parameter is not required.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li5510191674920">If <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1384188733451">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b960608622451">filter</strong>, the default value is <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b70348352451">0</strong>.<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p75601018174918">The offset must be a number and cannot be negative.</p>
</li></ul>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row28531123181913"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1853123121912">action</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p14853122371914">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p17853152331919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p20886658124919">Specifies the operation identifier.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p6853182320190">The identifier can be <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b13837835143315">filter</strong> or <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b125969409331">count</strong>.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul822004764913"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li4220174764912"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b14282492332">filter</strong>: Query data in pages.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li3220174716494"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b14759195619344">count</strong>: returns the total number of records that meet specified conditions.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row1885318232195"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p085315232194">matches</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p16853023111917">List&lt;match&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p18853102313197">No</p>
</td>
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p128537230197">Specifies the search criteria. The tag key is the field to match. Currently, only <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b84235270615351">resource_name</strong> is supported. The tag value indicates the value to be matched. The <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b10991315962239">key</strong> field is a fixed dictionary value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table1548032316199" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of field <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b84235270695528">tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row1785310237196"><th align="left" class="cellrowborder" valign="top" width="14.2985701429857%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p185312312192"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b84235270617246">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.718928107189281%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p208531923101913"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b84235270610412">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.21817818218178%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p685312311196"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b8423527061798">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.76432356764324%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p4853122311199"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b842352706151625">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row08532238197"><td class="cellrowborder" valign="top" width="14.2985701429857%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p16854122312191">key</p>
</td>
<td class="cellrowborder" valign="top" width="10.718928107189281%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p167509961911">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.21817818218178%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p5854122371919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.76432356764324%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p176374591532">Specifies the tag key.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul152117144414"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li9211181416412">A key can contain a maximum of 127 Unicode characters.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li132117149410"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b12412133115351">Key</strong> cannot be left blank.</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li14211714646">(This parameter is not verified in the search process.)</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row15854623141911"><td class="cellrowborder" valign="top" width="14.2985701429857%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p68541223141919">values</p>
</td>
<td class="cellrowborder" valign="top" width="10.718928107189281%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p838119133192">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="18.21817818218178%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p188541423181914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.76432356764324%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p194111619416">Specifies the list of tag values.</p>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul0579132214419"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li7502429148">Each value can contain a maximum of 255 Unicode characters.<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p86121632346"><a name="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li7502429148"></a><a name="en-us_topic_0000001591616789_li7502429148"></a>If <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b34717588360">values</strong> is an empty list, it indicates <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b263763650451">any_value</strong>.</p>
</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li13579102219416">The resources containing one or more values listed in <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1623699388451">values</strong> will be found and displayed.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table13731215298" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b14222185113518">match</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row1836752192916"><th align="left" class="cellrowborder" valign="top" width="14.391439143914392%" id="mcps1.3.3.5.2.5.1.1"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p836712211290"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b636749308">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.25112511251125%" id="mcps1.3.3.5.2.5.1.2"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p185201217172010"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1732628924451">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.961796179617963%" id="mcps1.3.3.5.2.5.1.3"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p8367424292"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b2016626762">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.395639563956394%" id="mcps1.3.3.5.2.5.1.4"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p103671626297"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1077023465">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row123691521298"><td class="cellrowborder" valign="top" width="14.391439143914392%" headers="mcps1.3.3.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1136914292918">key</p>
</td>
<td class="cellrowborder" valign="top" width="11.25112511251125%" headers="mcps1.3.3.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p132326387201">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.961796179617963%" headers="mcps1.3.3.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p13692242912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.395639563956394%" headers="mcps1.3.3.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p149529361546">Specifies the tag key.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p936962102919">The tag key can only be the resource name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row18373132182918"><td class="cellrowborder" valign="top" width="14.391439143914392%" headers="mcps1.3.3.5.2.5.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p16369329291">value</p>
</td>
<td class="cellrowborder" valign="top" width="11.25112511251125%" headers="mcps1.3.3.5.2.5.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1213719405202">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.961796179617963%" headers="mcps1.3.3.5.2.5.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1137312212917">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.395639563956394%" headers="mcps1.3.3.5.2.5.1.4 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p32375391447">Specifies the tag value.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p11373102182916">Each value can contain a maximum of 255 Unicode characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_section95436234191"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p111092544306"><a href="#EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table669961372515">Table 4</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table669961372515"></a><a name="en-us_topic_0000001591616789_table669961372515"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table669961372515" width="100%" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row689311382512"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p11893151312516"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b856186155">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.330000000000005%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1789361319251"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1923039965">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.67%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p19893131310258"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1329843796">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row7893201315255"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p889311310255">resources</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p989313131254">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1893111313258">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row1989331314259"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p158931313152513">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p58931113112511">int</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p10893121312258">Specifies the total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_table1260123015517" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of field <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b7642103510720">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row060230105117"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p36013035118"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1772434113716">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.330000000000005%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p26014301515"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1920337231">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.67%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p66013005118"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b664217431575">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row76014304517"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1960153015118">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p16601330175117">String</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p11601730185113">Specifies the resource ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row2601030125115"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p260230125114">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p4601930205120">Object</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1928220431254">Specifies the resource details.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p2060113085113">The details are left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row1060123020516"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p66093012515">tags</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p10602308519">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p168181033356">Specifies the list of tags.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p1360530165115">If there is no tag in the list, <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b60471224451">tags</strong> is taken as an empty array.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_row56013017511"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p136053075110">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="37.330000000000005%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p76015303512">String</p>
</td>
<td class="cellrowborder" valign="top" width="34.67%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p530322755">Specifies the resource name.</p>
<p id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_p46083016510">If there is no resource name, the parameter is an empty string by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_section107702427334"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul25029582346"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li15502158133418">Request example<pre class="screen" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_screen320612400213">POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action</pre>
</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li11918111310360">Request body<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul1385915234191"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li128595235191"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b10771113155010">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b1231019717508">filter</strong>.<pre class="screen" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_screen1547594735916">{
"offset": "0",
"limit": "100",
"action": "filter",
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
],
"tags": [
{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
]
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul185992341916"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li78591423161916"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b468011125505">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b6489191785013">count</strong>.<pre class="screen" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_screen1045912561517">{
"action": "count",
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
],
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
]
}</pre>
</li></ul>
</li><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li19874611352">Example response<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul686114239196"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li4861162315191"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b440332225017">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b240412225010">filter</strong>.<pre class="screen" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_screen786152371919">{
"resources": [
{
"resource_detail": null,
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resource1",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value1"
}
]
}
],
"total_count": 1000
}
</pre>
</li></ul>
<ul id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_ul197501433335"><li id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_li77507331933"><strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b17312519502">action</strong> is set to <strong id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_b4751425165017">count</strong>.<pre class="screen" id="EN-US_TOPIC_0000001807370524__en-us_topic_0000001591616789_screen139471650732">{
"total_count": 1000
}</pre>
</li></ul>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1015.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink