doc-exports/docs/bms/api-ref/en-us_topic_0060410926.html
guoyanyan c311ecafe3 bms_api_0510
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

110 lines
9.6 KiB
HTML

<a name="EN-US_TOPIC_0060410926"></a><a name="EN-US_TOPIC_0060410926"></a>
<h1 class="topictitle1">Querying <span id="text93761115448">BMS</span><span id="text36861541204020"></span><span id="text634618221894"></span> Tags (Native OpenStack API)</h1>
<div id="body1495513488158"><div class="section" id="EN-US_TOPIC_0060410926__section17769131"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0060410926__p25168144103718">This API is used to query all tags of a <span id="EN-US_TOPIC_0060410926__text428634574019">BMS</span><span id="EN-US_TOPIC_0060410926__text1947382572"></span><span id="EN-US_TOPIC_0060410926__text1079413548912"></span>.</p>
<p id="EN-US_TOPIC_0060410926__en-us_topic_0057972837_p58041982596">You are required to use the HTTP header <strong id="EN-US_TOPIC_0060410926__b842352706165643">X-OpenStack-Nova-API-Version: 2.26</strong> to specify the micro version on the client.</p>
</div>
<div class="section" id="EN-US_TOPIC_0060410926__section40393097103718"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0060410926__p33773005141737">GET /v2.1/{project_id}/servers/{server_id}/tags</p>
<p id="EN-US_TOPIC_0060410926__p685092355817"><a href="#EN-US_TOPIC_0060410926__table0142163245812">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0060410926__table0142163245812"></a><a name="table0142163245812"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0060410926__table0142163245812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0060410926__row51434323581"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0060410926__p67050730103718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.2"><p id="EN-US_TOPIC_0060410926__p62400032103718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.3"><p id="EN-US_TOPIC_0060410926__p21237868103718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0060410926__row01430322585"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0060410926__p23650911103718">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0060410926__p36675672103718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0060410926__p17939461103718">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0060410926__p9141450142010">For how to obtain the project ID, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328009.html" target="_blank" rel="noopener noreferrer">Obtaining Required Information</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0060410926__row1114316327585"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0060410926__p18738546141829">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0060410926__p41427238141829">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0060410926__p163111141829">Specifies the <span id="EN-US_TOPIC_0060410926__text6592195064020">BMS</span><span id="EN-US_TOPIC_0060410926__text13592175024015"></span><span id="EN-US_TOPIC_0060410926__text7536818131014"></span> ID.</p>
<p id="EN-US_TOPIC_0060410926__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0060410926__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0060410926__en-us_topic_0113746489_text10131448133612"></span> console or by calling the <a href="en-us_topic_0053158693.html">Querying BMSs (Native OpenStack API)</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0060410926__section43810255103718"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0060410926__ul6856914466"><li id="EN-US_TOPIC_0060410926__li1216519912915">Request parameters<p id="EN-US_TOPIC_0060410926__p655321215914"><a name="EN-US_TOPIC_0060410926__li1216519912915"></a><a name="li1216519912915"></a>None</p>
</li><li id="EN-US_TOPIC_0060410926__li18561114961">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0060410926__screen13212152310610"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">GET</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0060410926__section60965769103718"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0060410926__ul57761257185333"><li id="EN-US_TOPIC_0060410926__li50089268185333">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0060410926__table48150236185333" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0060410926__row64499137185333"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0060410926__p19987085">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0060410926__p4546697">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.66%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0060410926__p32738149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0060410926__row51055328185333"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0060410926__p41840919185333">tags</p>
</td>
<td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0060410926__p9620104510414">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0060410926__p51647808185333">Specifies user-defined tags of a BMS.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0060410926__ul44228662103650"><li id="EN-US_TOPIC_0060410926__li62513644103650">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0060410926__screen4690257120289"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;baz&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;qux&quot;</span>
<span class="w"> </span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0060410926__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.3.1.1"><p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.3.1.2"><p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0060410926__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0060410926__en-us_topic_0106040941_p10243161417491">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0060410925.html">BMS 1D Tag Management</a></div>
</div>
</div>