vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/csbs/api-ref/en-us_topic_0098635092.html
Wei, Hongmin 8ce662c4dc CSBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-24 21:06:50 +00:00

524 lines
37 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0098635092"></a><a name="EN-US_TOPIC_0098635092"></a>
<h1 class="topictitle1">Querying Backup Policies by Tag</h1>
<div id="body1519724141400"><div class="section" id="EN-US_TOPIC_0098635092__section29028938"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0098635092__p33714484">This API is used to filter backup policies by tag.</p>
<p class="msonormal" id="EN-US_TOPIC_0098635092__p34994908">TMS uses this API to filter and list resources of each service by tag. These services must have the query capabilities.</p>
</div>
<div class="section" id="EN-US_TOPIC_0098635092__section59933852"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0098635092__ul16015262"><li id="EN-US_TOPIC_0098635092__li9919636">URI format<p id="EN-US_TOPIC_0098635092__p22167861"><a name="EN-US_TOPIC_0098635092__li9919636"></a><a name="li9919636"></a>POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/resource_instances/action</p>
<p id="EN-US_TOPIC_0098635092__p65293028"></p>
</li><li id="EN-US_TOPIC_0098635092__li50766345">Request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table54243925" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header</caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row52324181"><th align="left" class="cellrowborder" valign="top" width="24.752475247524753%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0098635092__p209623317216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0098635092__p15962193221">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0098635092__p99783315213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0098635092__p6978835213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row15002532"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p7245613">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p1627911256416">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p50023786">MIME type of the body in the request</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p43719714">application/json</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row57933110"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p62070358">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p1425020251411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p61643119">User token</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p42490025">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635092__ul19139995"><li id="EN-US_TOPIC_0098635092__li38042229">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table6835749" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row8975271"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635092__p16705123102410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635092__p970516320249">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635092__p1770515392418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635092__p7705239247">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row15257210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p27874499">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p43241981">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p12939600">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p65779720">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635092__section2533758"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0098635092__ul48818442"><li id="EN-US_TOPIC_0098635092__li36712799">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table61979735" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row56093531"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635092__p81581496248">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635092__p151581499244">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635092__p417319142412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635092__p18173129172411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row25425146"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p46170965">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p48860697">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p65402348">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p15624527153813">List of included tags. Backup resources with these tags will be filtered.</p>
<p id="EN-US_TOPIC_0098635092__p0494199183911">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635092__p646324463913">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635092__p19401115618394">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635092__p1771815924015">Keys in this list are in an AND relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row62104313520"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p54273555474">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p842755513476">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p142795514710">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p1842725544712">List of tags. Backup resources with any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0098635092__p158584245013">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635092__p16591114214506">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635092__p459817429501">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635092__p765214147556">The response returns resources containing any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row34517843"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p175677415716">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p145671340571">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p85673413570">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p115672419576">List of excluded tags. Backup resources without these tags will be filtered.</p>
<p id="EN-US_TOPIC_0098635092__p1199314506578">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635092__p62165145715">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635092__p0111751105713">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635092__p17588613201">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 is in an OR relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row65311975"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p02193547116">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p132193541614">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p62191954011">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p192791022229">List of tags. Backup resources without any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0098635092__p428532217220">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635092__p1229319221525">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635092__p1529610224214">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635092__p43845237217">The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row55515744"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p481433">action</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p38996082">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p4566035">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p34304549">Operation type</p>
<p id="EN-US_TOPIC_0098635092__p64392016184311">Possible values are <strong id="EN-US_TOPIC_0098635092__b842352706194826">filter</strong> and <strong id="EN-US_TOPIC_0098635092__b842352706194830">count</strong>. </p>
<p id="EN-US_TOPIC_0098635092__p40305487"><strong id="EN-US_TOPIC_0098635092__b45514660820229">filter</strong> indicates pagination query and <strong id="EN-US_TOPIC_0098635092__b987992455202243">count</strong> indicates that a specified number of queried records will be returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row27205071"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p56127162">matches</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p50006286">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p23977329">List&lt;match&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p518016559472">List of query criteria supported by resources</p>
<p id="EN-US_TOPIC_0098635092__p17555154424814">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635092__p184835314818">Keys in this list must be unique.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row8643311153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p37522006">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p19383628">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p26570072">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p09225511219">Query count (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635092__b842352706195922">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b842352706195927">count</strong>.)</p>
<p id="EN-US_TOPIC_0098635092__p4692191">If <strong id="EN-US_TOPIC_0098635092__b842352706102324">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b842352706102329">filter</strong>, the value defaults to <strong id="EN-US_TOPIC_0098635092__b842352706102331">1000</strong>. The value ranges from <strong id="EN-US_TOPIC_0098635092__b842352706102340">1</strong> to <strong id="EN-US_TOPIC_0098635092__b842352706102344">1000</strong>. If you set a value out of this range, an error will be reported. The number of returned records does not exceed the value of <strong id="EN-US_TOPIC_0098635092__b842352706194753">limit</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row156741734171519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p65164587">offset</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p43840169">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p61392767">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p177411411197">Query index (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635092__b2040350439">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b623640329">count</strong>.)</p>
<p id="EN-US_TOPIC_0098635092__p14508185131920">If <strong id="EN-US_TOPIC_0098635092__b200691530720216">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b39257038320216">filter</strong>, the value defaults to <strong id="EN-US_TOPIC_0098635092__b163342832120216">0</strong> (minimum value). The first record in the query result is the offset+1 record that meets the query criteria. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li41652709">Parameter description of field <strong id="EN-US_TOPIC_0098635092__b84235270695528">tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table39330064" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635092__b3962144872018">tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row12811779"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0098635092__p127211130248">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0098635092__p1072113131247">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="EN-US_TOPIC_0098635092__p372191312245">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="EN-US_TOPIC_0098635092__p167211113112413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row57097117"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p61463750">key</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p12507852">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p6503062">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p321161514239">Tag key</p>
<p id="EN-US_TOPIC_0098635092__p10460518142315">A tag key consists of up to 127 characters.</p>
<p id="EN-US_TOPIC_0098635092__p1448142852310">A tag key cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635092__p18211830102310">Spaces before and after a key will be deprecated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row43111924"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p2404952">values</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p60583453">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p8312683">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p6635160">List of tag values</p>
<p id="EN-US_TOPIC_0098635092__p2523131132416">The list can contain up to 10 values.</p>
<p id="EN-US_TOPIC_0098635092__p991663534711">A tag value consists of up to 255 characters.</p>
<p id="EN-US_TOPIC_0098635092__p19191952142520">Spaces before and after a key will be deprecated.</p>
<p id="EN-US_TOPIC_0098635092__p1054662113481">Values in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635092__p1539561418287">Values in this list are in an OR relationship.</p>
<p id="EN-US_TOPIC_0098635092__p261532134815">This list can be empty and each value can be an empty character string.</p>
<p id="EN-US_TOPIC_0098635092__p1630812219279">If this list is left blank, it indicates that all values are included.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li58359190">Parameter description of field <strong id="EN-US_TOPIC_0098635092__b1554234495">match</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table55470665" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635092__b15376125172019">match</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row49592727"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0098635092__p0126131752410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0098635092__p2126317112415">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0098635092__p20126117112416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0098635092__p20126141713249">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row31671811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p15279862">key</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p29709347">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p57646896">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p38886981">Tag key</p>
<p id="EN-US_TOPIC_0098635092__p75017351392">Possible values are:</p>
<p id="EN-US_TOPIC_0098635092__p10450046113913"><strong id="EN-US_TOPIC_0098635092__b842352706202849">resource_name</strong>: indicates the resource name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row14438515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635092__p28669032">value</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635092__p40490233">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635092__p58483472">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635092__p1843451574214">Tag value</p>
<p id="EN-US_TOPIC_0098635092__p1830782015424">A tag value consists of up to 255 characters.</p>
<p id="EN-US_TOPIC_0098635092__p32618093">If <strong id="EN-US_TOPIC_0098635092__b842352706203053">key</strong> is set to <strong id="EN-US_TOPIC_0098635092__b842352706203057">resource_name</strong>, an empty character string indicates exact matching and any non-empty string indicates fuzzy matching. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li20322472">Example request<pre class="screen" id="EN-US_TOPIC_0098635092__screen18793121803111">POST https://{endpoint}/v1/{project_id}/csbs_backup_policy/resource_instances/action</pre>
</li></ul>
<ul id="EN-US_TOPIC_0098635092__ul35507512"><li id="EN-US_TOPIC_0098635092__li51132157">When <strong id="EN-US_TOPIC_0098635092__b842352706203143">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b842352706203145">filter</strong>:<pre class="screen" id="EN-US_TOPIC_0098635092__screen14881429113118">{
"offset": "100",
"limit": "100",
"action": "filter",
"matches": [{
"key": "resource_name",
"value": "resource1"
}
],
"not_tags": [{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
],
"tags": [{
"key": "key1",
"values": [
"*value1",
"value2"
]
}
],
"tags_any": [{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"not_tags_any": [{
"key": "key1",
"values": [
"value1",
"value2"
]
}
]
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0098635092__ul33389269"><li id="EN-US_TOPIC_0098635092__li32067967">When <strong id="EN-US_TOPIC_0098635092__b1960273671">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b1829200017">count</strong>:<pre class="screen" id="EN-US_TOPIC_0098635092__screen2432164117314">{
"action": "count",
"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"
]
}
],
"matches": [{
"key": "resource_name",
"value": "resource1"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635092__section22803825"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0098635092__ul51450089"><li id="EN-US_TOPIC_0098635092__li60397618">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table61958854" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row41454307"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0098635092__p659652316249">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0098635092__p10611523162414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0098635092__p176111723192417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row13864738"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p49301983">resources</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p34037668">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p2384185575515">List of matched resources (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635092__b1490585245">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b123793049">count</strong>.)</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row50289647"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p46929584">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p43199991">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p9538345">Total number of matched resources</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635092__ul45150812"><li id="EN-US_TOPIC_0098635092__li3704125">Parameter description of field <strong id="EN-US_TOPIC_0098635092__b7642103510720">resource</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table12686464" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635092__b12386195442012">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row15160332"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.4.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0098635092__p1670573119241">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.4.3.1.2.2.4.1.2"><p id="EN-US_TOPIC_0098635092__p872083182414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.33%" id="mcps1.3.4.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0098635092__p14720163142419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row22103973"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p45591407">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p1916477">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p21016952">Resource ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row54934841"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p20537154">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p52896747">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p56778076">Resource details</p>
<p id="EN-US_TOPIC_0098635092__p1734411441237">The returned value is an empty dictionary.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row41240639"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p52157488">tags</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p64007038">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p17187600">Tag list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row20470679"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p47512266">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p23288375">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p7310212">Resource name</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li49756506">Parameter description of field <strong id="EN-US_TOPIC_0098635092__b235793912">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table55256281" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635092__b185016558203">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635092__row23988764"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.4.3.2.2.2.4.1.1"><p id="EN-US_TOPIC_0098635092__p6784194112249">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.4.3.2.2.2.4.1.2"><p id="EN-US_TOPIC_0098635092__p17981441142419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.33%" id="mcps1.3.4.3.2.2.2.4.1.3"><p id="EN-US_TOPIC_0098635092__p1179884116241">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row24665405"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p51740790">key</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p30254496">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0098635092__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0098635092__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635092__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row43820797"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635092__p59823639">value</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635092__p13876573">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635092__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0098635092__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0098635092__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0098635092__p92562414333">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li52419647">Example response<p id="EN-US_TOPIC_0098635092__p2014776"><a name="EN-US_TOPIC_0098635092__li52419647"></a><a name="li52419647"></a>When <strong id="EN-US_TOPIC_0098635092__b589229367">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b1956714149">filter</strong>:</p>
<pre class="screen" id="EN-US_TOPIC_0098635092__screen269714538315">{
"resources": [
{
"resource_detail": {},
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resouece1",
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}
],
"total_count": 1000
}</pre>
<p class="litext" id="EN-US_TOPIC_0098635092__p62415984">When <strong id="EN-US_TOPIC_0098635092__b1252225358">action</strong> is set to <strong id="EN-US_TOPIC_0098635092__b1472974022">count</strong>:</p>
<pre class="screen" id="EN-US_TOPIC_0098635092__screen1161513312327">{
"total_count": 1000
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635092__section3907839"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0098635092__ul6824202"><li id="EN-US_TOPIC_0098635092__li61417826">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table15889527" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635092__row11673575"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0098635092__p6035484">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0098635092__p19112173">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row4582212"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p35614854">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p66230941">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635092__li59207564">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635092__table63106033" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635092__row61389792"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0098635092__p6517283">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0098635092__p58137894">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635092__row11548945"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p63049357">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p6724289">Invalid parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row60518608"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p3060236">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p46552597">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row16320194"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p46867304">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p38155279">You do not have permission to perform this operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row7853194"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p32128981">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p52310644">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635092__row1033751"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635092__p16624976">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635092__p4445777">A system exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635092__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0098635092__p999593594811">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0098466174.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink