vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vbs/api-ref/en-us_topic_0067142133.html
Wei, Hongmin 63123ef1be VBS 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-25 07:47:39 +00:00

431 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0067142133"></a><a name="EN-US_TOPIC_0067142133"></a>
<h1 class="topictitle1">Querying Backup Policies by Tag</h1>
<div id="body1500448542447"><div class="section" id="EN-US_TOPIC_0067142133__section63962185"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0067142133__p23236933">This API is used to query backup policies by tag.</p>
</div>
<div class="section" id="EN-US_TOPIC_0067142133__section38788755"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0067142133__ul3143429"><li id="EN-US_TOPIC_0067142133__li28290863">URI format<p id="EN-US_TOPIC_0067142133__p9858548"><a name="EN-US_TOPIC_0067142133__li28290863"></a><a name="li28290863"></a>POST /v2/{project_id}/backuppolicy/resource_instances/action</p>
</li><li id="EN-US_TOPIC_0067142133__li21618074">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142133__table60344938" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142133__row59011071"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="EN-US_TOPIC_0067142133__p15167431">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="EN-US_TOPIC_0067142133__p20602375">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="EN-US_TOPIC_0067142133__p58179688">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142133__row14934289"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p1717931">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p4934750">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142133__section13554483"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0067142133__ul104038331816"><li id="EN-US_TOPIC_0067142133__li1440316331584">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142133__table55298598184810" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142133__row13717697184810"><th align="left" class="cellrowborder" valign="top" width="20.3%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0067142133__p1431817452527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.900000000000002%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0067142133__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0067142133__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.32%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0067142133__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142133__row669026184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p54191158184810">tags</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p27407641184810">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p5426486184810">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p36892211184810">List of tags. Backup policies with these tags will be filtered. This list can have a maximum of 10 tags.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row63594445184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p50876414184810">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p27348835184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p663140184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p53714411184810">Tag key. Tag keys must be unique.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row13667651184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p33337931184810">values</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p16017867184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p22378860184810">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p748373184810">List of tag values. This list can have a maximum of 10 tag values and these values must be unique.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row6735365184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p8693678184810">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p33099316184810">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p63798910184810">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p1842725544712">List of tags. Backups with any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0067142133__p158584245013">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0067142133__p16591114214506">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0067142133__p459817429501">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0067142133__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_0067142133__row2962844184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p38663808184810">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p44760773184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p1744019184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p7047825184810">Tag key</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row63430425184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p37590819184810">values</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p24957489184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p8290732184810">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p460667184810">List of tag values</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row4146006184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p282175184810">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p22856176184810">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p39410962184810">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p115672419576">List of excluded tags. Backups without these tags will be filtered.</p>
<p id="EN-US_TOPIC_0067142133__p1199314506578">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0067142133__p62165145715">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0067142133__p0111751105713">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0067142133__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_0067142133__row7997746184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p43837700184810">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p61192835184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p57672598184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p40968870184810">Tag key</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row33175512184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p2861933184810">values</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p30490035184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p53773777184810">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p60708720184810">List of tag values</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row9507576184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p31916154184810">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p35071697184810">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p22235237184810">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p192791022229">List of tags. Backups without any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0067142133__p428532217220">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0067142133__p1229319221525">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0067142133__p1529610224214">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0067142133__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_0067142133__row36251914184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p50723956184810">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p14999799184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p7024186184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p32088165184810">Tag key</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row20358033184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p38388013184810">values</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p22421316184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p4187328184810">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p3629321184810">List of tag values</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row167381757124916"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p37381157144913">matches</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p187404571492">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p1074065794912">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p1474095717493">Search criteria. Fuzzy search is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row125614719512"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p1136183975111">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p1214363925116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p714883985119">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p715314395514">Field for searching. Currently, only <strong id="EN-US_TOPIC_0067142133__b842352706204544">resource_name</strong> is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row1656171119519"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p121621039155115">value</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p2165163925112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p14354174815112">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p1817253914511">Search value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row32663894184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p28529724184810">limit</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p29206307184810">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p16900658184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p26776082184810">Number of queried records. This parameter is not displayed if <strong id="EN-US_TOPIC_0067142133__b842352706112419">action</strong> is set to <strong id="EN-US_TOPIC_0067142133__b842352706112428">count</strong>. The default value is <strong id="EN-US_TOPIC_0067142133__b842352706112654">1000</strong> if <strong id="EN-US_TOPIC_0067142133__b39236199214364">action</strong> is set to <strong id="EN-US_TOPIC_0067142133__b132640505514364">filter</strong>. The value must be an integer ranging from <strong id="EN-US_TOPIC_0067142133__b842352706112658">1000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row16150121114710"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p171509114472">offset</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p19150011204719">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p5150141174711">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p1315016118479">Query index. (This parameter is not displayed if <strong id="EN-US_TOPIC_0067142133__b842352706162146">action</strong> is set to <strong id="EN-US_TOPIC_0067142133__b842352706162149">count</strong>.) The query starts from the next piece of data indexed by this parameter. If <strong id="EN-US_TOPIC_0067142133__b655888473162315">action</strong> is set to <strong id="EN-US_TOPIC_0067142133__b969534961162315">filter</strong>, the default value is <strong id="EN-US_TOPIC_0067142133__b842352706162352">0</strong> which indicates the query starts from the first piece of data. The value must be a non-negative integer.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row37990305184810"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0067142133__p57315884184810">action</p>
</td>
<td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0067142133__p12075040184810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0067142133__p38554147184810">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.32%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0067142133__p35878240184810">Operator. Possible values are:</p>
<p id="EN-US_TOPIC_0067142133__p139614811480"><strong id="EN-US_TOPIC_0067142133__b842352706103947">filter</strong>: queries backup policies by specifying filtering conditions.</p>
<p id="EN-US_TOPIC_0067142133__p429424014910"><strong id="EN-US_TOPIC_0067142133__b842352706104030">count</strong>: queries backup policies by specifying the total number.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0067142133__ul22483156"><li id="EN-US_TOPIC_0067142133__li1021814">Example request<pre class="screen" id="EN-US_TOPIC_0067142133__screen66780510141214">{
"limit": "10",
"offset": "0",
"tags":
[
{
"key": "Tag001",
"values":["Value001","Value002"]
}
],
"action":"filter"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142133__section54881489"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0067142133__ul20896204"><li id="EN-US_TOPIC_0067142133__li2520711120254">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142133__table2553741120254" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142133__row84520220254"><th align="left" class="cellrowborder" valign="top" width="24.94%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0067142133__p1851311191196">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0067142133__p752919191999">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.07%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0067142133__p1052919191691">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142133__row894248020254"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p34048608151944">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p4563373217131">integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p1948402220254">Total number of resources</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row49142966153315"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p38366875153340">resources</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p66829450153340">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p3760433518513">List of resources</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row37005886153318"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p9704892153340">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p54594377153340">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p60068455153340">Resource ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row27429961153321"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p2606949118530">resouce_detail</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p32108888153340">object</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p50683125153340">Resource details, used for extension</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row59676584153324"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p38123120153340">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p11054614153340">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p23008573153340">Resource name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row3032128414342"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p4010493014342">tags</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p6170234814342">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p3183428014342">List of tags</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row17757769153327"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p63142605153340">key</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p15615278153340">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p45645767143341">Tag key</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row55800042153331"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p63777303153340">value</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p19118878153340">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p46173942143351">Tag value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row4113847020254"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p4388173520254">message</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p534483917131">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p1103955520254">Error message returned after an error occurs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row3224713720254"><td class="cellrowborder" valign="top" width="24.94%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142133__p6188131520254">code</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142133__p3027879417131">string</p>
</td>
<td class="cellrowborder" valign="top" width="56.07%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142133__p6179451720254">Error code returned after an error occurs</p>
<p id="EN-US_TOPIC_0067142133__p1927974620254">For details about error codes, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0067142133__li53848109">Example response<pre class="screen" id="EN-US_TOPIC_0067142133__screen1930569315384">{
"total_count":10,
"resources":[
{
"resource_name": "name",
"resource_id": "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
"resource_detail": null,
"tags": [{
"key":"key",
"value":"value"
}]
}
]
}</pre>
<p id="EN-US_TOPIC_0067142133__p36388601">or</p>
<pre class="screen" id="EN-US_TOPIC_0067142133__screen20692691101149">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142133__section24171358"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0067142133__ul59834015"><li id="EN-US_TOPIC_0067142133__li1635228">Normal<p id="EN-US_TOPIC_0067142133__p14717055"><a name="EN-US_TOPIC_0067142133__li1635228"></a><a name="li1635228"></a>200</p>
</li><li id="EN-US_TOPIC_0067142133__li65344633">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142133__table51230787" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142133__row60503138"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0067142133__p1807185">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0067142133__p12164329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142133__row45786577"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p17725233">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p26457778">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row36793414"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p27476571">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p11009764">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row31979016"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p40163483">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p32016662">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row4499052116376"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p2035357816376">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p3802708716376">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row8462523163725"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p14375766163725">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p23586373163725">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row60343628163758"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p55995701163758">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p39357967163758">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row32079544163754"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p48306260163754">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p20492948163754">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row28680770163738"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p41441040163738">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p1281119163738">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row65552906164354"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p8185203164354">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p59021712164354">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row19714506"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p53371190">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p28099101">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row32688750164938"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p30543097164938">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p58071768164938">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row11809518164943"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p17046908164943">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p38622347164943">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row38399341164956"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p23338889164956">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p11401882164956">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142133__row51565323"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142133__p16041657">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0067142133__p24305815">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142133__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0067142133__p129821455154315">For details, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0043410516.html">Backup Policies</a></div>
</div>
</div>
View Git Blame Copy Permalink