vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0102606095.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

325 lines
28 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0102606095"></a><a name="EN-US_TOPIC_0102606095"></a>
<h1 class="topictitle1">Querying ECSs by Tag</h1>
<div id="body1521516697550"><div class="section" id="EN-US_TOPIC_0102606095__section192222559445"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0102606095__p744835953817">This API is used to filter ECSs by tag and obtain all tags of an ECS.</p>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__section222245513448"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0102606095__p184216313422">POST /v1/{project_id}/servers/resource_instances/action</p>
<div class="p" id="EN-US_TOPIC_0102606095__p320114984714"><a href="#EN-US_TOPIC_0102606095__table10820175118131">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table10820175118131"></a><a name="table10820175118131"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table10820175118131" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row6820451111313"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0102606095__p7707213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0102606095__p20304554">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0102606095__p34056167">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row8820105181314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p13820135131314">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p1582019513134">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p37593705">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__section625475584419"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0102606095__p20472123213484"><a href="#EN-US_TOPIC_0102606095__table195321356132718">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table195321356132718"></a><a name="table195321356132718"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table195321356132718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row853265613272"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0102606095__p1056061015287">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0102606095__p1560121010281">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.881188118811881%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0102606095__p7560111010289">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.415841584158414%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0102606095__p155602108289">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row253218562271"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p2935154611287">tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p15935104652818">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p1393513463287">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p195139416412">Displays the ECSs with all the specified tags. For details, see <a href="#EN-US_TOPIC_0102606095__table8638721112919">Table 3</a>.</p>
<ul id="EN-US_TOPIC_0102606095__ul729224164518"><li id="EN-US_TOPIC_0102606095__li2029034144517">The structure body must be included.</li><li id="EN-US_TOPIC_0102606095__li32914414458">This field cannot be left blank.</li><li id="EN-US_TOPIC_0102606095__li152917484515">A key must be unique.</li><li id="EN-US_TOPIC_0102606095__li1529110414513">Values of the same key must be unique.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row16532105622710"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p39350465287">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1293594692811">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p4935104652820">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p381210017461">Displays the ECSs with none of specified tags.</p>
<ul id="EN-US_TOPIC_0102606095__ul7618171794619"><li id="EN-US_TOPIC_0102606095__li2061821720468">The structure body must be included.</li><li id="EN-US_TOPIC_0102606095__li20618101710463">This field cannot be left blank.</li><li id="EN-US_TOPIC_0102606095__li961881704613">Keys must be unique.</li><li id="EN-US_TOPIC_0102606095__li161861744612">Values of the same key must be unique.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row353275611277"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p7935104619282">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p99356465280">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p209356461287">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p9200250164913">Limits the maximum number of queried ECSs. The value cannot be a negative number. The maximum value is 1,000.</p>
<ul id="EN-US_TOPIC_0102606095__ul1965214204415"><li id="EN-US_TOPIC_0102606095__li176521120344">If the <strong id="EN-US_TOPIC_0102606095__b842352706152943">action</strong> value is <strong id="EN-US_TOPIC_0102606095__b842352706152951">count</strong>, this parameter is invalid.</li><li id="EN-US_TOPIC_0102606095__li166529201741">If the <strong id="EN-US_TOPIC_0102606095__b12873725315307">action</strong> value is <strong id="EN-US_TOPIC_0102606095__b842352706153013">filter</strong>, the default value is <strong id="EN-US_TOPIC_0102606095__b842352706153021">1,000</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row11532135672711"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p13935134652817">offset</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1193504662816">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p149356468287">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p983884517508">Specifies index position. The query starts from the next piece of data indexed by this parameter. The value must be a number and cannot be a negative number.</p>
<p id="EN-US_TOPIC_0102606095__p17231571749">This parameter is not required when data on the first page is queried. When you query the subsequent page data, the value in the response body for the query of the data on the previous page is contained in this parameter.</p>
<ul id="EN-US_TOPIC_0102606095__ul129511127259"><li id="EN-US_TOPIC_0102606095__li39520271254">If the <strong id="EN-US_TOPIC_0102606095__b416635222216">action</strong> value is <strong id="EN-US_TOPIC_0102606095__b4166652152214">count</strong>, this parameter is invalid.</li><li id="EN-US_TOPIC_0102606095__li189551327757">If the <strong id="EN-US_TOPIC_0102606095__b19166952102210">action</strong> value is <strong id="EN-US_TOPIC_0102606095__b18166175262219">filter</strong>, the default value is <strong id="EN-US_TOPIC_0102606095__b13166105215220">0</strong>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row1753216566272"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p119356466289">action</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1693564642816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p18935946142810">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p1059442911610">Specifies the operation, which can be <strong id="EN-US_TOPIC_0102606095__b842352706154359">filter</strong> or <strong id="EN-US_TOPIC_0102606095__b84235270615449">count</strong>.</p>
<ul id="EN-US_TOPIC_0102606095__ul535538994"><li id="EN-US_TOPIC_0102606095__li15355381695"><strong id="EN-US_TOPIC_0102606095__b842352706154442">filter</strong>: filters ECSs by tag. The ECSs that meet the filter criteria are displayed on pages.</li><li id="EN-US_TOPIC_0102606095__li14351838996"><strong id="EN-US_TOPIC_0102606095__b0167155232219">count</strong>: searches ECSs by tag. The number of ECSs that meet the search criteria is displayed.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row13532105610278"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p119351146112813">matches</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1793524611285">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p1935154617285">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p1551843115315">Specifies the search field, which is used to search for ECSs.</p>
<p id="EN-US_TOPIC_0102606095__p282282115537">Currently, only <strong id="EN-US_TOPIC_0102606095__b842352706154915">resource_name</strong> can be used for search. For more information, see <a href="#EN-US_TOPIC_0102606095__table2075564419352">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table8638721112919"></a><a name="table8638721112919"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table8638721112919" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0102606095__b84235270695528">tag</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row9638182192913"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0102606095__p204899510491">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0102606095__p1248914564918">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0102606095__p1489951499">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0102606095__p1748911534916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row9638192152914"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p116841114123415">key</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1468491415348">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p1768410144344">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p10615125010247">Specifies the tag key.</p>
<ul id="EN-US_TOPIC_0102606095__ul936813598244"><li id="EN-US_TOPIC_0102606095__li03679594243">A key contains a maximum of 127 Unicode characters.</li><li id="EN-US_TOPIC_0102606095__li5368175952417">This field cannot be left blank.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row46381021162912"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p186841314123420">values</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1868481433415">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p068416140344">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p28141320102512">Specifies the tag value.</p>
<ul id="EN-US_TOPIC_0102606095__ul122717438253"><li id="EN-US_TOPIC_0102606095__li12227174318257">Values of the same tag must be unique.</li><li id="EN-US_TOPIC_0102606095__li1822712439258">Each value contains a maximum of 255 Unicode characters.</li><li id="EN-US_TOPIC_0102606095__li7227134319256">If this parameter is not specified, any value can be used.</li><li id="EN-US_TOPIC_0102606095__li122271343112515">The values are in the OR relationship.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table2075564419352"></a><a name="table2075564419352"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table2075564419352" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0102606095__b1768016180423">match</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row475516447358"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0102606095__p12281103495">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0102606095__p544210184910">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0102606095__p174410100492">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0102606095__p844161094910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row075574413352"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p17380257143511">key</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p16380115718352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p193801579351">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p23438378275">Specifies the key field to be matched.</p>
<p id="EN-US_TOPIC_0102606095__p1047715257337">The tag key can only be <strong id="EN-US_TOPIC_0102606095__b842352706172034">resource_name</strong>. In such a case, the tag value is the ECS name.</p>
<ul id="EN-US_TOPIC_0102606095__ul1846525352715"><li id="EN-US_TOPIC_0102606095__li143776578115">The key must be unique, and the value is used for matching.</li><li id="EN-US_TOPIC_0102606095__li337711571114">This field is a fixed dictionary value.</li><li id="EN-US_TOPIC_0102606095__li14651653132716">This field cannot be left blank.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row19755194423519"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0102606095__p9380145713514">value</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0102606095__p1380145711359">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0102606095__p43801857183518">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0102606095__p1214175622714">Specifies the tag value.</p>
<p id="EN-US_TOPIC_0102606095__p14759181015343">The tag key can only be <strong id="EN-US_TOPIC_0102606095__b817085218225">resource_name</strong>. In such a case, the tag value is the ECS name.</p>
<ul id="EN-US_TOPIC_0102606095__ul167323292812"><li id="EN-US_TOPIC_0102606095__li1273215211282">Each value contains a maximum of 255 Unicode characters.</li><li id="EN-US_TOPIC_0102606095__li873216202815">This field cannot be left blank.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__section1825415515447"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0102606095__p189057535018"><a href="#EN-US_TOPIC_0102606095__table725495518449">Table 5</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table725495518449"></a><a name="table725495518449"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table725495518449" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row3363185511442"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0102606095__p15806308">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0102606095__p21995508">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.29702970297029%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0102606095__p36805753">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row4363105574411"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p13910142415446">resources</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p17910924114410">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="70.29702970297029%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p17910202454413">Specifies returned ECSs. For details, see <a href="#EN-US_TOPIC_0102606095__table790793515528">Table 6</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row13254131794410"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p189108241448">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p3910224134420">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="70.29702970297029%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p1891052414418">Specifies the total number of queried ECSs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0102606095__table790793515528"></a><a name="table790793515528"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table790793515528" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0102606095__b7642103510720">resource</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row1790773517524"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0102606095__p163537196379">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0102606095__p4367119113715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0102606095__p143671019113713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row189071535205220"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p74711505311">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p12476517531">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p134795115319">Specifies the ECS ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row690773585214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p84715165315">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p15475545313">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p2473535313">Queries ECS details.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row1907113516524"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p1647195105319">tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p154765195313">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p447205175313">Specifies tags.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row129076356521"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p64735205317">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p194725135314">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p1847205115317">Specifies the resource name, which is the ECS name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102606095__table173144214534" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0102606095__b343081832">resource_tag</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0102606095__row3314621125312"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0102606095__p1265913224374">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0102606095__p186591522143716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0102606095__p2659182283715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102606095__row1431416211537"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p159081145185319">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p1290844513537">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p789502782812">Specifies the tag key.</p>
<ul id="EN-US_TOPIC_0102606095__ul5216143772810"><li id="EN-US_TOPIC_0102606095__li821603715282">It contains a maximum of 36 Unicode characters.</li><li id="EN-US_TOPIC_0102606095__li9216937152811">This field cannot be left blank.</li><li id="EN-US_TOPIC_0102606095__li102161037182819">Can only consist of digits, letters, hyphens (-), and underscores (_).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0102606095__row931452113533"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0102606095__p09082453534">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0102606095__p1790854513539">String</p>
</td>
<td class="cellrowborder" valign="top" width="71%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0102606095__p9585104018283">Specifies the tag value.</p>
<ul id="EN-US_TOPIC_0102606095__ul1285455122812"><li id="EN-US_TOPIC_0102606095__li1585415110283">Each value contains a maximum of 43 Unicode characters.</li><li id="EN-US_TOPIC_0102606095__li48540517284">This field can be left blank.</li><li id="EN-US_TOPIC_0102606095__li9854551102813">Can only consist of digits, letters, hyphens (-), and underscores (_).</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__section192136383502"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0102606095__screen793820163497">POST https://{endpoint}/v1/{project_id}/servers/resource_instances/action
{
"offset": "100",
"limit": "100",
"action": "filter",
"matches":[
{
"key": "resource_name",
"value": "ecs_test"
}],
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__section116031944014"><h4 class="sectiontitle">Example Response</h4><ul id="EN-US_TOPIC_0102606095__ul362616910403"><li id="EN-US_TOPIC_0102606095__li146265934011">Response body when <strong id="EN-US_TOPIC_0102606095__b8423527069924">action</strong> is set to <strong id="EN-US_TOPIC_0102606095__b8423527069921">filter</strong><pre class="screen" id="EN-US_TOPIC_0102606095__screen46262914012">{
"resources": [
{
"resource_detail": null,
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "ecs_test",
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}
],
"total_count": 1000
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0102606095__ul26262917402"><li id="EN-US_TOPIC_0102606095__li146261391406">Response body when <strong id="EN-US_TOPIC_0102606095__b669180287">action</strong> is set to <strong id="EN-US_TOPIC_0102606095__b618833064">count</strong><pre class="screen" id="EN-US_TOPIC_0102606095__screen116261295406">{
"total_count": 1000
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__en-us_topic_0092803065_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0102606095__en-us_topic_0092803065_en-us_topic_0020212692_p23670760">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0102606095__en-us_topic_0092803065_en-us_topic_0067161469_en-us_topic_0057973179_section23611955"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0102606095__p7233105282813">See <a href="en-us_topic_0022067717.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0108433461.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink