forked from laiweijian4/doc-exports
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
173 lines
12 KiB
HTML
173 lines
12 KiB
HTML
<a name="sdrs_05_0806"></a><a name="sdrs_05_0806"></a>
|
|
|
|
<h1 class="topictitle1">Querying Tags of All Protected Instances in a Specified Project</h1>
|
|
<div id="body1548216603526"><div class="section" id="sdrs_05_0806__section1986421154818"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0806__p6103122213484">This API is used to query all resource tags of a protected instance in a specified project.</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0806__section598614216482"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0806__ul20103192219487"><li id="sdrs_05_0806__li141031122194815">URI format<p id="sdrs_05_0806__p8103112254817"><a name="sdrs_05_0806__li141031122194815"></a><a name="li141031122194815"></a>GET /v1/{project_id}/protected-instances/tags</p>
|
|
</li><li id="sdrs_05_0806__li91031822114817">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0806__table698812134817" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0806__row71033220480"><th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sdrs_05_0806__p91039224483"><strong id="sdrs_05_0806__b842352706162023">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.9%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sdrs_05_0806__p510314222487"><strong id="sdrs_05_0806__b84235270615447">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.370000000000001%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sdrs_05_0806__p101031522124820"><strong id="sdrs_05_0806__b84235270615453">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.14%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sdrs_05_0806__p111033221486"><strong id="sdrs_05_0806__b84235270615457">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0806__row1710482224815"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sdrs_05_0806__p61043220484">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.9%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sdrs_05_0806__p16104422134818">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.370000000000001%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sdrs_05_0806__p4104122104818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.14%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sdrs_05_0806__p17104162204817">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0806__section199272115482"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0806__ul152481059113819"><li id="sdrs_05_0806__li35872213104">Request parameters<p id="sdrs_05_0806__p456716268107"><a name="sdrs_05_0806__li35872213104"></a><a name="li35872213104"></a>None</p>
|
|
</li><li id="sdrs_05_0806__li0248135923814">Example request<p id="sdrs_05_0806__p11936228154213"><a name="sdrs_05_0806__li0248135923814"></a><a name="li0248135923814"></a>GET https://{Endpoint}/v1/{project_id}/protected-instances/tags</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0806__section15992132118483"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0806__ul1910462214486"><li id="sdrs_05_0806__li151048228484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0806__table4995142119483" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0806__row71041522144811"><th align="left" class="cellrowborder" valign="top" width="10.31103110311031%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0806__p1510472224819"><strong id="sdrs_05_0806__b1785805781">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.77257725772577%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="sdrs_05_0806__p21041522124812"><strong id="sdrs_05_0806__b965805995">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.491649164916492%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="sdrs_05_0806__p3104202212485"><strong id="sdrs_05_0806__b919225881">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.42474247424743%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="sdrs_05_0806__p710452217480"><strong id="sdrs_05_0806__b1809715572">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0806__row1610492234812"><td class="cellrowborder" valign="top" width="10.31103110311031%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0806__p810413220488">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.77257725772577%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0806__p10104132210483">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.491649164916492%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0806__p8104622164819">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.42474247424743%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0806__p51041522134815">Specifies the tag list.</p>
|
|
<p id="sdrs_05_0806__p18245114391515">For details, see <a href="#sdrs_05_0806__table09990210488">Table 1</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0806__table09990210488"></a><a name="table09990210488"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0806__table09990210488" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure of the <strong id="sdrs_05_0806__b776713121198">tag</strong> field</caption><thead align="left"><tr id="sdrs_05_0806__row1910412264814"><th align="left" class="cellrowborder" valign="top" width="9.180000000000001%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="sdrs_05_0806__p51041822104817"><strong id="sdrs_05_0806__b1046959087">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="sdrs_05_0806__p10104112234815"><strong id="sdrs_05_0806__b1748919731">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="sdrs_05_0806__p19104822204816"><strong id="sdrs_05_0806__b873763076">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.96%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="sdrs_05_0806__p010542217484"><strong id="sdrs_05_0806__b1348814305">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0806__row81051522144818"><td class="cellrowborder" valign="top" width="9.180000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0806__p1105172264814">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0806__p2010519228482">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0806__p181051122104816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.96%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0806__p16938773138">Specifies the tag key. The tag key of a resource must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0806__row410512226486"><td class="cellrowborder" valign="top" width="9.180000000000001%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0806__p410572224817">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0806__p710512284811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0806__p5105132215482">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.96%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0806__p7808113171318">Lists the tag values.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0806__ul141055222485"><li id="sdrs_05_0806__li14105122204811">Example response<pre class="screen" id="sdrs_05_0806__screen58152038201419">{
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"values": [
|
|
"value1",
|
|
"value2"
|
|
]
|
|
},
|
|
{
|
|
"key": "key2",
|
|
"values": [
|
|
"value1",
|
|
"value2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0806__section1212182214816"><h4 class="sectiontitle"><strong id="sdrs_05_0806__b842352706175024">Returned Value</strong></h4><ul id="sdrs_05_0806__ul171051722194818"><li id="sdrs_05_0806__li710511223484">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0806__table19142225485" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0806__row6105222114818"><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_0806__p141051122124817"><strong id="sdrs_05_0806__b199704167">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_0806__p191051922144815"><strong id="sdrs_05_0806__b1352202850">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0806__row31051822194814"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="sdrs_05_0806__p3105112234810">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_0806__p1110512212485">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0806__ul11106162212484"><li id="sdrs_05_0806__li14106192219489">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0806__table16167225487" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0806__row101064228487"><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_0806__p41061722154810"><strong id="sdrs_05_0806__b1033520620">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_0806__p21067227488"><strong id="sdrs_05_0806__b1267288395">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0806__row310618226488"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0806__p20106112220487">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_0806__p1510617226482">Invalid parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0806__row510672294820"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0806__p9106192212484">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_0806__p6106112284814">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0806__row4106222114810"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0806__p8106142294820">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_0806__p1810617229480">Insufficient permission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0806__row10106182214814"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0806__p13106622144820">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_0806__p15106192212482">The requested resource was not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0806__row810672218488"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.3.1.1.1.3.1.1 "><p id="sdrs_05_0806__p161067227484">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_0806__p121071622174812">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>
|
|
|