forked from docs/doc-exports
wanghuijuan738
69783f9e3e
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com> Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
87 lines
12 KiB
HTML
87 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0000002374101049"></a><a name="EN-US_TOPIC_0000002374101049"></a>
|
|
|
|
<h1 class="topictitle1">Adding a Tag for a <span id="en-us_topic_0060410929_text93761115448">BMS</span><span id="en-us_topic_0060410929_text1297323418528"></span><span id="en-us_topic_0060410929_text7996114962919"></span></h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section63429208111321"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p37492253111321">This API is used to add a tag for a <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text199931213115315">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text10993513135319"></span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text18202195717299"></span>.</p>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p132131223182915">You are required to use the HTTP header <strong id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_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_0000002374101049__en-us_topic_0060410929_section26150540144115"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0057972840_ul3622491022280"><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_li34077530259">A BMS can have a maximum of 50 tags.</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0057972840_li5932847622280">The tag contains a maximum of 80 characters.</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0057972840_li2272046322280">The tag cannot start with a period (.).</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0057972840_li3490106422280">An empty tag cannot be created.</li></ul>
|
|
<div class="note" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_note63322819309"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p13512284304">It is recommended that you add the <strong id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_b104289514214">__type_baremetal</strong> tag to <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text1142812519424">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text134298534210"></span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text6429195184212"></span>s to distinguish <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text54297514214">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text24299515429"></span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text942917511428"></span>s from ECSs.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section1885963111321"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p25778225111321">PUT /v2.1/{project_id}/servers/{server_id}/tags/{tag}</p>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p196031646009"><a href="#EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_table19718185512020">Table 1</a> lists the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_table19718185512020"></a><a name="en-us_topic_0060410929_table19718185512020"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_table19718185512020" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_row371913559014"><th align="left" class="cellrowborder" valign="top" width="26.862686268626863%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p67050730103718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.402840284028404%" id="mcps1.3.3.4.2.4.1.2"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p62400032103718">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.73447344734473%" id="mcps1.3.3.4.2.4.1.3"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p21237868103718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_row207198551306"><td class="cellrowborder" valign="top" width="26.862686268626863%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p23650911103718">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.402840284028404%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p36675672103718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.73447344734473%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p17939461103718">Specifies the project ID.</p>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_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_0000002374101049__en-us_topic_0060410929_row1871913551206"><td class="cellrowborder" valign="top" width="26.862686268626863%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p18738546141829">server_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.402840284028404%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p41427238141829">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.73447344734473%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p163111141829">Specifies the <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text718713247535">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text1118792412539"></span> ID.</p>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0113746489_text1695320481317"></span> console or by calling the API <a href="en-us_topic_0000002340063012.html">Querying BMSs</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_row2071917554012"><td class="cellrowborder" valign="top" width="26.862686268626863%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p66048515144318">tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.402840284028404%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p48329483144318">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.73447344734473%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p133533233165">Specifies the tag information.</p>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p6856153762712">Constraints:</p>
|
|
<ul id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_ul31181225141619"><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_li0626182714165">The tag contains a maximum of 80 characters.</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_li7709113371617">The tag cannot start with a period (.).</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_li16118112511613">An empty tag cannot be created.</li><li id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_li11612039181616">URL encoding is required for special characters.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section26704907111321"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p137601466103">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section94551609276"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p3534330133612">Adding a tag for a <span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text8992548111218">BMS</span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text15803221423"></span><span id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_text205161451161216"></span> (ID: 53206ed0-56de-4d6b-b7ee-ffc62ca26f43)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_screen1784182410920"><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">PUT</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/{tag}</span>
|
|
</pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section6307065111321"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_p41110288111321">N/A</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_section27037160"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_p1271142611013">Normal values
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.7.2.1.1.3.1.1"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_p19735204616177">Returned Values</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.7.2.1.1.3.1.2"><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_p207355465176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_p13735144611178">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_p81516575011">The server has processed the request but did not return any content.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_en-us_topic_0053158659_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_0000002374101049__en-us_topic_0060410929_section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374101049__en-us_topic_0060410929_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_0000002374101045.html">BMS 1D Tag Management (OpenStack Nova APIs)</a></div>
|
|
</div>
|
|
</div>
|
|
|