vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/api-ref/dws_02_0048.html
Lu, Huayi 24f47208ec DWS API 831.100 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-10-07 10:18:56 +00:00

480 lines
39 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001186151632"></a><a name="EN-US_TOPIC_0000001186151632"></a>
<h1 class="topictitle1">Querying Resources by Tag</h1>
<div id="body1524298666228"><div class="section" id="EN-US_TOPIC_0000001186151632__section1828015651013"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001186151632__p206631456191010">This API is used to query resource instances that meet the specified tag filtering criteria.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section128135691019"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000001186151632__screen92442324112">POST /v1.0/{project_id}/clusters/resource_instances/action</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table96931526192216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row7692122622212"><th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p1169215263221"><strong id="EN-US_TOPIC_0000001186151632__b4606883011371">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.549999999999999%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p8692112616227"><strong id="EN-US_TOPIC_0000001186151632__b84235270684256">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.9%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p1669216266227"><strong id="EN-US_TOPIC_0000001186151632__b172299207511371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.82%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p16692192662219"><strong id="EN-US_TOPIC_0000001186151632__b1648419353328">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row1169362672210"><td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p17692182616222">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.549999999999999%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2069232602219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.9%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p11692132615223">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.82%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p26931267227">Project ID. For details about how to obtain the project ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section576234392216"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table91641958162213" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row61642586227"><th align="left" class="cellrowborder" valign="top" width="17.328267173282672%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p116565817228"><strong id="EN-US_TOPIC_0000001186151632__b25488235811371">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.418958104189581%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p131651958172217"><strong id="EN-US_TOPIC_0000001186151632__b973030077">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.84871512848715%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p41653582225"><strong id="EN-US_TOPIC_0000001186151632__b170940764311371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.40405959404059%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p5165058192216"><strong id="EN-US_TOPIC_0000001186151632__b114982041104313">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row51653581223"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1165185832210">tags</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p18165175812219">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p11651258192210">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table11169125892211">tag</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p516535802211">The resources to be queried contain tags listed in <strong id="EN-US_TOPIC_0000001186151632__b203175075411371">tags</strong>. Each resource to be queried contains a maximum of 10 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 must be unique, and each tag value in a tag 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="EN-US_TOPIC_0000001186151632__row1116512584227"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p71667583222">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p13166155811221">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p181661582222">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table11169125892211">tag</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p15166185862218">The resources to be queried contain any tags listed in <strong id="EN-US_TOPIC_0000001186151632__b31931478311371">tags_any</strong>. Each resource to be queried contains a maximum of 10 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 must be unique, and each tag value in a tag 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="EN-US_TOPIC_0000001186151632__row4166135819228"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1016675862219">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p151661258172217">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p616645816222">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table11169125892211">tag</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p2166175812211">The resources to be queried do not contain tags listed in <strong id="EN-US_TOPIC_0000001186151632__b184470307311371">not_tags</strong>. Each resource to be queried contains a maximum of 10 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 must be unique, and each tag value in a tag 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="EN-US_TOPIC_0000001186151632__row121669587229"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p19167135812219">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2167958192211">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p101678584223">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table11169125892211">tag</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p1416714582224">The resources to be queried do not contain any tags listed in <strong id="EN-US_TOPIC_0000001186151632__b128974682911371">not_tags_any</strong>. Each resource to be queried contains a maximum of 10 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 must be unique, and each tag value in a tag must be unique. The response returns resources containing no 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="EN-US_TOPIC_0000001186151632__row18167658112213"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p216714586228">limit</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1016745817226">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p51671358202217">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p131674588223">Maximum number of records returned in the query result. This parameter is not displayed when <strong id="EN-US_TOPIC_0000001186151632__b842352706195922">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b842352706195927">count</strong>. If <strong id="EN-US_TOPIC_0000001186151632__b84235270692122">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b84235270692134">filter</strong>, this parameter takes effect. Its value ranges from 1 to 1000 (default).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row51686585227"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1616825872212">offset</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p19168185892219">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p1416845814228">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p3168258142218">Start location of pagination query. The query starts from the next resource of the specified location. When querying the data on the first page, you do not need to specify this parameter. When querying the data on subsequent pages, set this parameter to the value in the response body returned by querying data of the previous page. This parameter is not displayed when <strong id="EN-US_TOPIC_0000001186151632__b84235270611518">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b842352706115112">count</strong>. If <strong id="EN-US_TOPIC_0000001186151632__b84235270692726">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b84235270692731">filter</strong>, this parameter takes effect. Its value can be 0 (default) or a positive integer.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row16168135818224"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p17168958192211">action</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p16168185811227">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p31681758192216">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p1016895815227">Identifies the operation. The value can be <strong id="EN-US_TOPIC_0000001186151632__b842352706112823">filter</strong> or <strong id="EN-US_TOPIC_0000001186151632__b842352706112836">count</strong>.</p>
<ul id="EN-US_TOPIC_0000001186151632__ul171681958112217"><li id="EN-US_TOPIC_0000001186151632__li91687583226"><strong id="EN-US_TOPIC_0000001186151632__b92132062111371">filter</strong>: indicates filtering. If both <strong id="EN-US_TOPIC_0000001186151632__b1750512117816">limit</strong> and <strong id="EN-US_TOPIC_0000001186151632__b4879172819810">offset</strong> are specified, the return result is paginated. If <strong id="EN-US_TOPIC_0000001186151632__b345798131011">limit</strong> and <strong id="EN-US_TOPIC_0000001186151632__b955910113109">offset</strong> are not specified, return result is paginated only when the number of returned records exceeds 1000.</li><li id="EN-US_TOPIC_0000001186151632__li41681458152214"><strong id="EN-US_TOPIC_0000001186151632__b30379672011371">count</strong> indicates the total number of returned records that meet the query criteria. </li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row12169135819226"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p51691158112218">matches</p>
</td>
<td class="cellrowborder" valign="top" width="10.418958104189581%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p141691158172219">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.84871512848715%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p12169145817226">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table1117295882218">match</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.40405959404059%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p12169658152213">Search field. <strong id="EN-US_TOPIC_0000001186151632__b128495828211371">key</strong> indicates the field to be matched, for example, <strong id="EN-US_TOPIC_0000001186151632__b31012628911371">resource_name</strong>. <strong id="EN-US_TOPIC_0000001186151632__b8423527061236">value</strong> indicates the fuzzy match result.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001186151632__table11169125892211"></a><a name="table11169125892211"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table11169125892211" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001186151632__b84235270695528">tag</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row316925812211"><th align="left" class="cellrowborder" valign="top" width="17.328267173282672%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p717055819224"><strong id="EN-US_TOPIC_0000001186151632__b0128122463318">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.17898210178982%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p717015852210"><strong id="EN-US_TOPIC_0000001186151632__b217199574">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.20867913208679%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p517018585221"><strong id="EN-US_TOPIC_0000001186151632__b13402429311371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.28407159284072%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p817085810229"><strong id="EN-US_TOPIC_0000001186151632__b71051274334">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row19170145822214"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p141701858102219">key</p>
</td>
<td class="cellrowborder" valign="top" width="10.17898210178982%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2170125832219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.20867913208679%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p5171658112212">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.28407159284072%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p117185817227">Tag key. A tag key can contain a maximum of 127 Unicode characters, which cannot be null. The first and last characters cannot be spaces. </p>
<p id="EN-US_TOPIC_0000001186151632__p15171758202218">It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row1171858162215"><td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p91711958192216">values</p>
</td>
<td class="cellrowborder" valign="top" width="10.17898210178982%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p111711558102218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.20867913208679%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p13172185862217">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.28407159284072%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p1417215586227">Tag value. A tag value can contain a maximum of 255 Unicode characters, which can be null. The first and last characters cannot be spaces. It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001186151632__table1117295882218"></a><a name="table1117295882218"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table1117295882218" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of field <strong id="EN-US_TOPIC_0000001186151632__b101181788187">Match</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row1117320585221"><th align="left" class="cellrowborder" valign="top" width="17.45174517451745%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p151737583220"><strong id="EN-US_TOPIC_0000001186151632__b917610315330">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.061006100610062%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p717425872216"><strong id="EN-US_TOPIC_0000001186151632__b1649816738">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.331333133313331%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p2017413585227"><strong id="EN-US_TOPIC_0000001186151632__b201185160711371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.15591559155916%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p141741558102211"><strong id="EN-US_TOPIC_0000001186151632__b224031568">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row3174358192216"><td class="cellrowborder" valign="top" width="17.45174517451745%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p71741158112212">key</p>
</td>
<td class="cellrowborder" valign="top" width="10.061006100610062%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2174125819225">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.331333133313331%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p617485811227">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.15591559155916%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p12174758102219">Key. Currently, it can only be <strong id="EN-US_TOPIC_0000001186151632__b842352706191718">resource_name</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row16174155818226"><td class="cellrowborder" valign="top" width="17.45174517451745%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1317565872220">value</p>
</td>
<td class="cellrowborder" valign="top" width="10.061006100610062%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p4175155820222">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.331333133313331%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p3175125813228">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.15591559155916%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p4175758172212">Key value. Each value can contain a maximum of 255 Unicode characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section1143616155239"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table17258183272312" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row325913242316"><th align="left" class="cellrowborder" valign="top" width="17.450000000000003%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p825914321232"><strong id="EN-US_TOPIC_0000001186151632__b123854534711371">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.3%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p42591832152317"><strong id="EN-US_TOPIC_0000001186151632__b1867268983">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.730000000000002%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p14259193211239"><strong id="EN-US_TOPIC_0000001186151632__b104958276011371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.52%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p225973202319"><strong id="EN-US_TOPIC_0000001186151632__b13212114313312">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row4259103212311"><td class="cellrowborder" valign="top" width="17.450000000000003%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p18259163232320">resources</p>
</td>
<td class="cellrowborder" valign="top" width="10.3%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p192591432142317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.730000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p326073217233">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table6260232102319">resource</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.52%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p6260932182317">Resources that meet the search criteria.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row20260143214233"><td class="cellrowborder" valign="top" width="17.450000000000003%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p726013216231">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="10.3%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2260153214237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.730000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p14260183292312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59.52%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p826011324236">Total number of queried records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001186151632__table6260232102319"></a><a name="table6260232102319"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table6260232102319" frame="border" border="1" rules="all"><caption><b>Table 6 </b>resource</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row1126143282319"><th align="left" class="cellrowborder" valign="top" width="17.45%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p19261632142314"><strong id="EN-US_TOPIC_0000001186151632__b13823851193317">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.67%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p1626133292319"><strong id="EN-US_TOPIC_0000001186151632__b6646028">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.61%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p15261133211234"><strong id="EN-US_TOPIC_0000001186151632__b96737150511371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.27%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p1326183222318"><strong id="EN-US_TOPIC_0000001186151632__b19779253143319">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row426143216234"><td class="cellrowborder" valign="top" width="17.45%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1526110328238">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1126263212319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p42621232132317">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p726214324237">Resource ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row1326293220236"><td class="cellrowborder" valign="top" width="17.45%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p112621332162313">resouce_detail</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1926263220230">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p10262193202310">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p9262133292316">Resource details. The value is a resource object, used for extension. This value is left empty by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row12621332132319"><td class="cellrowborder" valign="top" width="17.45%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1926233242315">tags</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p2026303213237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p82632323235">List&lt;<a href="#EN-US_TOPIC_0000001186151632__table42631432172318">resource_tag</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p72639326236">List of tags. If no tag is matched, an empty array is returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row8263123212314"><td class="cellrowborder" valign="top" width="17.45%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p92634325232">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p8263173272310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p13263103212316">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p5263173232313">Resource name. This parameter is an empty string by default if the resource name is not specified.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001186151632__table42631432172318"></a><a name="table42631432172318"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table42631432172318" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0000001186151632__b535425221">resource_ag</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row1526419329235"><th align="left" class="cellrowborder" valign="top" width="17.7%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001186151632__p426413323232"><strong id="EN-US_TOPIC_0000001186151632__b1655545843318">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.67%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001186151632__p1326423219238"><strong id="EN-US_TOPIC_0000001186151632__b1660443010">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.61%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001186151632__p2264932182314"><strong id="EN-US_TOPIC_0000001186151632__b15986531111371">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.019999999999996%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001186151632__p1526423211231"><strong id="EN-US_TOPIC_0000001186151632__b279056891">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row1826593215239"><td class="cellrowborder" valign="top" width="17.7%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p326519320238">key</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p10265173216230">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p15265153212312">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.019999999999996%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p32651432142320">Tag key. A tag key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. </p>
<p id="EN-US_TOPIC_0000001186151632__p1826511328233">It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row32668329232"><td class="cellrowborder" valign="top" width="17.7%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001186151632__p026613252317">value</p>
</td>
<td class="cellrowborder" valign="top" width="10.67%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1266193202312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001186151632__p1426773219230">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.019999999999996%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001186151632__p1267232192311">Key value. A tag value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section23016560109"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0000001186151632__ul12664145641013"><li id="EN-US_TOPIC_0000001186151632__li3105162417462">Sample request when <strong id="EN-US_TOPIC_0000001186151632__b29775114112928">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b66649438112928">filter</strong><pre class="screen" id="EN-US_TOPIC_0000001186151632__screen189561310164619">POST /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/resource_instances/action
{
"offset": "100",
"limit": "100",
"action": "filter",
"matches":[
{
"key": "resource_name",
"value": "dws"
}
],
"tags": [
{
"key": "Flower",
"values": [
"rose",
"holly"
]
}
],
"tags_any": [
{
"key": "Food",
"values": [
"pie"
]
}
],
"not_tags": [
{
"key": "juice",
"values": [
"Apple"
]
}
],
"not_tags_any": [
{
"key": "color",
"values": [
"Red",
"Green"
]
}
]
}</pre>
</li><li id="EN-US_TOPIC_0000001186151632__li884513517465">Sample request when <strong id="EN-US_TOPIC_0000001186151632__b84235270620353">Action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b84235270620359">count</strong><pre class="screen" id="EN-US_TOPIC_0000001186151632__screen151545248463">POST /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/resource_instances/action
{
"action": "count",
"tags": [
{
"key": "Flower",
"values": [
"rose",
"holly"
]
},
{
"key": "Food",
"values": [
"pie",
"rice"
]
}
],
"tags_any": [
{
"key": "Food",
"values": [
"pie"
]
}
],
"not_tags": [
{
"key": "juice",
"values": [
"apple"
]
}
],
"not_tags_any": [
{
"key": "color",
"values": [
"red",
"green"
]
}
],
"matches":[
{
"key": "resource_name",
"value": "GaussDB(DWS) "
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section5386125681010"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001186151632__p194411114576">Response body when <strong id="EN-US_TOPIC_0000001186151632__b8423527069924">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b8423527069921">filter</strong></p>
<pre class="screen" id="EN-US_TOPIC_0000001186151632__screen149475119577">{
"resources": [
{
"resource_detail": null,
"resource_id": "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90",
"resource_name": "dws-Flower-Food",
"tags": [
{
"key": "Flower",
"value": "rose"
},
{
"key": "Flower",
"value": "holly"
}
]
}
],
"total_count": 1
}</pre>
<p id="EN-US_TOPIC_0000001186151632__p1599011118571">Response body when <strong id="EN-US_TOPIC_0000001186151632__b956271499">action</strong> is set to <strong id="EN-US_TOPIC_0000001186151632__b118589504">count</strong></p>
<pre class="screen" id="EN-US_TOPIC_0000001186151632__screen1799313113577">{
"total_count": 1
}</pre>
<p id="EN-US_TOPIC_0000001186151632__p1541023577"></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001186151632__section342420568103"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001186151632__table1428356201018" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001186151632__row567585671011"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001186151632__p166751856101011"><strong id="EN-US_TOPIC_0000001186151632__b84235270615514">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001186151632__p16754560108"><strong id="EN-US_TOPIC_0000001186151632__b16411914343">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001186151632__row137091937192412"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p77105374241">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p871014375243">Query succeeded.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row1267511564104"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p36751856131012">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1167575612105">Invalid parameter.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row7675856181020"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p1267585621013">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p1367518563103">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row1967517568108"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p16675145671016">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p26751356181014">Insufficient permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row12675175614102"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p367510560107">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p4675175611015">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001186151632__row1867595601010"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001186151632__p15675195612104">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001186151632__p96751856161019">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0045.html">Tag Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink