vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vpcep/api-ref/vpcep_06_0501.html
Qin Ying, Fan ef5d2cd3cf VPCEP API 20230307 version 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2023-06-14 11:56:35 +00:00

421 lines
34 KiB
HTML
Raw Blame History

<a name="vpcep_06_0501"></a><a name="vpcep_06_0501"></a>
<h1 class="topictitle1">Querying Resources by Tag</h1>
<div id="body1568971488962"><div class="section" id="vpcep_06_0501__section21621940163112"><h4 class="sectiontitle">Function</h4><p id="vpcep_06_0501__p17642400318">This API is used to query resources of a tenant by tag.</p>
</div>
<div class="section" id="vpcep_06_0501__section1916374019317"><h4 class="sectiontitle">URI</h4><p id="vpcep_06_0501__p117641940143118">POST /v1/{project_id}/{resource_type}/resource_instances/action</p>
<div class="p" id="vpcep_06_0501__p210892819323"><a href="#vpcep_06_0501__table51771440203117">Table 1</a> describes parameters in this URI.
<div class="tablenoborder"><a name="vpcep_06_0501__table51771440203117"></a><a name="table51771440203117"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table51771440203117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="vpcep_06_0501__row1576512406311"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.2.3.2.2.5.1.1"><p id="vpcep_06_0501__p177651840173113"><strong id="vpcep_06_0501__b1758745931312">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.2.3.2.2.5.1.2"><p id="vpcep_06_0501__p1076524083113"><strong id="vpcep_06_0501__b1541818141">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.2.3.2.2.5.1.3"><p id="vpcep_06_0501__p276515401318"><strong id="vpcep_06_0501__b165618216149">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.39393939393939%" id="mcps1.3.2.3.2.2.5.1.4"><p id="vpcep_06_0501__p187651540103113"><strong id="vpcep_06_0501__b1954711311145">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row6766114019315"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpcep_06_0501__p16766940163116">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpcep_06_0501__p1476634012318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpcep_06_0501__p87665408315">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpcep_06_0501__p1476616408318">Specifies the project ID. For details about how to obtain the project ID, see <a href="vpcep_08_0003.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row17661840143116"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpcep_06_0501__p3766134093117">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpcep_06_0501__p3766114023117">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpcep_06_0501__p1476634012315">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpcep_06_0501__p3766164043112">Specifies the resource type, which can be <strong id="vpcep_06_0501__b1436771851415">endpoint_service</strong> or <strong id="vpcep_06_0501__b33681818111414">endpoint</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="vpcep_06_0501__section15188194015318"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0501__ul87934113439"><li id="vpcep_06_0501__li177919412435">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table62501540103117" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="vpcep_06_0501__row676604023114"><th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="vpcep_06_0501__p8766740193116"><strong id="vpcep_06_0501__b4208193541517">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="vpcep_06_0501__p1276674013113"><strong id="vpcep_06_0501__b1066993621512">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="vpcep_06_0501__p5766340163116"><strong id="vpcep_06_0501__b1626224181513">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.89551044895511%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="vpcep_06_0501__p1766134023114"><strong id="vpcep_06_0501__b26652116163">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row27661840193116"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p12766194073115">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p5766124013317">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p676654083115">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p67671340193115">Lists tags that are included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row157671540183120"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p19767194016319">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p37670409316">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p1076715405313">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p1176715406317">Lists any tags that are included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row107671640133112"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p1276784053115">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p1376714010319">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p1476764093111">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p20767174043118">Lists tags that are not included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row207671640133120"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p107672401312">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p197671140193118">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p11767144010312">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p157671440103117">Lists any tags that are not included. Each resource to be queried contains a maximum of 20 keys. Each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row177671240153112"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p37679401317">limit</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p1376724016314">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p7767144015319">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p37674409310">Sets the page size. This parameter is unavailable when <strong id="vpcep_06_0501__b842352706112419">action</strong> is set to <strong id="vpcep_06_0501__b842352706112428">count</strong>. The default size is <strong id="vpcep_06_0501__b842352706112654">1000</strong> when <strong id="vpcep_06_0501__b39236199214364">action</strong> is set to <strong id="vpcep_06_0501__b132640505514364">filter</strong>. The maximum value is <strong id="vpcep_06_0501__b842352706112658">1000</strong>, and the minimum size is <strong id="vpcep_06_0501__b842352706112710">1</strong>. The size cannot be a negative number.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row13767204019319"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p4767104018319">offset</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p576716406315">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p1976714073110">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p1767940153119">Specifies the index position. This parameter is unavailable when <strong id="vpcep_06_0501__b842352706102654">action</strong> is set to <strong id="vpcep_06_0501__b84235270610271">count</strong>. If <strong id="vpcep_06_0501__b70205942519474">offset</strong> is set to <em id="vpcep_06_0501__i84235269720751">N</em>, the resource query starts from the N+1 piece of data. If <strong id="vpcep_06_0501__b842352706102717">action</strong> is set to <strong id="vpcep_06_0501__b842352706102722">filter</strong>, <strong id="vpcep_06_0501__b84235270620648">offset</strong> is <strong id="vpcep_06_0501__b84235270620630">0</strong> by default, indicating that the query starts from the first piece of data. <strong id="vpcep_06_0501__b84235270620744">offset</strong> must be a positive number.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row7767040173119"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p1176710405313">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p187671740123119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p37671240163118">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p1876714010311">Specifies the operation to perform. The operation can only be <strong id="vpcep_06_0501__b842352706145527">filter</strong> (filtering) or <strong id="vpcep_06_0501__b842352706145557">count</strong> (querying the total number).</p>
<p id="vpcep_06_0501__p117671040173115">If <strong id="vpcep_06_0501__b8423527061184">action</strong> is set to <strong id="vpcep_06_0501__b84235270611747">filter</strong>, the query is performed based on the filter conditions. If <strong id="vpcep_06_0501__b1158078253111040">action</strong> is set to <strong id="vpcep_06_0501__b1717869715111040">count</strong>, only the total number of records is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row276714093110"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="vpcep_06_0501__p776774020314">matches</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="vpcep_06_0501__p19767114016313">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="vpcep_06_0501__p1676734073114">List&lt;match&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="vpcep_06_0501__p576884043118">Specifies the search field. The tag key is the field to be matched, for example, <strong id="vpcep_06_0501__b1815994217155439">resource_name</strong>. <strong id="vpcep_06_0501__b201314374336">value</strong> indicates the matched value. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys.</p>
<p id="vpcep_06_0501__p77681140153116">Check whether fuzzy match is required based on the <strong id="vpcep_06_0501__b842352706195738">key</strong> value. For example, if <strong id="vpcep_06_0501__b842352706195830">key</strong> is set to <strong id="vpcep_06_0501__b842352706195813">resource_name</strong>, fuzzy search (case-insensitive) is performed by default. If <strong id="vpcep_06_0501__b842352706195917">value</strong> is empty, exact match is performed. Most services do not have resources without names. In this case, an empty list is returned. If <strong id="vpcep_06_0501__b84235270622448">key</strong> is <strong id="vpcep_06_0501__b842352706123558">resource_id</strong>, exact match is used. Only <strong id="vpcep_06_0501__b842352706123249">resource_name</strong> for <strong id="vpcep_06_0501__b842352706195039">key</strong> is supported. Other <strong id="vpcep_06_0501__b842352706195055">key</strong> values will be available later.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table1132474019312" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="vpcep_06_0501__b62757913512">tag</strong></caption><thead align="left"><tr id="vpcep_06_0501__row97688406317"><th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="vpcep_06_0501__p4768194017310"><strong id="vpcep_06_0501__b836775172915">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="vpcep_06_0501__p17768840113119"><strong id="vpcep_06_0501__b1825310814292">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="vpcep_06_0501__p9768164012318"><strong id="vpcep_06_0501__b15586169162915">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.89551044895511%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="vpcep_06_0501__p276804018312"><strong id="vpcep_06_0501__b17875410162918">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row1276824012317"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0501__p197681340153120">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0501__p127685400312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0501__p77681740123111">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0501__p8768240143116">Specifies the tag key. Each tag key contains a maximum of 127 unicode characters but cannot be left blank. The system does not verify the character set of <strong id="vpcep_06_0501__b14679192572919">key</strong> when searching for resources. <strong id="vpcep_06_0501__b166810258293">key</strong> cannot be empty, an empty string, or spaces. Before using <strong id="vpcep_06_0501__b368202519296">key</strong>, delete single-byte character (SBC) spaces before and after the value.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row2768740113110"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="vpcep_06_0501__p2768114033112">values</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="vpcep_06_0501__p4768154093113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="vpcep_06_0501__p1676814013119">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="vpcep_06_0501__p167681440123119">Specifies the tag value list. Each value contains a maximum of 255 Unicode characters. Before using <strong id="vpcep_06_0501__b13350164318613">values</strong>, delete SBC spaces before and after the value.</p>
<p id="vpcep_06_0501__p11768184017316">The value can be an empty array but cannot be left blank.</p>
<p id="vpcep_06_0501__p177681740123119">If the values are null, it indicates <strong id="vpcep_06_0501__b842352706175623">any_value</strong> (querying any value). The values are in the OR relationship.</p>
<p id="vpcep_06_0501__p1076812400317">The system does not verify the character set of <strong id="vpcep_06_0501__b67441534387">values</strong> when searching for resources, but only verifies the length.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table153401540163113" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="vpcep_06_0501__b1797814391784">match</strong></caption><thead align="left"><tr id="vpcep_06_0501__row6768440123116"><th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="vpcep_06_0501__p6768114023114"><strong id="vpcep_06_0501__b118842561467">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="vpcep_06_0501__p127680409316"><strong id="vpcep_06_0501__b562419581866">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="vpcep_06_0501__p10768340203110"><strong id="vpcep_06_0501__b88336592613">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.89551044895511%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="vpcep_06_0501__p147684407317"><strong id="vpcep_06_0501__b111121611671">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row1176834011318"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="vpcep_06_0501__p57685402311">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="vpcep_06_0501__p187681340143119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="vpcep_06_0501__p197688408317">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="vpcep_06_0501__p1768240113113">Specifies the tag key. Only <strong id="vpcep_06_0501__b380120610713">resource_name</strong> for <strong id="vpcep_06_0501__b5802186373">key</strong> is supported. Other <strong id="vpcep_06_0501__b58021461672">key</strong> values will be available later.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row167695401310"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="vpcep_06_0501__p47699401316">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="vpcep_06_0501__p197691940163114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="vpcep_06_0501__p7769124093119">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.89551044895511%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="vpcep_06_0501__p14769174043112">Specifies the tag value. Each value contains a maximum of 255 Unicode characters. The character set of <strong id="vpcep_06_0501__b51301516870">value</strong> is not verified.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="vpcep_06_0501__ul0766154083115"><li id="vpcep_06_0501__li676964019312"><a name="vpcep_06_0501__li676964019312"></a><a name="li676964019312"></a>Example request<p id="vpcep_06_0501__p13171119135111"><a name="vpcep_06_0501__li676964019312"></a><a name="li676964019312"></a>POST https://{endpoint}/v1/{project_id}/endpoint_service/resource_instances/action</p>
<p id="vpcep_06_0501__p67051225115120">or POST https://{endpoint}/v1/{project_id}/endpoint/resource_instances/action</p>
<p id="vpcep_06_0501__p82001417125119">or POST https://{endpoint}/v1/{project_id}/{resource_type}/resource_instances/action</p>
<ul id="vpcep_06_0501__ul1146512541555"><li id="vpcep_06_0501__li7702194925514">Request body when <strong id="vpcep_06_0501__b5417724473">action</strong> is set to <strong id="vpcep_06_0501__b14418124579">filter</strong><pre class="screen" id="vpcep_06_0501__screen11041414135117">{
"offset": "100",
"limit": "100",
"action": "filter",
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
],
"not_tags": [
{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
],
"tags": [
{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
],
"tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"not_tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
]
}</pre>
</li><li id="vpcep_06_0501__li78338075614">Request body when <strong id="vpcep_06_0501__b1765135131918">action</strong> is set to <strong id="vpcep_06_0501__b16712516197">count</strong><pre class="screen" id="vpcep_06_0501__screen6105514155113">{
"action": "count",
"not_tags": [
{
"key": "key1",
"values": [
"value1",
"*value2"
]
}
],
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
],
"tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"not_tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
]
}</pre>
</li></ul>
</li></ul>
</div>
<div class="section" id="vpcep_06_0501__section183609409311"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0501__ul1777024053111"><li id="vpcep_06_0501__li14770154023113">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table15367440153111" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="vpcep_06_0501__row877012401316"><th align="left" class="cellrowborder" valign="top" width="25.002500250025%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0501__p0770154013120"><strong id="vpcep_06_0501__b201210239195">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.852685268526855%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0501__p377013403318"><strong id="vpcep_06_0501__b91611225181915">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.144814481448144%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0501__p13771134083116"><strong id="vpcep_06_0501__b106126191917">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row13771144083120"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0501__p14771114053110">resources</p>
</td>
<td class="cellrowborder" valign="top" width="26.852685268526855%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0501__p37711440133114">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.144814481448144%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0501__p17716401318">N/A</p>
</td>
</tr>
<tr id="vpcep_06_0501__row11771204019313"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0501__p137711040153118">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="26.852685268526855%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0501__p1377117403310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.144814481448144%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0501__p977119407314">Specifies the total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table437413403312" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure of field <strong id="vpcep_06_0501__b2386555201914">resource</strong></caption><thead align="left"><tr id="vpcep_06_0501__row67714403312"><th align="left" class="cellrowborder" valign="top" width="25.002500250025%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpcep_06_0501__p17771164023110"><strong id="vpcep_06_0501__b9822105611198">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.52265226522652%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpcep_06_0501__p19771154013113"><strong id="vpcep_06_0501__b3928958181912">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.47484748474848%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpcep_06_0501__p107711940133112"><strong id="vpcep_06_0501__b106941359181919">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row7771164010311"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0501__p13771144016315">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.52265226522652%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0501__p15771114033111">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47484748474848%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0501__p1771184083113">Specifies the resource ID, which can be <strong id="vpcep_06_0501__b4894418162017">Endpoint Service ID</strong> or <strong id="vpcep_06_0501__b2054402192015">Endpoint ID</strong>.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row17771164016318"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0501__p1771124093112">tags</p>
</td>
<td class="cellrowborder" valign="top" width="26.52265226522652%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0501__p9771194014313">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.47484748474848%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0501__p11771184019315">Lists the tags. If no tag is matched, an empty array is returned.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row20771114063119"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpcep_06_0501__p677111406315">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="26.52265226522652%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpcep_06_0501__p117711040153116">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.47484748474848%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpcep_06_0501__p8772040133115">Specifies the resource name. If the resource does not have a name, the ID is returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0501__table1539174012316" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Data structure of field <strong id="vpcep_06_0501__b1225273821711">resource_tag</strong></caption><thead align="left"><tr id="vpcep_06_0501__row6772144083117"><th align="left" class="cellrowborder" valign="top" width="25.002500250025%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpcep_06_0501__p1577254043110"><strong id="vpcep_06_0501__b189571119201015">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.632663266326627%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="vpcep_06_0501__p14772174053115"><strong id="vpcep_06_0501__b27415218103">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.36483648364836%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="vpcep_06_0501__p15772154017315"><strong id="vpcep_06_0501__b19521222161010">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="vpcep_06_0501__row877274073120"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0501__p0772104011311">key</p>
</td>
<td class="cellrowborder" valign="top" width="26.632663266326627%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0501__p877274012313">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.36483648364836%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0501__p07721340103117">Specifies the tag key.</p>
</td>
</tr>
<tr id="vpcep_06_0501__row177214013110"><td class="cellrowborder" valign="top" width="25.002500250025%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpcep_06_0501__p13772184016314">value</p>
</td>
<td class="cellrowborder" valign="top" width="26.632663266326627%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpcep_06_0501__p157729401319">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.36483648364836%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpcep_06_0501__p17772340163114">Specifies the tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="vpcep_06_0501__ul7772154083112"><li id="vpcep_06_0501__li1677224073111">Example response<ul id="vpcep_06_0501__ul951511535618"><li id="vpcep_06_0501__li132059124563">Response body when <strong id="vpcep_06_0501__b922734512917">action</strong> is set to <strong id="vpcep_06_0501__b1722834514911">filter</strong><pre class="screen" id="vpcep_06_0501__screen1853215441319">{
"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><li id="vpcep_06_0501__li15753322195614">Response body when <strong id="vpcep_06_0501__b625704914912">action</strong> is set to <strong id="vpcep_06_0501__b325820496910">count</strong><pre class="screen" id="vpcep_06_0501__screen15993517219">{
"total_count": 1000
}</pre>
</li></ul>
</li></ul>
</div>
<div class="section" id="vpcep_06_0501__section7398640123111"><h4 class="sectiontitle">Status Codes</h4><p id="vpcep_06_0501__p19772124063117">See <a href="vpcep_08_0001.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0500.html">Tag Function</a></div>
</div>
</div>
View Git Blame Copy Permalink