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_0053158665.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

159 lines
15 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0053158665"></a><a name="EN-US_TOPIC_0053158665"></a>
<h1 class="topictitle1">Querying Information About a Disk Attached to a <span id="text93761115448">BMS</span><span id="text24331146103818"></span><span id="text144271954495"></span> (Native OpenStack API)</h1>
<div id="body53517117"><div class="section" id="EN-US_TOPIC_0053158665__section21764736"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158665__p39919257">This API is used to query information about a single disk attached to a <span id="EN-US_TOPIC_0053158665__text587515603916">BMS</span><span id="EN-US_TOPIC_0053158665__text1947382572"></span><span id="EN-US_TOPIC_0053158665__text8841159194910"></span> based on the disk ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0053158665__section61664903"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158665__p45830725163226">GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}</p>
<p id="EN-US_TOPIC_0053158665__p1555338155020"><a href="#EN-US_TOPIC_0053158665__table17269134917502">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158665__table17269134917502"></a><a name="table17269134917502"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158665__table17269134917502" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158665__row127284919508"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0053158665__p52189740">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_0053158665__p66619401">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_0053158665__p27462382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158665__row5272549205014"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p3763337517142">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_0053158665__p2840453517142">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_0053158665__p1906601217142">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0053158665__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_0053158665__row139591881618"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p139602087161">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_0053158665__p1960128101613">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_0053158665__p1196018841619">Specifies the <span id="EN-US_TOPIC_0053158665__text4129123919189">BMS</span><span id="EN-US_TOPIC_0053158665__text9130839131815"></span><span id="EN-US_TOPIC_0053158665__text191301339161814"></span> ID.</p>
<p id="EN-US_TOPIC_0053158665__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158665__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158665__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_0053158665__row92726495508"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p2068039117144">volume_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_0053158665__p6449900717144">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_0053158665__p5703706317144">Specifies the EVS disk ID.</p>
<p id="EN-US_TOPIC_0053158665__p1765372715476">You can query attached EVS disks attached to a <span id="EN-US_TOPIC_0053158665__text1798918157392">BMS</span><span id="EN-US_TOPIC_0053158665__text10990131533919"></span><span id="EN-US_TOPIC_0053158665__text114684354498"></span> using the <a href="en-us_topic_0053158658.html">Querying Information About the Disks Attached to a BMS (Native OpenStack API)</a> API.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0053158665__section18113219"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158665__ul1959483604818"><li id="EN-US_TOPIC_0053158665__li058819141077">Request parameters<p id="EN-US_TOPIC_0053158665__p103171419174"><a name="EN-US_TOPIC_0053158665__li058819141077"></a><a name="li058819141077"></a>None</p>
</li><li id="EN-US_TOPIC_0053158665__li159483654819">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158665__screen11295444204810"><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/os-volume_attachments/b53f23bd-ee8f-49ec-9420-d1acfeaf91d6</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158665__section28801245"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0053158665__ul22819790"><li id="EN-US_TOPIC_0053158665__li59737867">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158665__table769899" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158665__row6968742"><th align="left" class="cellrowborder" valign="top" width="28.4%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0053158665__p19987085">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0053158665__p4546697">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.910000000000004%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0053158665__p32738149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158665__row13299239"><td class="cellrowborder" valign="top" width="28.4%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0053158665__p3496541">volumeAttachment</p>
</td>
<td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0053158665__p56686067">Object</p>
</td>
<td class="cellrowborder" valign="top" width="46.910000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0053158665__p52192065">Specifies information about the disk attached to the <span id="EN-US_TOPIC_0053158665__text047892014396">BMS</span><span id="EN-US_TOPIC_0053158665__text174787201398"></span><span id="EN-US_TOPIC_0053158665__text23451518537"></span>. For details, see <a href="#EN-US_TOPIC_0053158665__table42716605">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158665__table42716605"></a><a name="table42716605"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158665__table42716605" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0053158665__b449712232010">volumeAttachment</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158665__row6429"><th align="left" class="cellrowborder" valign="top" width="28.050000000000004%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0053158665__p144716112213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.39%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0053158665__p184476111218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.56%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0053158665__p0448211142115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158665__row54793251"><td class="cellrowborder" valign="top" width="28.050000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p9068361">device</p>
</td>
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158665__p39066822">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158665__p25555552">Specifies the mount directory, for example, <strong id="EN-US_TOPIC_0053158665__b16720191214261">/dev/vdb</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158665__row28673382"><td class="cellrowborder" valign="top" width="28.050000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p40842582">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158665__p2490560">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158665__p3679585">Specifies the ID of the attached resource.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158665__row33116269"><td class="cellrowborder" valign="top" width="28.050000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p65172112">serverId</p>
</td>
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158665__p43655223">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158665__p15056362">Specifies the ID of the <span id="EN-US_TOPIC_0053158665__text23081423133911">BMS</span><span id="EN-US_TOPIC_0053158665__text6308152312398"></span><span id="EN-US_TOPIC_0053158665__text12938156155313"></span> to which the disks are attached.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158665__row1289536"><td class="cellrowborder" valign="top" width="28.050000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158665__p37343614">volumeId</p>
</td>
<td class="cellrowborder" valign="top" width="24.39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158665__p64098994">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158665__p20397636">Specifies the ID of the disk attached to the BMS.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0053158665__ul44228662103650"><li id="EN-US_TOPIC_0053158665__li62513644103650">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158665__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>
<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;volumeAttachment&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;device&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;/dev/vdb&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;serverId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;b53f23bd-ee8f-49ec-9420-d1acfeaf91d6&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;volumeId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;b53f23bd-ee8f-49ec-9420-d1acfeaf91d6&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158665__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158665__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158665__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158665__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_0053158665__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_0053158665__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158665__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_0053158665__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_0053158665__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0053158665__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_0053158665__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0053158665__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_0053158703.html">BMS Disk Management</a></div>
</div>
</div>
View Git Blame Copy Permalink