forked from docs/doc-exports
Li, Qiao
914011d51b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
145 lines
10 KiB
HTML
145 lines
10 KiB
HTML
<a name="waf_02_0094"></a><a name="waf_02_0094"></a>
|
|
|
|
<h1 class="topictitle1">Querying Resource Tags</h1>
|
|
<div id="body1558942309611"><div class="section" id="waf_02_0094__section79301226153615"><h4 class="sectiontitle">Function Description</h4><p id="waf_02_0094__p33684291364">This API is used to query tags of a specified resource.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0094__section1965417568362"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0094__ul1965355133718"><li id="waf_02_0094__li12653751374">URI format<p id="waf_02_0094__p041972553718"><a name="waf_02_0094__li12653751374"></a><a name="li12653751374"></a>GET /v1/{project_id}/waf/{resource_id}/tags</p>
|
|
</li><li id="waf_02_0094__li5249537153716">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0094__table758313673815" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0094__row186701764386"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0094__p14670196183818"><strong id="waf_02_0094__b14406153463414">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0094__p1670867388"><strong id="waf_02_0094__b18360183519347">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0094__p567096153812"><strong id="waf_02_0094__b136976364346">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0094__p867026183812"><strong id="waf_02_0094__b107991937103413">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0094__row176708617388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0094__p5670465380">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0094__p206708623819">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0094__p4670116103814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0094__p10670768389">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0094__row567016620385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0094__p1167018614381">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0094__p156703619389">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0094__p767096173815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0094__p967019610382">Specifies the resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0094__section119207313917"><h4 class="sectiontitle">Request</h4><p id="waf_02_0094__p19315653912">Request parameters</p>
|
|
<p id="waf_02_0094__p5995141283910">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0094__section112228103910"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0094__p129972071406">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0094__table14570551153918" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0094__row2593751203917"><th align="left" class="cellrowborder" valign="top" width="33.69%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0094__p559315112391"><strong id="waf_02_0094__b10790185511342">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.94%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0094__p059345163910"><strong id="waf_02_0094__b1420614413351">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.37%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0094__p559345123914"><strong id="waf_02_0094__b67010613354">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0094__row18594105115393"><td class="cellrowborder" valign="top" width="33.69%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0094__p1059425114390">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.94%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0094__p359419516393"><a href="#waf_02_0094__table19869193719405">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.37%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0094__p15941051113914">Specifies the tag list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0094__row113280719225"><td class="cellrowborder" valign="top" width="33.69%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0094__p5329117162220">toatl</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.94%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0094__p1132957122219">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.37%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0094__p12329476222">Specifies the number of tags.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0094__table19869193719405"></a><a name="table19869193719405"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0094__table19869193719405" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags</caption><thead align="left"><tr id="waf_02_0094__row129021237174016"><th align="left" class="cellrowborder" valign="top" width="33.690000000000005%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0094__p179021337164019"><strong id="waf_02_0094__b1247143183520">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.99%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0094__p19903123714406"><strong id="waf_02_0094__b17617532113514">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.320000000000004%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0094__p16903173717405"><strong id="waf_02_0094__b54101233143514">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0094__row990343704012"><td class="cellrowborder" valign="top" width="33.690000000000005%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0094__p14903193774017">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.99%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0094__p6903937154011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.320000000000004%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0094__p5903163744011">Specifies the key. It contains a maximum of 36 Unicode characters.</p>
|
|
<p id="waf_02_0094__p18903237184013">The key value must comply with <a href="waf_02_0086.html">Character Set Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0094__row859181234114"><td class="cellrowborder" valign="top" width="33.690000000000005%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0094__p9991121314117">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.99%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0094__p109918133414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.320000000000004%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0094__p209917137411">Specifies the value. Each value contains a maximum of 43 Unicode characters.</p>
|
|
<p id="waf_02_0094__p159918131416">The value must comply with <a href="waf_02_0086.html">Character Set Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0094__section1579955124218"><h4 class="sectiontitle">Example</h4><p id="waf_02_0094__p202671349114210"></p>
|
|
<div class="p" id="waf_02_0094__p1526754913426">Response example<pre class="screen" id="waf_02_0094__screen1326718492428">{
|
|
"total": 2,
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"value": "value1"
|
|
},
|
|
{
|
|
"key": "key2",
|
|
"value": "value3"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0094__section18355930174311"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0094__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0094__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0094__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0094__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="waf_02_0094__waf_02_0012_r3d6e2f205c444705bdbb9daaac74e575"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.2.4.1.1"><p id="waf_02_0094__waf_02_0012_af3c4073076f24eca88d94e3fa1effdc6">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.6.2.2.2.4.1.2"><p id="waf_02_0094__waf_02_0012_en-us_topic_0144911667_p4531342288">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.6.2.2.2.4.1.3"><p id="waf_02_0094__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0094__waf_02_0012_rc7b2adc390904a1ba79e303017797786"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="waf_02_0094__waf_02_0012_a93f3895d44bb4226934cc626ac50e37b">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="waf_02_0094__waf_02_0012_en-us_topic_0144911667_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="waf_02_0094__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0094__waf_02_0012_en-us_topic_0144911667_p482819399522">For details about error status codes, see <a href="waf_02_0085.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0091.html">Interconnection with TMS</a></div>
|
|
</div>
|
|
</div>
|
|
|