forked from docs/doc-exports
Wei, Hongmin
ab56d080fb
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
177 lines
13 KiB
HTML
177 lines
13 KiB
HTML
<a name="sdrs_05_0805"></a><a name="sdrs_05_0805"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Protected Instance Tag</h1>
|
|
<div id="body1548216603526"><div class="section" id="sdrs_05_0805__section4824646124711"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0805__p4959146164719">This API is used to query tags of a specified protected instance.</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0805__section182518469474"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0805__ul20959546194713"><li id="sdrs_05_0805__li99591246174715">URI format<p id="sdrs_05_0805__p9959194634711"><a name="sdrs_05_0805__li99591246174715"></a><a name="li99591246174715"></a>GET /v1/{project_id}/protected-instances/{protected_instance_id}/tags</p>
|
|
</li><li id="sdrs_05_0805__li17960746144711">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0805__table982754614711" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0805__row796014469473"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sdrs_05_0805__p696084618471"><strong id="sdrs_05_0805__b842352706162023">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.530000000000005%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sdrs_05_0805__p119603469470"><strong id="sdrs_05_0805__b84235270615447">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sdrs_05_0805__p49602046114713"><strong id="sdrs_05_0805__b84235270615453">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.84%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sdrs_05_0805__p129601446124715"><strong id="sdrs_05_0805__b84235270615457">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0805__row696014694719"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sdrs_05_0805__p0960746124715">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.530000000000005%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sdrs_05_0805__p99601446154714">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sdrs_05_0805__p2960146124716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.84%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sdrs_05_0805__p4960184612473">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row17960204684712"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sdrs_05_0805__p596064624711">protected_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.530000000000005%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sdrs_05_0805__p3960184617471">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sdrs_05_0805__p596064664713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.84%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sdrs_05_0805__p119613464471">Specifies the ID of a protected instance.</p>
|
|
<p id="sdrs_05_0805__p13101121716915">For details, see <a href="sdrs_05_0503.html">Querying Protected Instances</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0805__section883411463475"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0805__ul020335213918"><li id="sdrs_05_0805__li79615471597">Request parameters<p id="sdrs_05_0805__p442945116915"><a name="sdrs_05_0805__li79615471597"></a><a name="li79615471597"></a>None</p>
|
|
</li><li id="sdrs_05_0805__li120316527911">Example request<p id="sdrs_05_0805__p136791915151015"><a name="sdrs_05_0805__li120316527911"></a><a name="li120316527911"></a>GET https://{Endpoint}/v1/{project_id}/protected-instances/50f5091e-9e9e-473c-a932-2a2cbcbeb1ff/tags</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0805__section178349461475"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0805__ul18961174614715"><li id="sdrs_05_0805__li496114624717">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0805__table17838184694718" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0805__row10961046134712"><th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0805__p119611446134711"><strong id="sdrs_05_0805__b1135395018">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.47%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="sdrs_05_0805__p1996104617477"><strong id="sdrs_05_0805__b1739752651">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.55%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="sdrs_05_0805__p1696124612470"><strong id="sdrs_05_0805__b1910828393">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.78%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="sdrs_05_0805__p8961104644718"><strong id="sdrs_05_0805__b200530815">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0805__row19961746114718"><td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0805__p396154604718">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0805__p6961446124718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.55%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0805__p1196144618478">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.78%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0805__p119611246124717">Specifies the tag list.</p>
|
|
<p id="sdrs_05_0805__p1582425517144">For details, see <a href="#sdrs_05_0805__table684444618473">Table 1</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0805__table684444618473"></a><a name="table684444618473"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0805__table684444618473" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0805__b19608639181116">resource_tag</strong> field description</caption><thead align="left"><tr id="sdrs_05_0805__row6961114614475"><th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="sdrs_05_0805__p179627461479"><strong id="sdrs_05_0805__b2022877353">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="sdrs_05_0805__p139621546154716"><strong id="sdrs_05_0805__b10252470">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.270000000000001%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="sdrs_05_0805__p11962174619471"><strong id="sdrs_05_0805__b967412638">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.04%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="sdrs_05_0805__p5962104694712"><strong id="sdrs_05_0805__b101259696">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0805__row1596254615471"><td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0805__p996217464474">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0805__p0962194644715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0805__p4962144644720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.04%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0805__p13546111671114">Specifies the tag key. The tag key of a resource must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row496204664713"><td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0805__p10962346174712">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0805__p1096224619477">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0805__p396284611472">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.04%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0805__p613413217119">Specifies the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0805__ul69621846164720"><li id="sdrs_05_0805__li1996220466474">Example response<pre class="screen" id="sdrs_05_0805__screen5125229111219">{
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"value": "value1"
|
|
},
|
|
{
|
|
"key": "key2",
|
|
"value": "value3"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0805__section486354618476"><h4 class="sectiontitle"><strong id="sdrs_05_0805__b842352706175024">Returned Value</strong></h4><ul id="sdrs_05_0805__ul169631463475"><li id="sdrs_05_0805__li129631746134718">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0805__table19866104694716" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0805__row7963134614470"><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_0805__p1696315467474"><strong id="sdrs_05_0805__b735922271">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_0805__p1596315467473"><strong id="sdrs_05_0805__b966432604">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0805__row396317469476"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="sdrs_05_0805__p17963154694714">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_0805__p11963184613472">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0805__ul896314615474"><li id="sdrs_05_0805__li139639462473">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0805__table1486854619478" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0805__row496334618471"><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_0805__p1696344615478"><strong id="sdrs_05_0805__b1250715306">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_0805__p6963184614475"><strong id="sdrs_05_0805__b235352455">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0805__row14963046204717"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0805__p09631146194710">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_0805__p396354619470">Invalid parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row7963104613472"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0805__p496313465475">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_0805__p0963184664715">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row11963846174710"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0805__p9963174612474">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_0805__p12963154664712">Insufficient permission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row59631464478"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0805__p199644460479">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_0805__p169641346134712">The requested resource was not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0805__row296464624720"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0805__p11964174611471">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_0805__p199641546124713">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>
|
|
|