forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
421 lines
30 KiB
HTML
421 lines
30 KiB
HTML
<a name="mrs_02_0076"></a><a name="mrs_02_0076"></a>
|
|
|
|
<h1 class="topictitle1">Querying a List of Clusters with Specified Tags</h1>
|
|
<div id="body8662426"><div class="section" id="mrs_02_0076__s975f80145897467fbf42c1c56b6f2c1a"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0076__en-us_topic_0110707086_p74931331623">This API is used to filter clusters by tag.</p>
|
|
<p id="mrs_02_0076__a7a6803a17af94c1692199ec365bdead7">By default, clusters and tags are sorted in descending order of creation time.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0076__s12a41512711844f69adab29fde692b19"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0076__ul3299804811311"><li id="mrs_02_0076__li3701617811311">Format<p id="mrs_02_0076__p23636357575"><a name="mrs_02_0076__li3701617811311"></a><a name="li3701617811311"></a>POST /v1.1/{project_id}/clusters/resource_instances/action</p>
|
|
</li><li id="mrs_02_0076__li29511803172648">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__td6df3112b0d041f6918c19cbb2a9e47f" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0076__r8ace0f816c4946d3b1207ce91e8deb96"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0076__a6c3e03563d5847089614adcfebfeeaf3"><strong id="mrs_02_0076__b1932805122515">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0076__en-us_topic_0110707086_p388412816227"><strong id="mrs_02_0076__b369513153254">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0076__afa14c87427234bd08c0662ed5b71bd1e"><strong id="mrs_02_0076__b72891534122514">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__r0358327852bf48adae268af0444ee1e8"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0076__aad2ee153ccb44e60a057bfb5e1ed115f">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0076__a18f009f2775e4efd952b766fbe963474">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0076__a71ac2c0980594830976a312e3291a220">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0076__s5b360e3dcff844d6b64a41875596f7f0"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__t28dba73d72a94b648ef5179a95eb71f6" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="mrs_02_0076__re9f5c9bc8f3743519030bc48bfc37db1"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.5.1.1"><p id="mrs_02_0076__a82ae57ba67244665a7cfdcea834b164a">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.2"><p id="mrs_02_0076__en-us_topic_0110707086_p359718019240"><strong id="mrs_02_0076__b1971344193217">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.3"><p id="mrs_02_0076__en-us_topic_0110707086_p35978012418"><strong id="mrs_02_0076__b10672248183215">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="mrs_02_0076__a0ae1fb86756645718a06e417f8758f4c"><strong id="mrs_02_0076__b139905333210">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__r9cedbfdb1a9b48a5b3b217b3fe2cd4aa"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__p1575715772816">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__p7758165732819">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__p275835732812">List<tag></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__p4758257172813">The return result contains resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row17786165614171"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__p16656934491">tags_any</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__p5656734297">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__p1552517316103">List<tag></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__p8656153420912">The return result contains resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row1829235651717"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__p89561301799">not_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__p49567301595">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__p555763231010">List<tag></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__p16956230793">The return result does not contain resources corresponding to all tags in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row15171115419176"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__p1384616271395">not_tags_any</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__p6846102716912">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__p143919332103">List<tag></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__p784672718910">The return result does not contain resources corresponding to any tag in this parameter. This parameter contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__rfbb78dcf8ecd4667b5f07d598200d1e7"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__a41e699634a244ace97e50a978466453c">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__aa2bf2615678546ec93ced4cef7c1e1c9">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__a49a6fff13e5a4735a943b404d000c21a">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__aa575c1d4ec3a4922be9f3509ac5ea303">Number of records. This parameter is not available when <strong id="mrs_02_0076__b842352706112419">action</strong> is set to <strong id="mrs_02_0076__b842352706112428">count</strong>. The default value is <strong id="mrs_02_0076__b842352706112654">1000</strong> when <strong id="mrs_02_0076__b39236199214364">action</strong> is set to <strong id="mrs_02_0076__b132640505514364">filter</strong>. The maximum value is <strong id="mrs_02_0076__b842352706112658">1000</strong>, and the minimum value is <strong id="mrs_02_0076__b842352706112710">1</strong>. The value cannot be a negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__r03cbf29cf4d94468b2d1e8f5f40b5e42"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__en-us_topic_0110707086_p027813183295">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__ac6b11491637a40908b18d3206083aa16">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__aa50fcceb99d14612be145b78439bc9f0">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__a30af70e2c44d4463a61badbe9e3267f7">Index position. The query starts from the next piece of data specified by the <strong id="mrs_02_0076__b1681212791610">offset</strong> parameter. This parameter is not required when you query data on the first page. The value in the response body returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when <strong id="mrs_02_0076__b84235270621521">action</strong> is set to <strong id="mrs_02_0076__b84235270621525">count</strong>. If <strong id="mrs_02_0076__b84235270621528">action</strong> is set to <strong id="mrs_02_0076__b84235270621532">filter</strong>, the value must be a number, and the default value is <strong id="mrs_02_0076__b84235270621539">0</strong>. The value cannot be a negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__refddb3f568b342778ceb773210c8cf0a"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__en-us_topic_0110707086_p928051819292">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__a422491cd50f44313828ba719f584f78a">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__en-us_topic_0110707086_p628011814294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__en-us_topic_0110707086_p228061852911">Operation to be performed. The value can be <strong id="mrs_02_0076__b84235270616546">filter</strong> or <strong id="mrs_02_0076__b84235270616552">count</strong>.</p>
|
|
<p id="mrs_02_0076__aa6c2ff26ee0b4cb282492af848e0781a">The value <strong id="mrs_02_0076__b842352706112921">filter</strong> indicates pagination query. The value <strong id="mrs_02_0076__b84235270611312">count</strong> indicates that the total number of query results meeting the search criteria will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__r0a8e02970a3a42569bf5508f8e4c30c8"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0076__af6f197f69f414002b339ede74a89154f">matches</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0076__a58910123e42f4369ae069f346ccb920b">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0076__en-us_topic_0110707086_p428031819290">List<match></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0076__af5f4f778b50f4beebf058e7b63666e68">Search field. <strong id="mrs_02_0076__b139191241144216">key</strong> indicates the field to be matched, for example, <strong id="mrs_02_0076__b1815994217155439">resource_name</strong>. <strong id="mrs_02_0076__b383113710436">value</strong> indicates the matched value. This field is a fixed dictionary value.</p>
|
|
<p id="mrs_02_0076__en-us_topic_0110707086_p152805187296">Determine whether fuzzy match is required based on different fields. For example, if <strong id="mrs_02_0076__b8423527062245">key</strong> is <strong id="mrs_02_0076__b842352706123028">resource_name</strong>, fuzzy search is used by default. If <strong id="mrs_02_0076__b842352706123110">value</strong> is an empty string, exact match is used.</p>
|
|
<p id="mrs_02_0076__en-us_topic_0110707086_p32803185293"></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__t7c877f5edc884ebdaa77ed73c072ffc1" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="mrs_02_0076__b84235270695528">tag</strong> field description</caption><thead align="left"><tr id="mrs_02_0076__r994b292f5cb0404d9ebd6c59c2f15010"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.1"><p id="mrs_02_0076__en-us_topic_0110707086_p965615311307"><strong id="mrs_02_0076__b8918258192612">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.3.2.5.1.2"><p id="mrs_02_0076__en-us_topic_0110707086_p26567318304"><strong id="mrs_02_0076__b193341010102713">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.3.2.5.1.3"><p id="mrs_02_0076__ade84da15268449538e4df4912656b3c7"><strong id="mrs_02_0076__b161912179279">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.3.2.5.1.4"><p id="mrs_02_0076__en-us_topic_0110707086_p56560393020"><strong id="mrs_02_0076__b2051530122714">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__rfef7dd2f989442d79e1801ca89dba6d8"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="mrs_02_0076__en-us_topic_0110707086_p156565383013">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.3.2.5.1.2 "><p id="mrs_02_0076__a653a141d1b7d4c42a3e2becac09ec526">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.3.2.5.1.3 "><p id="mrs_02_0076__en-us_topic_0110707086_p665653123011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.3.2.5.1.4 "><p id="mrs_02_0076__a1772baac039a48a6a7a82876b2403c71">Key. It contains a maximum of 127 Unicode characters. It cannot be left empty. (This parameter is not verified in the search process.)</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__r01f35d83609f44a8b7ccdd8b36ed4310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="mrs_02_0076__en-us_topic_0110707086_p56577317309">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.3.2.5.1.2 "><p id="mrs_02_0076__en-us_topic_0110707086_p765720363016">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.3.2.5.1.3 "><p id="mrs_02_0076__ad74c05f569ea46189263174d3c05d656">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.3.2.5.1.4 "><p id="mrs_02_0076__en-us_topic_0110707086_p265773143019">List of values. A value contains a maximum of 255 Unicode characters.</p>
|
|
<p id="mrs_02_0076__en-us_topic_0110707086_p176579314309">If the values are null, it indicates <strong id="mrs_02_0076__b842352706175623">any_value</strong>. The relationship between values is OR. By default, only the first value is used for search.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__tf07fcd1f07994fc099e990a2aafead97" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="mrs_02_0076__b165401314114617">match</strong> field description</caption><thead align="left"><tr id="mrs_02_0076__ra306570ff3de452ba10d15a70009db1b"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="mrs_02_0076__en-us_topic_0110707086_p156795563011"><strong id="mrs_02_0076__b1518515122719">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.4.2.5.1.2"><p id="mrs_02_0076__en-us_topic_0110707086_p056719556302"><strong id="mrs_02_0076__b47461914112719">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.4.2.5.1.3"><p id="mrs_02_0076__en-us_topic_0110707086_p175678554306"><strong id="mrs_02_0076__b3680522142713">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.4.2.5.1.4"><p id="mrs_02_0076__aec862b3585134e4fbd90de25f3525d66"><strong id="mrs_02_0076__b94126336273">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__rc0a202d941f041508ec064469f49198d"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="mrs_02_0076__en-us_topic_0110707086_p856713553306">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.2 "><p id="mrs_02_0076__en-us_topic_0110707086_p356905583013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.3 "><p id="mrs_02_0076__ab6f5eb5e96f34c83a93e25f6ea580545">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.2.5.1.4 "><p id="mrs_02_0076__a5beefb9a59ab4a5ea6caffbfada8ee60">Key. The value is fixed to <strong id="mrs_02_0076__b3320648193614">resource_name</strong>, indicating a cluster name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__r08e5024ddf464d7485053af2f0a9b711"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="mrs_02_0076__a229a24249194411fbfc866d33563e4ff">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.2 "><p id="mrs_02_0076__a0adbf3da2e604c3887bb77f1eaf9d3a8">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.4.2.5.1.3 "><p id="mrs_02_0076__aeb53bbc0ff494aecb0c27c7d978c8208">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.4.2.5.1.4 "><p id="mrs_02_0076__a8aaf951ed75a4118b11ec420947cc370">Value. A value contains a maximum of 64 Unicode characters. Enter a cluster name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0076__s2040a1585bda451d81def621572c0b17"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__table95690185369" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0076__row8575818193612"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0076__p4575181853612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.91%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0076__p145751818123617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.09%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0076__p25761518193614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__row1057791893611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0076__p1414612262381">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.91%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0076__p16204192543610">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.09%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0076__p1620522520368">Resource details. For details, see <a href="#mrs_02_0076__table5936005416">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row1628917719528"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0076__p192903775218">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.91%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0076__en-us_topic_0172486173_a3ecf064ee466445781aeb1a335395cba">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.09%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0076__p829016714520">Total number of resources.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0076__table5936005416"></a><a name="table5936005416"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__table5936005416" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="mrs_02_0076__b115151744152717">resources</strong> parameters</caption><thead align="left"><tr id="mrs_02_0076__row99312025417"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="mrs_02_0076__p69312085417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="mrs_02_0076__p39310115412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="mrs_02_0076__p693606542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__row11931707545"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0076__p1444162175613">resource_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0076__p1693190195410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0076__p11938075412">Resource details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row1393100115418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0076__p1669702885619">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0076__p2094170125410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0076__p14942013541">Resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row19456158125415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0076__p566313345565">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0076__p13457138135415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0076__p124574814540">Resource name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row2626182548"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0076__p19219041105619">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0076__p10627148195412">objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0076__p36279865413">Tag list. For details, see <a href="#mrs_02_0076__table1897413881916">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0076__table1897413881916"></a><a name="table1897413881916"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__table1897413881916" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="mrs_02_0076__b15397123517286">tags</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0076__row119761638141911"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="mrs_02_0076__p12976163881914"><strong id="mrs_02_0076__b10495131214258">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="mrs_02_0076__p149764384199"><strong id="mrs_02_0076__b66182710275">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="mrs_02_0076__p1297663891913"><strong id="mrs_02_0076__b11871506817">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__row109791438171912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0076__p79795386197">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0076__p597912387197">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0076__p797912380198">Key. A tag key can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0076__row1198017388192"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0076__p109806384196">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0076__p12980438111912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0076__p898083871913">Tag value. A tag value can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0076__se3cbf579c5644af99fea81d2f4ed375c"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0076__u874b5f09e39d43eea793cba7e1c2195a"><li id="mrs_02_0076__l7319babbb17b4641aa932ed0c41fd469">Example request<p id="mrs_02_0076__en-us_topic_0110707086_p281651143111"><a name="mrs_02_0076__l7319babbb17b4641aa932ed0c41fd469"></a><a name="l7319babbb17b4641aa932ed0c41fd469"></a>Request body when <strong id="mrs_02_0076__b19782195104912">action</strong> is set to <strong id="mrs_02_0076__b137828584920">filter</strong></p>
|
|
<pre class="screen" id="mrs_02_0076__screen3537194103219">{
|
|
"offset": "100",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"matches":[
|
|
{
|
|
"key": "resource_name",
|
|
"value": "clusterA"
|
|
}
|
|
],
|
|
"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>
|
|
<p id="mrs_02_0076__a529fd07c91b048349b35fe5d1800075e">Request body when <strong id="mrs_02_0076__b842352706124239">action</strong> is set to <strong id="mrs_02_0076__b842352706124243">count</strong></p>
|
|
<pre class="screen" id="mrs_02_0076__screen14621145723216">{
|
|
"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": "clusterA"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="mrs_02_0076__ua1c53df5d63b467aa31ca9de63d3e83f"><li id="mrs_02_0076__lbc512f7f16a34626a8840a408907f43e">Example response<p id="mrs_02_0076__en-us_topic_0110707086_p217811269346"><a name="mrs_02_0076__lbc512f7f16a34626a8840a408907f43e"></a><a name="lbc512f7f16a34626a8840a408907f43e"></a>Response body when <strong id="mrs_02_0076__b8423527069924">action</strong> is set to <strong id="mrs_02_0076__b8423527069921">filter</strong></p>
|
|
<pre class="screen" id="mrs_02_0076__s134522939c574dedb1cd652925147be5"> {
|
|
"resources": [
|
|
{
|
|
"resource_detail": null,
|
|
"resource_id": "cdfs_cefs_wesas_12_dsad",
|
|
"resource_name": "clusterA"
|
|
}
|
|
]
|
|
"total_count": 1000
|
|
}</pre>
|
|
<p id="mrs_02_0076__a3d9cea6f2c3441388ce6f35f19f58031">Response body when <strong id="mrs_02_0076__b842352706203143">action</strong> is set to <strong id="mrs_02_0076__b842352706203145">count</strong></p>
|
|
<pre class="screen" id="mrs_02_0076__sb8ab0bf683eb4a3eb5a154f12ea12059">{
|
|
"total_count": 1000
|
|
}</pre>
|
|
</li></ul>
|
|
<p id="mrs_02_0076__ad2d4dc6942d5462a8cb250f2b2a38e44"></p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0076__s48bb8c114a1e4e77b89ba12806974365"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0076__abe2af0547c4a42a998f02283d0f74f6e"><a href="#mrs_02_0076__t31bfd33136f84cd88b311dc479046586">Table 8</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0076__t31bfd33136f84cd88b311dc479046586"></a><a name="t31bfd33136f84cd88b311dc479046586"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0076__t31bfd33136f84cd88b311dc479046586" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status code</caption><thead align="left"><tr id="mrs_02_0076__ra0a28b8e4bfb49cb90d4029a28a701a3"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0076__a077251d86ed84b13b556d282dc52fdea"><strong id="mrs_02_0076__b107830476819">Status Code</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0076__ac2051ec31a884ffd9508519c0b28911e"><strong id="mrs_02_0076__b1894705219">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0076__rc843f429b9f94186af21f19586b767cf"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0076__a9470033483954e6cb4abd85311e7547f">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0076__en-us_topic_0110707086_p39771881331">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0070.html">Tag Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|