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_0098635086.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

1022 lines
75 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0098635086"></a><a name="EN-US_TOPIC_0098635086"></a>
<h1 class="topictitle1">Querying Backup Resources by Tag</h1>
<div id="body1519724141377"><div class="section" id="EN-US_TOPIC_0098635086__section35899943"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0098635086__p37994081">This API is used to filter resources by tag.</p>
<p class="msonormal" id="EN-US_TOPIC_0098635086__p6402410">Tag Management Service (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_0098635086__section54664039"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0098635086__ul48833241"><li id="EN-US_TOPIC_0098635086__li36845993">URI format<p id="EN-US_TOPIC_0098635086__p63178481"><a name="EN-US_TOPIC_0098635086__li36845993"></a><a name="li36845993"></a>POST https://{endpoint}/v1/{project_id}/csbs_backup/resource_instances/action</p>
</li><li id="EN-US_TOPIC_0098635086__li17183321">Request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table20432162" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header</caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row57818045"><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_0098635086__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_0098635086__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_0098635086__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_0098635086__p6978835213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row546286"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p44249235">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_0098635086__p1349835311518">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_0098635086__p27418305">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_0098635086__p39744725">application/json</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row22158209"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p49984495">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_0098635086__p15496653358">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_0098635086__p22212298">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_0098635086__p41544677">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635086__ul9675637"><li id="EN-US_TOPIC_0098635086__li19971870">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table45529105" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row64560089"><th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635086__p13599171761216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635086__p196152178123">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635086__p19615717141216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635086__p1761571718127">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row43823951"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p60079171">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p34574683">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635086__p49085952">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635086__p65779720">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635086__section22214308"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0098635086__ul26179384"><li id="EN-US_TOPIC_0098635086__li34287870">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table40155382" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row3231228"><th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635086__p499032320129">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635086__p52120247121">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_0098635086__p12192413121">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_0098635086__p143782415121">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row44521582"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p49478415">tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p48328717">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_0098635086__p22312015">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_0098635086__p15624527153813">List of included tags. Backups with these tags will be filtered.</p>
<p id="EN-US_TOPIC_0098635086__p0494199183911">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635086__p646324463913">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635086__p19401115618394">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635086__p1771815924015">Keys in this list are in an AND relationship.</p>
<p id="EN-US_TOPIC_0098635086__p164965117535">The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row15427175544720"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p54273555474">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__p1842725544712">List of tags. Backups with any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0098635086__p158584245013">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635086__p16591114214506">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635086__p459817429501">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635086__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_0098635086__row195677435718"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p175677415716">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__p115672419576">List of excluded tags. Backups without these tags will be filtered.</p>
<p id="EN-US_TOPIC_0098635086__p1199314506578">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635086__p62165145715">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635086__p0111751105713">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635086__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_0098635086__row12196548112"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p02193547116">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__p192791022229">List of tags. Backups without any tags in this list will be filtered.</p>
<p id="EN-US_TOPIC_0098635086__p428532217220">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635086__p1229319221525">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0098635086__p1529610224214">Keys in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635086__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_0098635086__row2948748"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p37522006">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__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_0098635086__p3210845577">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_0098635086__p09225511219">Query count (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635086__b842352706195922">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b842352706195927">count</strong>.)</p>
<p id="EN-US_TOPIC_0098635086__p4692191">If <strong id="EN-US_TOPIC_0098635086__b842352706102324">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b842352706102329">filter</strong>, the value defaults to <strong id="EN-US_TOPIC_0098635086__b842352706102331">1000</strong>. The value ranges from <strong id="EN-US_TOPIC_0098635086__b842352706102340">1</strong> to <strong id="EN-US_TOPIC_0098635086__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_0098635086__b842352706194753">limit</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row42229725"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p65164587">offset</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__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_0098635086__p9429145905611">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_0098635086__p177411411197">Query index (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635086__b1556433678">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b1048374709">count</strong>.)</p>
<p id="EN-US_TOPIC_0098635086__p14508185131920">If <strong id="EN-US_TOPIC_0098635086__b200691530720216">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b39257038320216">filter</strong>, the value defaults to <strong id="EN-US_TOPIC_0098635086__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>
<tr id="EN-US_TOPIC_0098635086__row60824073"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p27802884">action</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p37441107">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_0098635086__p12830815">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_0098635086__p34304549">Operation type</p>
<p id="EN-US_TOPIC_0098635086__p64392016184311">Possible values are <strong id="EN-US_TOPIC_0098635086__b842352706194826">filter</strong> and <strong id="EN-US_TOPIC_0098635086__b842352706194830">count</strong>. </p>
<p id="EN-US_TOPIC_0098635086__p40305487"><strong id="EN-US_TOPIC_0098635086__b45514660820229">filter</strong> indicates pagination query and <strong id="EN-US_TOPIC_0098635086__b987992455202243">count</strong> indicates that a specified number of queried records will be returned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row28461771"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p23702140">matches</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p40825226">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_0098635086__p18509020">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_0098635086__p518016559472">List of query criteria supported by resources</p>
<p id="EN-US_TOPIC_0098635086__p17555154424814">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0098635086__p184835314818">Keys in this list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li4209123">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b84235270695528">tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table37882110" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b1241414861">tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row59354473"><th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0098635086__p9646132818126">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0098635086__p2646152801210">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_0098635086__p17661152820124">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_0098635086__p966162861210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row20316329"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p35009954">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p17234060">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_0098635086__p53781647">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_0098635086__p321161514239">Tag key</p>
<p id="EN-US_TOPIC_0098635086__p10460518142315">A tag key consists of up to 127 characters.</p>
<p id="EN-US_TOPIC_0098635086__p1448142852310">A tag key cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635086__p18211830102310">Spaces before and after a key will be deprecated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row15244259"><td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p26825449">values</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p25377797">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_0098635086__p42335644">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_0098635086__p6635160">List of tag values</p>
<p id="EN-US_TOPIC_0098635086__p2523131132416">The list can contain up to 10 values.</p>
<p id="EN-US_TOPIC_0098635086__p991663534711">A tag value consists of up to 255 characters.</p>
<p id="EN-US_TOPIC_0098635086__p19191952142520">Spaces before and after a key will be deprecated.</p>
<p id="EN-US_TOPIC_0098635086__p1054662113481">Values in this list must be unique.</p>
<p id="EN-US_TOPIC_0098635086__p261532134815">Values in this list are in an OR relationship.</p>
<p id="EN-US_TOPIC_0098635086__p1058913346263">This list can be empty and each value can be an empty character string.</p>
<p id="EN-US_TOPIC_0098635086__p423705915480">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_0098635086__li46746846">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b1400608601">match</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table18068436" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b1556095470">match</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row56908160"><th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0098635086__p143491832181216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0098635086__p1436510326125">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0098635086__p136523211121">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0098635086__p4380132141214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row52430087"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p18978665">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p60876920">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635086__p32083483">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635086__p10967192418392">Tag key</p>
<p id="EN-US_TOPIC_0098635086__p75017351392">Possible values are:</p>
<p id="EN-US_TOPIC_0098635086__p10450046113913"><strong id="EN-US_TOPIC_0098635086__b842352706202849">resource_name</strong>: indicates the resource name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row34974869"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0098635086__p14392122">value</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0098635086__p24911248">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0098635086__p4545214">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0098635086__p1843451574214">Tag value</p>
<p id="EN-US_TOPIC_0098635086__p1830782015424">A tag value consists of up to 255 characters.</p>
<p id="EN-US_TOPIC_0098635086__p32618093">If <strong id="EN-US_TOPIC_0098635086__b842352706203053">key</strong> is set to <strong id="EN-US_TOPIC_0098635086__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_0098635086__li25127389">Example request<pre class="screen" id="EN-US_TOPIC_0098635086__screen58701522192814">POST https://{endpoint}/v1/{project_id}/csbs_backup/resource_instances/action</pre>
</li></ul>
<ul id="EN-US_TOPIC_0098635086__ul22052591"><li id="EN-US_TOPIC_0098635086__li64255597">When <strong id="EN-US_TOPIC_0098635086__b842352706203143">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b842352706203145">filter</strong>:<pre class="screen" id="EN-US_TOPIC_0098635086__screen208539325280">{
"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_0098635086__ul46761928"><li id="EN-US_TOPIC_0098635086__li18204173">When <strong id="EN-US_TOPIC_0098635086__b709877580">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b1843913609">count</strong>:<pre class="screen" id="EN-US_TOPIC_0098635086__screen1060874432817">{
"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_0098635086__section65711047"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0098635086__ul2421933"><li id="EN-US_TOPIC_0098635086__li21797398">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table61958854" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__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_0098635086__p1630103911127">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_0098635086__p564516393128">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_0098635086__p464593901215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p5587738">List of matched resources (This parameter is not displayed if <strong id="EN-US_TOPIC_0098635086__b73035897">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b518841199">count</strong>.)</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p19183631135514">Total number of matched resources</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635086__ul5956154"><li id="EN-US_TOPIC_0098635086__li53605390">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b7642103510720">resource</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table12686464" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b20421120205919">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__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_0098635086__p25184812122">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_0098635086__p17201748121216">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_0098635086__p22084818120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p21016952">Resource ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p56778076">Resource details</p>
<p id="EN-US_TOPIC_0098635086__p17874425294">Backup details, including <strong id="EN-US_TOPIC_0098635086__b842352706203428">tags</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p17187600">Tag list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__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_0098635086__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_0098635086__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_0098635086__p7310212">Resource name</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li63128328">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b62710669172148">resource_detail</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table31284045" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b823293532">resource_detail</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row64126600"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.2.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p1367713113139">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.2.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p156936118131">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.2.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p196935111131">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row26325568"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p51996302">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p33385823">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p19897138">Backup record ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row44856519"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p9499412">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p48618095">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p45751629">Creation time, for example, <strong id="EN-US_TOPIC_0098635086__b136843365254">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row9111485"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p66941716">extend_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p44192877">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p22853313">Extension information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row4353229"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p17067270">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p40779379">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p14795382">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row66049575"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p48415341">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p26805152">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p23733724">Backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row12276932"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p54907410">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p7135583">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p41111342">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row34457765"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p39615556">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p5034912">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p5174700">Backup status</p>
<p id="EN-US_TOPIC_0098635086__p199923219255">Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row16497581"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p61235723">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p53922812">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p5671647">Modification time, for example, <strong id="EN-US_TOPIC_0098635086__b1344123872518">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row51044828"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p40990393">backup_data</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p32752180">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p35680930">VM metadata</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row7523923353"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p2052319231152">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p25231123550">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p1452312318520">Backup description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row1483112381346"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p583173853411">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p12831193833415">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p7831173883410">Tag list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row186965413101"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p1430747161018">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p133205712103">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p83271175104">Backup object type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li52692922">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b111607">extend_info</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table4474257" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b854432319596">extend_info</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row25374974"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p861741315132">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.3.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p66337137131">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.3.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p106491113161315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row35881396"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p20711946">auto_trigger</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p62743133">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p49029033">Whether automatic trigger is enabled</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row38608121"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p40250071">average_speed</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p7336516">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p57386915">Average speed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row46720194"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p26239345">copy_from</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p22108653">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p45970441">This parameter is left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row11080792"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p25128946">copy_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p51649553">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p112911849103111">This parameter is left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row40063217"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p23895134">fail_code</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p9669625">fail_code</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p45042167">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row2726327"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p19505966">fail_op</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p2039495">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p30981435">Type of the failed operation</p>
<p id="EN-US_TOPIC_0098635086__p10397463">Enum: [backup, restore, delete, verify, copy]</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row26468307"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p63558136">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p57560327">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p31874881">Description of the failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row18438475"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p17121511">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p61107184">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p50734894">Backup type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row53960863"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p8753788">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p55529076">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p1561311">Whether incremental backup is used</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row14051800"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p64454033">progress</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p29959179">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p10774429">Backup progress. The value is an integer ranging from 0 to 100.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row29860999"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p2821893">resource_az</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p59506486">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p55296057">AZ to which the backup resource belongs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row27902470"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p45507587">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p7944126">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p39494476">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row611222610436"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p149812204222">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p998142020221">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p09822022216">Backup object type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row19905972"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p1771067">size</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p10137332">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p15817592">Backup capacity</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row8140604"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p55409189">space_saving_ratio</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p10978802">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p16867749">Space saving rate</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row17592014"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p15667012">volume_backups</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p47601111">List&lt;volume_backup&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p30484803">Disk backup list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row5927779"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p10388065">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p40598030">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p106125">Backup completion time, for example, <strong id="EN-US_TOPIC_0098635086__b14715204514256">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row1878614674719"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p14691120181216">supported_restore_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p204691920121214">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p18728201715">Restoration mode. Possible values are <strong id="EN-US_TOPIC_0098635086__b87075192210935">na</strong>, <strong id="EN-US_TOPIC_0098635086__b84235270610734">snapshot</strong>, and <strong id="EN-US_TOPIC_0098635086__b84235270610737">backup</strong>.</p>
<p id="EN-US_TOPIC_0098635086__p55391555134115"><strong id="EN-US_TOPIC_0098635086__b84235270610750">snapshot</strong>: Data is restored from snapshots of the disks of the server.</p>
<p id="EN-US_TOPIC_0098635086__p8166816173"><strong id="EN-US_TOPIC_0098635086__b84235270610831">backup</strong>: Data is restored from backups of the disks of the server.</p>
<p id="EN-US_TOPIC_0098635086__p11211554424"><strong id="EN-US_TOPIC_0098635086__b84235270610912">na</strong>: Restoration is not supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row73401142174616"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p334014284610">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p5340242114618">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p193409421466">Tag list</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li955132">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b17321959">backup_data</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table8596189" width="90%" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b12307102515912">backup_data</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row56714947"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p653923551315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p135392358133">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p15555193519135">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row63047142"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p6544886">__openstack_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p58434603">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p35582368">Name of the AZ where the ECS resides</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row51805857"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p35524928">cloudservicetype</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p9973792">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p2570800">ECS type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row23137205"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p62174317">disk</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p38022763">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p59944961">System disk size corresponding to the ECS specifications</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row2633738"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p12006197">imagetype</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p53964645">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p9060154">Image type. Possible values are <strong id="EN-US_TOPIC_0098635086__b842352706102151">gold</strong> (public image), <strong id="EN-US_TOPIC_0098635086__b842352706102251">private</strong> (private image), and <strong id="EN-US_TOPIC_0098635086__b842352706102254">market</strong> (market image).</p>
<p id="EN-US_TOPIC_0098635086__p14432528">Enum: [gold, private, market]</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row62783896"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p52330790">ram</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p13365491">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p8862978">Memory size of the ECS, in MB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row12657945"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p18660600">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p25630932">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p62839584">CPU cores corresponding to the ECS</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row28685351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p41812081">eip</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p55141104">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p37244403">Elastic IP address of the ECS</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row66764179"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p39189427">private_ip</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p27774216">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p35118989">Internal IP address of the ECS</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li3659722185710">Parameter description of field <strong>image_data</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table17665422205719" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b03982026105916">image_data</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row156851122175719"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.5.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p16899174711310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.5.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p7914347191316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.5.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p15914647141320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row6718112212576"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p11724172211573">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p173310227573">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p3739112205719">Image ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li19596328917">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b1724520371511">fail_code</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table13384103111117" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b5965182795914">fail_code</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row173845314115"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.6.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p1486956201313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.6.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p15102145612135">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.6.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p111171056121320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row1838415319115"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p14384103120115">Code</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p13384113115116">Long</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p23846311716">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row20384231212"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p838433113119">Description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p23849318116">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p163844311713">Error description</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li47635446">Parameter description of field<strong id="EN-US_TOPIC_0098635086__b2175687"> volume_backup</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table26065838" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Parameter description of field<strong id="EN-US_TOPIC_0098635086__b128892918596"> volume_backup</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row3231685"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.3.7.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p12141246141">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.3.7.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p9158145145">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.3.7.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p191735431413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row8986735"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p56836906">average_speed</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p50095482">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p31202271">Average speed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row12384989"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p63660086">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p55367277">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p55564443">Whether the disk functions as a system disk</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row30317943"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p39834343">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p31212633">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p45195306">Cinder backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row4104573"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p64035022">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p32297070">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p65925901">Backup set type</p>
<p id="EN-US_TOPIC_0098635086__p56462200">Enum:[ backup]</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row38397760"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p23210864">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p16467941">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p58834810">Whether incremental backup is used</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row59751243"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p8012554">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p24132138">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p8546138">Disk backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row9806383"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p56119559">size</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p41203013">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p49109755">Accumulated size (MB) of backups</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row39334612"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p31986975">source_volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p17128847">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p45259396">Source disk ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row4681386"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p43648019">source_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p21133674">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p34106024">Source disk size in GB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row38518764"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p33012204">space_saving_ratio</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p32770942">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p37200607">Space saving rate</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row66370010"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p7261755">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p64196347">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p32521642">Status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row24259325"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p18848346">source_volume_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p49472988">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p47889106">Source disk name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row0397855134916"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.3.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p18739530979">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.3.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p773917301975">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.3.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p3739143011716">ID of the snapshot from which the backup is generated</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li65791910">Parameter description of field <strong id="EN-US_TOPIC_0098635086__b901272754">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table55256281" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635086__b1767089550">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635086__row23988764"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.4.3.8.2.2.4.1.1"><p id="EN-US_TOPIC_0098635086__p11798111317143">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.4.3.8.2.2.4.1.2"><p id="EN-US_TOPIC_0098635086__p381413139144">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.33%" id="mcps1.3.4.3.8.2.2.4.1.3"><p id="EN-US_TOPIC_0098635086__p5814131318142">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row24665405"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p51740790">key</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p30254496">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0098635086__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0098635086__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635086__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row43820797"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.3.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635086__p59823639">value</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.4.3.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635086__p13876573">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.33%" headers="mcps1.3.4.3.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635086__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0098635086__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0098635086__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0098635086__p139758212811">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
<p id="EN-US_TOPIC_0098635086__p49692801"></p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__li44582032">Example response<p id="EN-US_TOPIC_0098635086__p65693974"><a name="EN-US_TOPIC_0098635086__li44582032"></a><a name="li44582032"></a>When <strong id="EN-US_TOPIC_0098635086__b1793207543">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b2119932378">filter</strong>:</p>
<pre class="screen" id="EN-US_TOPIC_0098635086__screen1911063152619">{
"status":"aviable",
"backup_data":{
"eip":"",
"cloudservicetype":"QEMU",
"ram":1024,
"__openstack_region_name":"",
"vcpus":1,
"private_ip":"",
"disk":0,
"imagetype":"gold"
},
"periodic_type":null,
"name":"manualbk_ea67",
"resource_id":"58482e0b-a357-4125-bdad-102f796b0e0c",
"created_at":"2020-02-11T06:34:43.897750",
"checkpoint_id":"ee45c782-71f8-4265-8392-e31fc701836c",
"replication_records":[
],
"updated_at":"2020-02-11T06:38:29.765609",
"protected_at":"2020-02-11T06:30:26.000000",
"tags":[
],
"extend_info":{
"auto_trigger":false,
"finished_at":"2020-02-11T06:38:29.748932",
"volume_backups":[
],
"incremental":true,
"copy_from":null,
"dec_size":0,
"size":0,
"resource_az":"br-iaas-odin1b",
"copy_status":"na",
"image_type":"backup",
"average_speed":0,
"taskid":"e9c97c75-59fa-4b99-8b4b-1dd991dbba33",
"progress":8,
"resource_type":"OS::Nova::Server"
},
"progress":null,
"expired_at":null,
"id":"a6d04e0e-0121-41d1-8371-eaeab14482f8",
"resource_type":"OS::Nova::Server",
"description":"--"
}</pre>
<div class="litext" id="EN-US_TOPIC_0098635086__p20853777">When <strong id="EN-US_TOPIC_0098635086__b1745644750">action</strong> is set to <strong id="EN-US_TOPIC_0098635086__b314982838">count</strong>:<pre class="screen" id="EN-US_TOPIC_0098635086__screen91257404306">{
total_count": 1000
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635086__section54528513"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0098635086__ul5911965"><li id="EN-US_TOPIC_0098635086__li53207692">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table9107180" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635086__row26570537"><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_0098635086__p4729870">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_0098635086__p47575204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row28386322"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p17590785">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_0098635086__p15567513">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635086__toc501533164">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635086__table53009025" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635086__row38294646"><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_0098635086__p14858635">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_0098635086__p62698772">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635086__row45435770"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p56418724">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_0098635086__p6513914">Invalid parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row58625234"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p51023510">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_0098635086__p39263675">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row17828761"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p34843570">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_0098635086__p3756927">You do not have permission to perform this operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row33812349"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p54445748">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_0098635086__p48029459">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635086__row29611954"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635086__p49758049">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_0098635086__p3870157">A system exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635086__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0098635086__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