vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/bms/api-ref/en-us_topic_0053158662.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

146 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0053158662"></a><a name="EN-US_TOPIC_0053158662"></a>
<h1 class="topictitle1">Querying the Specified IP Address of a <span id="text68606276113">BMS</span><span id="text1633718395557"></span><span id="text13715133210508"></span> (Native OpenStack API)</h1>
<div id="body1464590256141"><div class="section" id="EN-US_TOPIC_0053158662__section53922917165259"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158662__p5680132165259">This API is used to query the specified IP address of a <span id="EN-US_TOPIC_0053158662__text1240114985511">BMS</span><span id="EN-US_TOPIC_0053158662__text444753132119"></span><span id="EN-US_TOPIC_0053158662__text12158144143813"></span> based on the network name.</p>
</div>
<div class="section" id="EN-US_TOPIC_0053158662__section51121191165259"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158662__p63141473165259">GET /v2.1/{project_id}/servers/{server_id}/ips/{vpc_id}</p>
<p id="EN-US_TOPIC_0053158662__p17943142984017"><a href="#EN-US_TOPIC_0053158662__table6532183934016">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158662__table6532183934016"></a><a name="table6532183934016"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158662__table6532183934016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158662__row1753243915409"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0053158662__p58268319165259">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_0053158662__p22113407165259">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_0053158662__p46355523165259">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158662__row253363924014"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158662__p1217433165259">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_0053158662__p31503226165259">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_0053158662__p1624545165259">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0053158662__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_0053158662__row45331439194017"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158662__p43442641165259">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_0053158662__p29193009165259">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_0053158662__p15823538165259">Specifies the <span id="EN-US_TOPIC_0053158662__text5570105012265">BMS</span><span id="EN-US_TOPIC_0053158662__text1257155072616"></span><span id="EN-US_TOPIC_0053158662__text155711950202613"></span> ID.</p>
<p id="EN-US_TOPIC_0053158662__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158662__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158662__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>
<tr id="EN-US_TOPIC_0053158662__row853312391409"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158662__p39194593144447">vpc_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_0053158662__p20645494144447">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_0053158662__p37275314377">Specifies the ID of the VPC where the <span id="EN-US_TOPIC_0053158662__text61205995512">BMS</span><span id="EN-US_TOPIC_0053158662__text71859185516"></span><span id="EN-US_TOPIC_0053158662__text19650311391"></span> is located.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0053158662__section8194118165259"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158662__ul412175141615"><li id="EN-US_TOPIC_0053158662__li1910515151250">Request parameters<p id="EN-US_TOPIC_0053158662__p35936184516"><a name="EN-US_TOPIC_0053158662__li1910515151250"></a><a name="li1910515151250"></a>None</p>
</li><li id="EN-US_TOPIC_0053158662__li0121125191619">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158662__screen196411597164"><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/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/ips/{vpc_id}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158662__section58140617165259"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0053158662__ul319912614467"><li id="EN-US_TOPIC_0053158662__li6383462914467">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158662__table56891490143956" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158662__row33903869143956"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0053158662__p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0053158662__p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.629999999999995%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0053158662__p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158662__row178261036111713"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0053158662__p198876476174">Vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0053158662__p188714714172">Array of <a href="#EN-US_TOPIC_0053158662__table22651992144025">address</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.629999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0053158662__p520445315187">Specifies the VPC used by the <span id="EN-US_TOPIC_0053158662__text1246211519504">BMS</span><span id="EN-US_TOPIC_0053158662__text1740611559503"></span>.</p>
<p id="EN-US_TOPIC_0053158662__p139131765312"><strong id="EN-US_TOPIC_0053158662__b1067184102718">Vpc_id</strong> indicates the ID of the VPC used by the <span id="EN-US_TOPIC_0053158662__text867124132712">BMS</span><span id="EN-US_TOPIC_0053158662__text136754192711"></span>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158662__table22651992144025"></a><a name="table22651992144025"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158662__table22651992144025" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Network parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158662__row15576094144025"><th align="left" class="cellrowborder" valign="top" width="25.040000000000003%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0053158662__p18294205151113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.96%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0053158662__p52953511116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0053158662__p1329719531112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158662__row1498246144025"><td class="cellrowborder" valign="top" width="25.040000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158662__p54249095144025">version</p>
</td>
<td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158662__p32100540144025">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158662__p16571197144025">Specifies the IP address version. The value can be:</p>
<ul id="EN-US_TOPIC_0053158662__ul95681331131713"><li id="EN-US_TOPIC_0053158662__en-us_topic_0053158696_li15758161811618"><strong id="EN-US_TOPIC_0053158662__en-us_topic_0053158696_b9297191175814">4</strong>: IPv4 address</li><li id="EN-US_TOPIC_0053158662__en-us_topic_0053158696_li20821181331619"><strong id="EN-US_TOPIC_0053158662__en-us_topic_0053158696_b17364111518584">6</strong>: IPv6 address</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158662__row14923052144025"><td class="cellrowborder" valign="top" width="25.040000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158662__p807709144025">addr</p>
</td>
<td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158662__p65424470144025">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158662__p39086769144025">Specifies the IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0053158662__ul18214269144035"><li id="EN-US_TOPIC_0053158662__li44533297144035">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158662__screen14793741143113"><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>
<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;5849fdf1-9d79-4589-80c2-fe557990c417&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;addr&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;192.168.1.159&quot;</span>
<span class="w"> </span><span class="p">}</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_0053158662__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158662__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158662__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158662__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_0053158662__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_0053158662__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158662__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_0053158662__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_0053158662__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0053158662__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_0053158662__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0053158662__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_0053158688.html">BMS IP Address Query</a></div>
</div>
</div>
View Git Blame Copy Permalink