yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/bms/api-ref/en-us_topic_0000002340222796.html
wanghuijuan738 69783f9e3e bms api 20241225 version 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
2025-07-16 09:58:55 +00:00

143 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002340222796"></a><a name="EN-US_TOPIC_0000002340222796"></a>
<h1 class="topictitle1">Obtaining a Remote Login Address</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_section1125851317285"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_en-us_topic_0067161469_p31584679103330">This API is used to obtain the address for remotely logging in to a <span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text266731472811">BMS</span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text7802430369"></span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text549771912419"></span>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_section19554105810284"><h4 class="sectiontitle">URL</h4><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p2504581615492">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p015112417377"><a href="#EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table31631432103712">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table31631432103712"></a><a name="en-us_topic_0108366160_table31631432103712"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table31631432103712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row16164113293716"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p43085863">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p294000">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p23814038">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row416413214372"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p14468758">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p31118786">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p37593705">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_row171646322373"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p2736446410235">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p192907210235">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_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_p2203711610235">Specifies the <span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text9275275637230">BMS</span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text12611993077230"></span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text2968740637230"></span> ID.</p>
<p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_section5584133923217"><h4 class="sectiontitle">Request Message</h4><ul id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_ul19521195705516"><li id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li10521185719557">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table35213579554" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row105201357185519"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p18116184413616">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row2521457155515"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p13520135710557">os-getSerialConsole</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p5521357155513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p12520857105512">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p19521105715552">Specifies the action to obtain a <span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text14190568409">BMS</span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text18193562405"></span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text151925644013"></span> remote login address. For details, see <a href="#EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table3521155775514">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table3521155775514"></a><a name="en-us_topic_0108366160_table3521155775514"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_table3521155775514" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_b1112716431234">os-getSerialConsole</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row9521125719553"><th align="left" class="cellrowborder" valign="top" width="19.19191919191919%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p211418441261">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p845916191835">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.2020202020202%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p17115144417617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.39393939393939%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p1811614411610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_row652105719554"><td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p1521257185516">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p545915198319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p95211157125516">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p11521175719556">Specifies the object. Set the value to <strong id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_b842352706205944">serial</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li62636515443">Example request<div class="p" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p98071527145012"><a name="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li62636515443"></a><a name="en-us_topic_0108366160_li62636515443"></a>Obtaining the remote login address of a <span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text680116004111">BMS</span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text16801180184113"></span><span id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_text1680116016413"></span> (ID: 47e9be4e-a7b9-471f-92d9-ffc83814e07a)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_screen693873717106"><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">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action</span>
</pre></div></td></tr></table></div>
</div>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_screen14582442111835"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;os-getSerialConsole&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;serial&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_en-us_topic_0067161469_en-us_topic_0057973179_section41457614"><h4 class="sectiontitle">Response Message</h4><ul id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_ul13808111412458"><li id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li102027281232">Response parameters<p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_p92967328310"><a name="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li102027281232"></a><a name="en-us_topic_0108366160_li102027281232"></a>None</p>
</li><li id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_li1969102034510">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0092803065_screen688245011191"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;console&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://baremetal-consoleproxy.az1.dc1.domainname.com:8003/?token=040134bb-9195-4029-9a62-550bce390258&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="n">type</span><span class="s">&quot;: &quot;</span><span class="n">serial</span><span class="s">&quot;</span>
<span class="s"> }</span>
<span class="s">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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_0000002340222796__en-us_topic_0108366160_section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002340222796__en-us_topic_0108366160_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_0000002374260869.html">BMS Status Management (OpenStack Nova APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink