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

319 lines
33 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001854089209"></a><a name="EN-US_TOPIC_0000001854089209"></a>
<h1 class="topictitle1">Querying the Resource Instance List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1487610174615">This API is used to query resource instances based on tags.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p19989133162813">For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p162426363498">POST /v5/{project_id}/{resource_type}/resource-instances/filter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p6859639">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p179611479215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p18759866">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p43154149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p2077973">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p177965479212">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p34098154">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p199639252285">Specifies a project ID. You can obtain the project ID by referring to <a href="vpn_api_0051.html#EN-US_TOPIC_0000001807530332">Obtaining the Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row10221058192817"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p623155842816">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p223105819284">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p152315585286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul93453614117"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li43451661818">Specifies the resource type.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li16527151316115">The value can be <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b27561481476">vpn-gateway</strong>, <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b19340165104712">customer-gateway</strong>, or <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b94701953194718">vpn-connection</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92783" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter in a query request</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row584993141512"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p138492313158">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1584918318159">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1185017371513">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p98501361516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row151641552155"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1933106161219">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1933196171210">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p169331061129">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul1293311681216"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li129332641210">Specifies the number of records to be queried.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li79331631218">The value ranges from 1 to 1000.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li19336621210">The default value is 1000.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row193237588118"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1933166141210">offset</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p99331263121">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p593317618121">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul129331069120"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li149332611210">Specifies the index position. The query starts from the (<em id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_i2295946131416">offset value</em> + 1)th data record.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li093315620125">The minimum value is 0.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li2933660127">The default value is 0.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul5992193374713"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li59922337473">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table65426" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row888119174611"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p128826144612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p888213111469">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p888251154619">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p788261194616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row19881515468"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1326155346">without_any_tag</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1388214154618">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p088212115465">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul12192194044314"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li159212537438">When this parameter is set to <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b148279315820">true</strong>, all resources without tags are queried. In this case, the <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b1370602319815">tags</strong> field is ignored. If this parameter is set to <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b117744393718">false</strong> or is not specified, all resources are queried or resources are filtered by "tags" or "matches".</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row6787854123312"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p77871854143317">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p078755414338">Array of <a href="#EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92196">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p20787254173317">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul124531254455"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li84543256453">Specifies a tag list.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li145412253459">A maximum of 20 tags can be specified.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row53894575336"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p53891557173311">matches</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p62791314203514">Array of <a href="#EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table1255222583313">Match</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1683922513512">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul1630462674515"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li16777937124516">Specifies a search field, including a key and a value. The match key is the field to be matched, for example, <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b294145618613">resource_name</strong>. The match value is the value to be matched. The key is a fixed dictionary value.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92196"></a><a name="en-us_topic_0000001759396186_table92196"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92196" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Tag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row17982141112440"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p11982511184419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1498231116442">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p2098381112443">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p20983151154419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row498231134419"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p14983131174417">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p39837111443">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p19831111204412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul65231833153920"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li1303152053315">Specifies a tag key.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li152316335391">The value is a string of 1 to 128 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row860610253715"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p2606162103715">values</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p20607142113718">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p96071726374">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul961219349376"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li186123345379">Specifies the value list of a tag. If <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b13109101313514">values</strong> is an empty list, it indicates <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b181101113125116">any_value</strong>. The relationship between values is OR.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li10612123423720">The value is a sting of 0 to 255 characters.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li1612113412376">A maximum of 20 values can be specified.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table1255222583313"></a><a name="en-us_topic_0000001759396186_table1255222583313"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table1255222583313" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Match</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row2552132517335"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p5552122516337">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1455217253333">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p16552125133310">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p055212593318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row655222510337"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p2552162519336">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1455262512332">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p18553182583316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul1055322513317"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li1355312510331">Specifies a match key.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li655311251333">The value is <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b636026136">resource_name</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row555332563311"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p95531825113312">value</p>
</td>
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p12750641193619">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p255311253331">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul18553152563318"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li165531025193318">Specifies a match value.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li6553125103318">The value is a sting of 0 to 255 characters.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li16128161120217">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_screen1778465375316">POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/filter
{
"tags": [{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
],
"matches": [{
"key": "resource_name",
"value": "resource1"
}],
"without_any_tag": "false"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul2144514204819"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li61441714114816">Response parameters<p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1623112417119"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li61441714114816"></a><a name="en-us_topic_0000001759396186_li61441714114816"></a>Returned status code 200: successful query</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92198" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameters in the response body</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row14992101114413"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p89930114442">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.88%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p12993191144414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.900000000000006%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p129931111164410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row17992181154416"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p07305543221">resources</p>
</td>
<td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p9920651122818">Array of <a href="#EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92199">Resource</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.900000000000006%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p19941811124415">Indicates the resource object list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row179920112445"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p138112479275">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p2099481116449">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.900000000000006%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p13994191113443">Indicates the total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92199"></a><a name="en-us_topic_0000001759396186_table92199"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table92199" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Resource</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row19995121154420"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p9995131144415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1997181113442">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p109971611154417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row1299511119446"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1899791115449">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1599714115446">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p245917114291">Indicates a resource ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row1023010411430"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1923054144317">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p15230124164315">object</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p192300414312">Specifies resource details. This parameter is reserved for extension and is left empty by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row1767123085111"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p18721658125115">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p128617476272">Array of <a href="#EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table679911206275">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1097210355295">Specifies a tag list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row156651732125115"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p207245895119">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1672358125117">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1685712819529">Indicates a resource name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table679911206275"></a><a name="en-us_topic_0000001759396186_table679911206275"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_table679911206275" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row19799202082717"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p37992201275">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p11799620112719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1479982016278">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row47992200275"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1279902012714">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p12799142022715">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p265126172814">Indicates a tag key.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_row12800142014279"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p280072072718">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p621624762717">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p142729456282">Indicates a tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li8763172019216">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_screen678017232489">{
"resources": [{
"resource_id": "134f9fb1-demo-a8df-va86-2040a5c13325",
"resource_name": "resouece1",
"tags": [{
"key": "key1",
"value": "value1"
}]
}],
"total_count": 1000
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p18112112662914">For details, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0060.html">Tags</a></div>
</div>
</div>
View Git Blame Copy Permalink