forked from docs/doc-exports
zhangyue
ccbf63b495
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
169 lines
12 KiB
HTML
169 lines
12 KiB
HTML
<a name="evs_04_2088"></a><a name="evs_04_2088"></a>
|
|
|
|
<h1 class="topictitle1">Detaching an EVS Disk (Deprecated)</h1>
|
|
<div id="body1493902424372"><div class="section" id="evs_04_2088__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_2088__p50301879">This API is only used to change the EVS disk status from <strong id="evs_04_2088__b84235270617450">in-use</strong> to <strong id="evs_04_2088__b84235270617457">available</strong>.</p>
|
|
<div class="notice" id="evs_04_2088__note6325143016124"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="evs_04_2088__p3239196016124">This API call exists for compatibility reasons only and is not meant to be used.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section58153866104128"><h4 class="sectiontitle">Constraints</h4><p id="evs_04_2088__p3504380616043">Do not call this API to detach a disk. If you need to detach a disk, call the ECS Detach Volume API. </p>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2088__ul47920438"><li id="evs_04_2088__li28630766">URI format<p id="evs_04_2088__p44289360"><a name="evs_04_2088__li28630766"></a><a name="li28630766"></a>POST /v2/{project_id}/volumes/{volume_id}/action</p>
|
|
</li><li id="evs_04_2088__li971734">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2088__table8745607" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2088__row15985080"><th align="left" class="cellrowborder" valign="top" width="23.18%" id="mcps1.3.3.2.2.1.1.4.1.1"><p id="evs_04_2088__p19723089">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.81%" id="mcps1.3.3.2.2.1.1.4.1.2"><p id="evs_04_2088__p54066375">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.01%" id="mcps1.3.3.2.2.1.1.4.1.3"><p id="evs_04_2088__p17300225">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2088__row59140967"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2088__p25689059">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2088__p439002">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2088__p35559222">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2088__row51597550"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2088__p18651996">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.81%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2088__p34416674">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2088__p36287209">Specifies the disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section27129916"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2088__ul61836145"><li id="evs_04_2088__li19654399">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2088__table42671863" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2088__row12592542"><th align="left" class="cellrowborder" valign="top" width="19.17%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2088__p13362997">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2088__p8661001">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2088__p30452481">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2088__p50731910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2088__row5187493615377"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2088__p4112025815377">os-detach</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2088__p4240658415377">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2088__p1238131615377">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2088__p6336250715377">Specifies disk detachment marker.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2088__li11686008105423">Parameter in the <strong id="evs_04_2088__b717255516356">os-detach</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2088__table38065209105423" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2088__row47014882105423"><th align="left" class="cellrowborder" valign="top" width="19.17%" id="mcps1.3.4.2.2.2.1.5.1.1"><p id="evs_04_2088__p50109122105423">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.4.2.2.2.1.5.1.2"><p id="evs_04_2088__p32307099105423">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.4.2.2.2.1.5.1.3"><p id="evs_04_2088__p66738196105423">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.4.2.2.2.1.5.1.4"><p id="evs_04_2088__p37084757105423">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2088__row65642867105423"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2088__p15472019105423">attachment_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2088__p45274007105423">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2088__p43315944105423">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><p id="evs_04_2088__p18930541105423">Specifies the attachment ID. If the disk has only one attachment, this parameter is optional. If it has multiple attachments, the parameter is optional.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2088__li52840473">Example request<pre class="screen" id="evs_04_2088__screen30463931163811">POST https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214/action
|
|
{
|
|
"os-detach": {
|
|
"attachment_id": "d8777f54-84cf-4809-a679-468ffed56cf1"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2088__ul221411327369"><li id="evs_04_2088__li15527813121252">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2088__table5532594121252" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2088__row60048709121252"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2088__p32107236121252">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2088__p50549312121252">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2088__p2030156121252">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2088__row30224973121252"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2088__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2088__p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2088__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2088__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2088__li0419202382514"><a name="evs_04_2088__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2088__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2088__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2088__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2088__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2088__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2088__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2088__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2088__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2088__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2088__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2088__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2088__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2088__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2088__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2088__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="evs_04_2088__ul2889143711911"><li id="evs_04_2088__li2903350411916">Example response<p id="evs_04_2088__p57112307111233"><a name="evs_04_2088__li2903350411916"></a><a name="li2903350411916"></a>None</p>
|
|
<p id="evs_04_2088__p52821068113531">or</p>
|
|
<pre class="screen" id="evs_04_2088__screen1193617152126">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2088__p5655715720175">In the preceding example, <strong id="evs_04_2088__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2088__b842352706144438">badRequest</strong> or <strong id="evs_04_2088__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2088__screen4166083152144">{
|
|
"itemNotFound": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2088__ul5136981"><li id="evs_04_2088__li46232835">Normal<p id="evs_04_2088__p13442339"><a name="evs_04_2088__li46232835"></a><a name="li46232835"></a>202</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2088__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2088__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2064.html">Disk Management</a></div>
|
|
</div>
|
|
</div>
|
|
|