vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sdrs/api-ref/sdrs_05_0801.html
Wei, Hongmin ab56d080fb SDRS 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-26 13:51:50 +00:00

713 lines
56 KiB
HTML
Raw Blame History

<a name="sdrs_05_0801"></a><a name="sdrs_05_0801"></a>
<h1 class="topictitle1">Querying Protected Instances by Tag</h1>
<div id="body1548216133475"><div class="section" id="sdrs_05_0801__section75281345423"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0801__p189803452028">This API is used to query protected instances by tag.</p>
</div>
<div class="section" id="sdrs_05_0801__section2053494516212"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0801__ul119801345423"><li id="sdrs_05_0801__li998134519210">URI format<p id="sdrs_05_0801__p39812459215"><a name="sdrs_05_0801__li998134519210"></a><a name="li998134519210"></a>POST /v1/{project_id}/protected-instances/resource_instances/action</p>
</li><li id="sdrs_05_0801__li169811456215">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table195411245327" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0801__row99813451229"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sdrs_05_0801__p6981745727"><strong id="sdrs_05_0801__b842352706162023">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.407959204079592%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sdrs_05_0801__p698115451228"><strong id="sdrs_05_0801__b84235270615447">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.268673132686734%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sdrs_05_0801__p39812450214"><strong id="sdrs_05_0801__b84235270615453">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.93530646935306%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sdrs_05_0801__p198118457218"><strong id="sdrs_05_0801__b84235270615457">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row20981124517215"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sdrs_05_0801__p89815454216">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.407959204079592%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sdrs_05_0801__p1498116452216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.268673132686734%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sdrs_05_0801__p29811145523">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.93530646935306%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sdrs_05_0801__p139815451322">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0801__section655512453211"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0801__ul1098114456217"><li id="sdrs_05_0801__li1998114517210">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table1756210450219" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0801__row169811445823"><th align="left" class="cellrowborder" valign="top" width="17.53%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="sdrs_05_0801__p69816451621"><strong id="sdrs_05_0801__b1710130823">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.459999999999999%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="sdrs_05_0801__p159819451727"><strong id="sdrs_05_0801__b1782403198">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.49%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="sdrs_05_0801__p09811145723"><strong id="sdrs_05_0801__b151489554">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.519999999999996%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="sdrs_05_0801__p1598114453218"><strong id="sdrs_05_0801__b1597514475">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row1051613813442"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p8982145121">offset</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p098219451727">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p698213451523">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p69829451326">Specifies the index position. This parameter is unavailable when <strong id="sdrs_05_0801__b842352706102654">action</strong> is set to <strong id="sdrs_05_0801__b84235270610271">count</strong>. If <strong id="sdrs_05_0801__b70205942519474">offset</strong> is set to <em id="sdrs_05_0801__i84235269720751">N</em>, the resource query starts from the N+1 piece of data. If <strong id="sdrs_05_0801__b842352706102717">action</strong> is set to <strong id="sdrs_05_0801__b842352706102722">filter</strong>, the value of <strong id="sdrs_05_0801__b84235270620648">offset</strong> is <strong id="sdrs_05_0801__b84235270620630">0</strong> by default, indicating that the query starts from the first piece of data. The <strong id="sdrs_05_0801__b84235270620744">offset</strong> value must be a number and cannot be a negative number.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row2587111716443"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p39821445429">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p598217451923">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p149828452210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p1598224515216">Specifies the number of limited queries. This parameter is unavailable when <strong id="sdrs_05_0801__b842352706112419">action</strong> is set to <strong id="sdrs_05_0801__b842352706112428">count</strong>. The default value is <strong id="sdrs_05_0801__b842352706112654">1000</strong> when <strong id="sdrs_05_0801__b39236199214364">action</strong> is set to <strong id="sdrs_05_0801__b132640505514364">filter</strong>. The maximum value is <strong id="sdrs_05_0801__b842352706112658">1000</strong>, and the minimum value is <strong id="sdrs_05_0801__b842352706112710">1</strong>. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row2097913301442"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p209821145926">action</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p10982104513212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p17984945927">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p1198417453211">Specifies the operation to be performed. The value can be <strong id="sdrs_05_0801__b84235270616546">filter</strong> (filtering) or <strong id="sdrs_05_0801__b84235270616552">count</strong> (querying the total number).</p>
<p id="sdrs_05_0801__p19844450212">If <strong id="sdrs_05_0801__b8423527061184">action</strong> is set to <strong id="sdrs_05_0801__b84235270611747">filter</strong>, the query is performed based on the filter conditions. If <strong id="sdrs_05_0801__b1158078253111040">action</strong> is set to <strong id="sdrs_05_0801__b1717869715111040">count</strong>, only the total number of records is returned.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row1958125584416"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p99840451329">matches</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p129840455215">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p1498417451124">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p159841145527">Specifies the search field. The tag key is the field to be matched, for example, <strong id="sdrs_05_0801__b1815994217155439">resource_name</strong>. The tag value indicates the value to be matched. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys.</p>
<p id="sdrs_05_0801__p6984145925">Determine whether fuzzy match is required based on the keys. For example, if <strong id="sdrs_05_0801__b8423527062245">key</strong> is <strong id="sdrs_05_0801__b842352706123028">resource_name</strong>, fuzzy search (case insensitive) is used by default. If <strong id="sdrs_05_0801__b842352706123110">value</strong> is an empty string, exact match is used. Currently, only <strong id="sdrs_05_0801__b842352706123249">resource_name</strong> for <strong id="sdrs_05_0801__b842352706201429">key</strong> is supported. Other <strong id="sdrs_05_0801__b842352706201455">key</strong> values will be available later.</p>
<p id="sdrs_05_0801__p5497131161018">For details, see <a href="#sdrs_05_0801__table16621174514217">Table 2</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row185782162452"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p119819459217">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p998119451216">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p79815451216">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p998144515217">The resources to be queried do not contain tags listed in <strong id="sdrs_05_0801__b548729334194419">not_tags</strong>. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. 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 are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
<p id="sdrs_05_0801__p117770538101">For details, see <a href="#sdrs_05_0801__table9607445020">Table 1</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row15981144512219"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p1981114511217">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p298164511216">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p298115457218">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p3981174513214">The resources to be queried contain tags listed in <strong id="sdrs_05_0801__b1382599853193448">tags</strong>. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. 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 are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
<p id="sdrs_05_0801__p165152013151016">For details, see <a href="#sdrs_05_0801__table9607445020">Table 1</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row498118451921"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p998114456219">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p198194510218">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p149811845121">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p1398154512210">The resources to be queried contain any tags listed in <strong id="sdrs_05_0801__b2119851361193951">tags_any</strong>. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
<p id="sdrs_05_0801__p48641207817">For details, see <a href="#sdrs_05_0801__table9607445020">Table 1</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row59817454218"><td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p119811145628">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p598118451524">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p129813451420">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p69821645122">The resources to be queried do not contain any tags listed in <strong id="sdrs_05_0801__b4747911122210">not_tags_any</strong>. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing no tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
<p id="sdrs_05_0801__p1280271121112">For details, see <a href="#sdrs_05_0801__table9607445020">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0801__table9607445020"></a><a name="table9607445020"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table9607445020" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0801__b84235270695528">tag</strong> field description</caption><thead align="left"><tr id="sdrs_05_0801__row1598494519217"><th align="left" class="cellrowborder" valign="top" width="10.100000000000001%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="sdrs_05_0801__p1198416456218"><strong id="sdrs_05_0801__b1198579586">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="sdrs_05_0801__p13984194517210"><strong id="sdrs_05_0801__b1575073093">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="sdrs_05_0801__p17984345226"><strong id="sdrs_05_0801__b319894360">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.51%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="sdrs_05_0801__p7984104516214"><strong id="sdrs_05_0801__b110385509">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row9984184519215"><td class="cellrowborder" valign="top" width="10.100000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p19845452218">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p1398416459217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p49848451326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p189848451210">Specifies the tag key. It contains a maximum of 127 Unicode characters. It cannot be left blank. <strong id="sdrs_05_0801__b842352706195333">key</strong> cannot be empty, an empty string, or spaces. Before using <strong id="sdrs_05_0801__b842352706202438">key</strong>, delete spaces of single-byte character (SBC) before and after the value.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row1198434513215"><td class="cellrowborder" valign="top" width="10.100000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p169849451426">values</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p1898410451125">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p29841845724">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p617715315531">Lists the tag values. Each value contains a maximum of 255 Unicode characters. Before using <strong id="sdrs_05_0801__b842352706195530">values</strong>, delete SBC spaces before and after the value.</p>
<p id="sdrs_05_0801__p39841545625">The asterisk (*) is reserved for the system. If the value starts with *, it indicates that fuzzy match is performed based on the value following *. The value cannot contain only asterisks (*).</p>
<p id="sdrs_05_0801__p109845451721">If the values are null, it indicates <strong id="sdrs_05_0801__b842352706175623">any_value</strong> (querying any value). The resources containing one or more values listed in <strong>values</strong> will be found and displayed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0801__table16621174514217"></a><a name="table16621174514217"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table16621174514217" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of the <strong id="sdrs_05_0801__b1437033914514">match</strong> field</caption><thead align="left"><tr id="sdrs_05_0801__row49842045727"><th align="left" class="cellrowborder" valign="top" width="10.31%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="sdrs_05_0801__p69841456213"><strong id="sdrs_05_0801__b1489944296">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.65%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="sdrs_05_0801__p6984345728"><strong id="sdrs_05_0801__b1384469652">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.49%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="sdrs_05_0801__p7984134515212"><strong id="sdrs_05_0801__b117291295">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.55%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="sdrs_05_0801__p12984645322"><strong id="sdrs_05_0801__b1992781614">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row39841245723"><td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="sdrs_05_0801__p39841145426">key</p>
</td>
<td class="cellrowborder" valign="top" width="21.65%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="sdrs_05_0801__p209846451928">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="sdrs_05_0801__p39841745424">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.55%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="sdrs_05_0801__p193447512163">Specifies the tag key.</p>
<p id="sdrs_05_0801__p098416451524">Currently, only <strong id="sdrs_05_0801__b72794074">resource_name</strong> for <strong id="sdrs_05_0801__b1487495598">key</strong> is supported. Other <strong id="sdrs_05_0801__b1102178014">key</strong> values will be available later.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row1498415452022"><td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="sdrs_05_0801__p129841945125">value</p>
</td>
<td class="cellrowborder" valign="top" width="21.65%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="sdrs_05_0801__p498424512218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="sdrs_05_0801__p098418451523">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.55%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="sdrs_05_0801__p174441601614">Specifies the tag value.</p>
<p id="sdrs_05_0801__p398414451521">Each value can contain a maximum of 255 Unicode characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0801__ul198444517210"><li id="sdrs_05_0801__li698416451627">Sample request when <strong id="sdrs_05_0801__b29775114112928">action</strong> is set to <strong id="sdrs_05_0801__b66649438112928">filter</strong><div class="p" id="sdrs_05_0801__p898473016233">POST https://{Endpoint}/v1/{project_id}/protected-instances/resource_instances/action<pre class="screen" id="sdrs_05_0801__screen108243274238">{
"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>
</div>
</li><li id="sdrs_05_0801__li79847453214">Sample request when <strong id="sdrs_05_0801__b84235270620353">action</strong> is set to <strong id="sdrs_05_0801__b84235270620359">count</strong><div class="p" id="sdrs_05_0801__p129451433267">POST https://{Endpoint}/v1/{project_id}/protected-instances/resource_instances/action<pre class="screen" id="sdrs_05_0801__screen52391333142618">{
"action": "count",
"not_tags": [
{
"key": "key1",
"values": [
"value1",
"*value2"
]
}
],
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
],
"tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"not_tags_any": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0801__section963210457217"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0801__ul498511451224"><li id="sdrs_05_0801__li19857456212">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table12636124519210" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0801__row998514451324"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0801__p698518451326"><strong id="sdrs_05_0801__b1156342652">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="sdrs_05_0801__p3985144510211"><strong id="sdrs_05_0801__b353522890">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="sdrs_05_0801__p29857458213"><strong id="sdrs_05_0801__b552297101">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="sdrs_05_0801__p15985194518220"><strong id="sdrs_05_0801__b589855131">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row1298519455213"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p169851457213">resources</p>
</td>
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p1598516451723">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p2985154512214">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p115971253191112">Specifies the returned protected instances.</p>
<p id="sdrs_05_0801__p1898554513211">For details, see <a href="#sdrs_05_0801__table16443451223">Table 3</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row19985134511216"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0801__p79857459215">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0801__p1985124518215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0801__p9985134514217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0801__p1985345126">Specifies the total number of resources.</p>
<p id="sdrs_05_0801__p216434311222">The value is not affected by the filtering criteria.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0801__table16443451223"></a><a name="table16443451223"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table16443451223" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong>resource</strong></caption><thead align="left"><tr id="sdrs_05_0801__row79851245328"><th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="sdrs_05_0801__p1598511451923"><strong id="sdrs_05_0801__b1719809588">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="sdrs_05_0801__p5985184513215"><strong id="sdrs_05_0801__b1911314186">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="sdrs_05_0801__p29851445828"><strong id="sdrs_05_0801__b1708440581">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.85571442855714%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="sdrs_05_0801__p598613451126"><strong id="sdrs_05_0801__b456731150">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row998644510219"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p298694513216">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p798664510215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p129861045121">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p49863451220">Specifies the ID of a protected instance.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row4451926174117"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p398613455217">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p17986194511211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p9986204520212">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p19986945826">Specifies the protected instance name. This parameter is left blank by default if there is no name.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row16986184514217"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p1986164513218">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p209868453211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p69861452217">Object</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p189868451527">Specifies the details of a protected instance.</p>
<p id="sdrs_05_0801__p184217234117">For details, see <a href="#sdrs_05_0801__table503353570">Table 4</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row18986144515210"><td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0801__p19866451225">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0801__p1986124516215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0801__p109861245728">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0801__p498610454215">Specifies the tag list. If there is no tag in the list, <strong id="sdrs_05_0801__b84235270620128">tags</strong> is taken as an empty array.</p>
<p id="sdrs_05_0801__p363479181219">For details, see <a href="#sdrs_05_0801__table7656144514216">Table 8</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0801__table503353570"></a><a name="table503353570"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table503353570" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="sdrs_05_0801__sdrs_05_0503_b13641202262711">protected_instances</strong> field description</caption><thead align="left"><tr id="sdrs_05_0801__sdrs_05_0503_row131163505710"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="sdrs_05_0801__sdrs_05_0503_p19375192311238">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="sdrs_05_0801__sdrs_05_0503_p137512392315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.59%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="sdrs_05_0801__sdrs_05_0503_p183751523192314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__sdrs_05_0503_row1829133585715"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p7375132315239">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p237592310236">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p937518232232">Specifies the ID of a protected instance.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row1472144614199"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p13751523152316">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p1537592313235">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p7375102312318">Specifies the name of a protected instance.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row1845264811918"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p1266741153611">description</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p826674111364">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p19266104123612">Specifies the description of a protected instance.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row555943910310"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p14377923112315">server_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p18377823152317">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1237702319235">Specifies the ID of a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row2503145051917"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p8375223142315">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p17377723182310">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p26171744195317">Specifies the status of a protected instance.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p11377122372317">For details, see <a href="en-us_topic_0126152931.html">Protected Instance Status</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row168521941147"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p14745142282317">progress</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p1830712716181">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1330727191818">Specifies the synchronization progress of a protected instance.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p12307127121818">Unit: %</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row156171333144116"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p33771237238">source_server</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p837714234239">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p8377152312314">Specifies the production site server ID.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row473463515411"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p1037702317238">target_server</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p23779231233">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p12377192316233">Specifies the DR site server ID.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row022814014120"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p12377923192314">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p737762314230">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p4377182318230">Specifies the time when a protected instance was created.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p1078620139012">The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, <strong id="sdrs_05_0801__sdrs_05_0503_b1618132120140">2019-04-01 12:00:00.000</strong>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row757514214419"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p1937717234231">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p1377323132313">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1937716237235">Specifies the time when a protected instance was updated.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p1942786173519">The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, <strong id="sdrs_05_0801__sdrs_05_0503_b810333131517">2019-04-01 12:00:00.000</strong>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row08503318414"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p10235944142418">priority_station</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p10235154410245">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p382553192519">Specifies the current production site AZ of the protection group containing the protected instance.</p>
<ul id="sdrs_05_0801__sdrs_05_0503_ul782135312518"><li id="sdrs_05_0801__sdrs_05_0503_li15823536258"><strong id="sdrs_05_0801__sdrs_05_0503_b17653238122310">source</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0801__sdrs_05_0503_b1665418386237">source_availability_zone</strong> value.</li><li id="sdrs_05_0801__sdrs_05_0503_li1387855513251"><strong id="sdrs_05_0801__sdrs_05_0503_b1278154814238">target</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0801__sdrs_05_0503_b187838483234">target_availability_zone</strong> value.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row1974415342560"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p1374517342565">attachment</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p474543475616">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1674513345564">Specifies the attached replication pairs.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p94849197376">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table1575342962014">Table 2</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row1511716165613"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p198281231145613">tags</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p20771154912569">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p15241635617">Specifies the tag list.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p139197593379">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table12339146338">Table 3</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row1347091555717"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p6472615185719">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p10709144620575">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1786654614533">Specifies the metadata of a protected instance.</p>
<p id="sdrs_05_0801__sdrs_05_0503_p370974645720">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table8582730112710">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table1575342962014" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="sdrs_05_0801__sdrs_05_0503_b1262385652719">attachment</strong> field description</caption><thead align="left"><tr id="sdrs_05_0801__sdrs_05_0503_row157542290208"><th align="left" class="cellrowborder" valign="top" width="29.062906290629066%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="sdrs_05_0801__sdrs_05_0503_p167541029122015"><strong id="sdrs_05_0801__sdrs_05_0503_b9456951154117">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.42174217421742%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="sdrs_05_0801__sdrs_05_0503_p77541429102015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.51535153515352%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="sdrs_05_0801__sdrs_05_0503_p13754172912015"><strong id="sdrs_05_0801__sdrs_05_0503_b1982665274115">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__sdrs_05_0503_row57541029192012"><td class="cellrowborder" valign="top" width="29.062906290629066%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p197541729112016">replication</p>
</td>
<td class="cellrowborder" valign="top" width="17.42174217421742%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p197546293203">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.51535153515352%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p11754162962013">Specifies the ID of a replication pair.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row7754122902018"><td class="cellrowborder" valign="top" width="29.062906290629066%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p17754152962012">device</p>
</td>
<td class="cellrowborder" valign="top" width="17.42174217421742%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p1754132902020">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.51535153515352%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p97541729162014">Specifies the device name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table12339146338" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="sdrs_05_0801__sdrs_05_0503_b1954114574315">tags</strong> field description</caption><thead align="left"><tr id="sdrs_05_0801__sdrs_05_0503_row43396416331"><th align="left" class="cellrowborder" valign="top" width="29.01290129012902%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="sdrs_05_0801__sdrs_05_0503_p13396473310"><strong id="sdrs_05_0801__sdrs_05_0503_b8226188154419">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.401740174017398%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="sdrs_05_0801__sdrs_05_0503_p7339247336"><strong id="sdrs_05_0801__sdrs_05_0503_b5715144294014">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.58535853585359%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="sdrs_05_0801__sdrs_05_0503_p7339343338"><strong id="sdrs_05_0801__sdrs_05_0503_b57498420443">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__sdrs_05_0503_row43406415336"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p7340204133310">key</p>
</td>
<td class="cellrowborder" valign="top" width="17.401740174017398%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p1334016412332">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.58535853585359%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p9340164163314">Specifies the tag key.</p>
</td>
</tr>
<tr id="sdrs_05_0801__sdrs_05_0503_row113401848337"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p193401449333">value</p>
</td>
<td class="cellrowborder" valign="top" width="17.401740174017398%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p12340546334">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.58535853585359%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p1234015416337">Specifies the tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table8582730112710" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Field <strong id="sdrs_05_0801__sdrs_05_0503_b842352706195118">metadata</strong> description</caption><thead align="left"><tr id="sdrs_05_0801__sdrs_05_0503_row13583230202711"><th align="left" class="cellrowborder" valign="top" width="29.01290129012902%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="sdrs_05_0801__sdrs_05_0503_p18958174419296"><strong id="sdrs_05_0801__sdrs_05_0503_b3445153418161">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.64176417641764%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="sdrs_05_0801__sdrs_05_0503_p12958154420296">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.34533453345335%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="sdrs_05_0801__sdrs_05_0503_p395816448297"><strong id="sdrs_05_0801__sdrs_05_0503_b930512361165">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__sdrs_05_0503_row6583930152715"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="sdrs_05_0801__sdrs_05_0503_p1558353082720">__system__frozen</p>
</td>
<td class="cellrowborder" valign="top" width="17.64176417641764%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="sdrs_05_0801__sdrs_05_0503_p11583730102710">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.34533453345335%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="sdrs_05_0801__sdrs_05_0503_p958313303271">Specifies whether the resource is frozen.</p>
<ul id="sdrs_05_0801__sdrs_05_0503_ul529114370311"><li id="sdrs_05_0801__sdrs_05_0503_li152921437183118"><strong id="sdrs_05_0801__sdrs_05_0503_b12328157201913">true</strong>: indicates that the resource is frozen.</li><li id="sdrs_05_0801__sdrs_05_0503_li1108121319326">Empty: indicates that the resource is not frozen.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0801__table7656144514216"></a><a name="table7656144514216"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table7656144514216" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="sdrs_05_0801__b96078100453">resource_tag</strong> field description</caption><thead align="left"><tr id="sdrs_05_0801__row1986124513214"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.2.1.7.2.5.1.1"><p id="sdrs_05_0801__p209865451824"><strong id="sdrs_05_0801__b95709494">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.1.7.2.5.1.2"><p id="sdrs_05_0801__p4986045129"><strong id="sdrs_05_0801__b580701718">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.4.2.1.7.2.5.1.3"><p id="sdrs_05_0801__p1598620451722"><strong id="sdrs_05_0801__b520156073">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.40404040404041%" id="mcps1.3.4.2.1.7.2.5.1.4"><p id="sdrs_05_0801__p1698611451928"><strong id="sdrs_05_0801__b1672284754">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row17986145228"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.7.2.5.1.1 "><p id="sdrs_05_0801__p298624512214">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.7.2.5.1.2 "><p id="sdrs_05_0801__p189861451729">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.4.2.1.7.2.5.1.3 "><p id="sdrs_05_0801__p5986194516217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.4.2.1.7.2.5.1.4 "><p id="sdrs_05_0801__p6239864018">Specifies the tag key. The tag key of a resource must be unique.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row119874451729"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.7.2.5.1.1 "><p id="sdrs_05_0801__p179876451323">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.7.2.5.1.2 "><p id="sdrs_05_0801__p139872451226">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.4.2.1.7.2.5.1.3 "><p id="sdrs_05_0801__p7987845921">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.40404040404041%" headers="mcps1.3.4.2.1.7.2.5.1.4 "><p id="sdrs_05_0801__p142315716011">Specifies the value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0801__ul398718458212"><li id="sdrs_05_0801__li199871453215">Example response<p id="sdrs_05_0801__p11987045427"><a name="sdrs_05_0801__li199871453215"></a><a name="li199871453215"></a>Example response when <strong id="sdrs_05_0801__b842352706212033">action</strong> is set to <strong id="sdrs_05_0801__b842352706212055">filter</strong></p>
<pre class="screen" id="sdrs_05_0801__screen18892812627">{
"resources": [
{
"resource_id": "d5a00c87-6b82-414a-a09e-59c37fff44d0",
"resource_name": "Protected-Instance-c801",
"resource_detail": {
"id": "d5a00c87-6b82-414a-a09e-59c37fff44d0",
"name": "Protected-Instance-c801",
"description": null,
"server_group_id": "525fbd01-d4d1-44fc-b341-6d734bcce245",
"status": "protected",
"progress": 100,
"source_server": "73aff1d7-48d2-494e-a9f1-a7d3ffad31ff",
"target_server": "0f6bc56b-a3bb-4707-a4fb-ccd4db5fac59",
"created_at": "2019-05-28 08:17:50.066",
"updated_at": "2019-05-30 01:40:00.74",
"priority_station": "source",
"attachment": [
{
"replication": "42e2016e-b96e-4f75-aa57-1377a9cb45e4",
"device": "/dev/vda"
}
],
"tags": [
{
"key": "GH1111113fffffKdddddd",
"value": "aaappppppppddddddd"
}
],
"metadata": {}
},
"tags": [
{
"key": "GH1111113fffffKdddddd",
"value": "aaappppppppddddddd"
}
]
}
],
"total_count": 1
}</pre>
</li><li id="sdrs_05_0801__li298712451629">Example response when <strong id="sdrs_05_0801__b57222443112928">action</strong> is set to <strong id="sdrs_05_0801__b45239940112928">count</strong><pre class="screen" id="sdrs_05_0801__screen1766119481229">{
"total_count": 1000
}</pre>
</li></ul>
</div>
<div class="section" id="sdrs_05_0801__section567644518219"><h4 class="sectiontitle"><strong id="sdrs_05_0801__b842352706175024">Returned Value</strong></h4><ul id="sdrs_05_0801__ul149871451329"><li id="sdrs_05_0801__li1298712451525">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table667715456216" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0801__row298714510212"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="sdrs_05_0801__p1198734518211"><strong id="sdrs_05_0801__b129288371">Returned Value</strong></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="sdrs_05_0801__p1498734512215"><strong id="sdrs_05_0801__b2001552258">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row7987164514218"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="sdrs_05_0801__p129882451523">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="sdrs_05_0801__p298834512212">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0801__ul19988345224"><li id="sdrs_05_0801__li1298813458216">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0801__table1867918454217" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0801__row59881459212"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.3.1.1.1.3.1.1"><p id="sdrs_05_0801__p1598814451024"><strong id="sdrs_05_0801__b813857274">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.3.1.1.1.3.1.2"><p id="sdrs_05_0801__p1798814516220"><strong id="sdrs_05_0801__b632666478">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0801__row19988144513218"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0801__p098810454218">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.3.1.1.1.3.1.2 "><p id="sdrs_05_0801__p12988645627">Invalid parameters.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row12988104519214"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0801__p189881845321">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.3.1.1.1.3.1.2 "><p id="sdrs_05_0801__p1698815452212">Authentication failed.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row898815451212"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0801__p8988945429">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.3.1.1.1.3.1.2 "><p id="sdrs_05_0801__p7988124513214">Insufficient permission.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row19885455216"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0801__p179888451821">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.3.1.1.1.3.1.2 "><p id="sdrs_05_0801__p1498813451215">The requested resource was not found.</p>
</td>
</tr>
<tr id="sdrs_05_0801__row16988154515213"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0801__p69882455210">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.3.1.1.1.3.1.2 "><p id="sdrs_05_0801__p2988144518212">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sdrs_05_0800.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink