vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2009.html
zhangyue ccbf63b495 EVS API DOC 
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>
2024-05-16 09:08:21 +00:00

497 lines
38 KiB
HTML
Raw Blame History

<a name="evs_04_2009"></a><a name="evs_04_2009"></a>
<h1 class="topictitle1">Updating an EVS Disk</h1>
<div id="body5057967"><div class="section" id="evs_04_2009__section41753265"><h4 class="sectiontitle">Function</h4><p id="evs_04_2009__p7042173">This API is used to update the name and description of an EVS disk. <span id="evs_04_2009__text580482414259"></span></p>
<div class="notice" id="evs_04_2009__note182951651102614"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="evs_04_2009__p29514165276">This API has been deprecated. Use another API. For details, see <a href="evs_04_2067.html">Updating an EVS Disk</a>.</p>
</div></div>
</div>
<div class="section" id="evs_04_2009__section1098713427369"><h4 class="sectiontitle">Debugging</h4><p id="evs_04_2009__p14988204214363">You can debug the API in which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.</p>
</div>
<div class="section" id="evs_04_2009__section40235071"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2009__ul33545144"><li id="evs_04_2009__li33470841">URI format<p id="evs_04_2009__p26783618"><a name="evs_04_2009__li33470841"></a><a name="li33470841"></a>PUT /v2/{project_id}/cloudvolumes/{volume_id}</p>
</li><li id="evs_04_2009__li39725971">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table21989419" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row9690616"><th align="left" class="cellrowborder" valign="top" width="22.62%" id="mcps1.3.3.2.2.1.1.4.1.1"><p id="evs_04_2009__p46742451">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.01%" id="mcps1.3.3.2.2.1.1.4.1.2"><p id="evs_04_2009__p28042199">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.370000000000005%" id="mcps1.3.3.2.2.1.1.4.1.3"><p id="evs_04_2009__p56825610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row39471735"><td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2009__p43093956">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.01%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2009__p949529">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.370000000000005%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2009__p9803039">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2009__row21118492"><td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2009__p32876269">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.01%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2009__p45732164">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.370000000000005%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2009__p13317766">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2009__section26571327"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2009__ul26172048914"><li id="evs_04_2009__li15617184813119">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table56177481416" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row19617104815119"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2009__p106178485120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2009__p1361817480115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2009__p161813481016">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2009__p76189487116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row146181485120"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2009__p1261817484111">volume</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2009__p1061818481218">Object</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2009__p176183483115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2009__p20618248316">The information of the disk to be updated. For details, see <a href="#evs_04_2009__li44975500">Parameters in the volume field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2009__ul4997277"><li id="evs_04_2009__li44975500"><a name="evs_04_2009__li44975500"></a><a name="li44975500"></a>Parameters in the <strong id="evs_04_2009__b1987817214264">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table2126321" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row49924131"><th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="evs_04_2009__p37408856172245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="evs_04_2009__p11847581">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="evs_04_2009__p20130041">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.43%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="evs_04_2009__p19920592">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row45067606"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="evs_04_2009__p26597492">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="evs_04_2009__p6913218">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="evs_04_2009__p10871744171339">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="evs_04_2009__p30183810114010">The new name of the disk. Parameters <strong id="evs_04_2009__b56012259122">name</strong> and <strong id="evs_04_2009__b76022516128">description</strong> cannot be null at the same time. The value can contain a maximum of 255 bytes.</p>
</td>
</tr>
<tr id="evs_04_2009__row62503562"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="evs_04_2009__p29623765">description</p>
</td>
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="evs_04_2009__p50714740">String</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="evs_04_2009__p14253264">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="evs_04_2009__p66104967114034">The new description of the disk. Parameters <strong id="evs_04_2009__b253593181417">name</strong> and <strong id="evs_04_2009__b15535036143">description</strong> cannot be null at the same time. The value can contain a maximum of 255 bytes.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2009__ul28722627"><li id="evs_04_2009__li57177053">Example request<pre class="screen" id="evs_04_2009__screen13806089161140">{
"volume": {
"name": "test_volume",
"description": "test"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2009__section37815352"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2009__ul968111320959"><li id="evs_04_2009__li2002115520959">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table27929698142532" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row42153167142532"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2009__p58963386142532">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2009__p11304974142532">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2009__p16640014142532">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row5663883142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p56121360142532">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p49536326142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p66719203142532">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2009__row63601923142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p51482101142532">links</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p9300668142532">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p19730920142532">The disk URI. For details, see <a href="#evs_04_2009__li949885516582">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2009__row43360557142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p22544263142532">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p14146042142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p624200142532">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2009__row5617804142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p52389016142532">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p15651871142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p15368644142532">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2009__row4100073142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p63670463142532">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p57033878142532">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p250469142532">The disk attachment information. For details, see <a href="#evs_04_2009__li2847936164017">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2009__row2254227142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p48374687142532">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p26035535142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p27087292142532">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2009__row42459044142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p16630559142532">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p4898051142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p58075939142532">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2009__p48931232104211">This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2009__row52921406142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p58775474142532">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p63192947142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p10363897142532">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2009__row26166216142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p39088784142532">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p12074920142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p35091945142532">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2009__row47392053142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p13551098142532">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p23897139142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p22825763142532">The ID of the tenant to which the disk belongs. The returned value is currently invalid. The tenant ID is the same as the project ID.</p>
</td>
</tr>
<tr id="evs_04_2009__row4105277142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p64092025142532">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p24071533142532">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p26176672142532">The metadata of the disk image. The returned value is currently invalid.</p>
<div class="note" id="evs_04_2009__note1151018162014"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2009__p1888154732118">For details about <strong id="evs_04_2009__b1583910241610">volume_image_metadata</strong>, see <strong id="evs_04_2009__b48471428167">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_2009__i1384712215164">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2009__row34263457142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p23876638142532">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p54959544142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p13644385142532">The time when the disk was created.</p>
<p id="evs_04_2009__p4374122920318">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2009__row55690602142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p14644931142532">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p45388732142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__evs_04_2010_p47786148539">The disk type.</p>
<div class="p" id="evs_04_2009__p12887229134510">The value can be <strong id="evs_04_2009__evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_2009__evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_2009__evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_2009__evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_2009__evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_2009__evs_04_2013_ul13901722818"><li id="evs_04_2009__evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_2009__evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_2009__evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_2009__evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_2009__evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_2009__evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_2009__evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_2009__evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_2009__evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_2009__evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2009__row32535337142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p18116679142532">size</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p58164905142532">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p38946139142532">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2009__row14970936142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p4686293142532">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p44045434142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><div class="p" id="evs_04_2009__evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_2009__ul185931714111"><li id="evs_04_2009__li135936114118"><strong id="evs_04_2009__b58361025162112">true</strong>: indicates a bootable disk.</li><li id="evs_04_2009__li1593611917"><strong id="evs_04_2009__b1130352812113">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2009__row34847734142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p4094237142532">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p63197743142532">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p41834554142532">The disk metadata. For details, see <a href="#evs_04_2009__li6221175494947">Parameters in the metadata field</a>.</p>
</td>
</tr>
<tr id="evs_04_2009__row40966670142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p29965975142532">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p11324945142532">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p13457143142532">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2009__row2027692114591"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p48928701145954">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p3801857145954">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__p46595553145954">Whether the disk is shareable.</p>
<div class="note" id="evs_04_2009__note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2009__p45212589213213">This field is no longer used. Use <strong id="evs_04_2009__b13571102213512">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2009__row54005424142532"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__evs_04_2013_p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__evs_04_2010_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__evs_04_2013_p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2009__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
<tr id="evs_04_2009__row36470043213458"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__p3792196213528">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__p38732436213528">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><div class="p" id="evs_04_2009__evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_2009__ul161621719119"><li id="evs_04_2009__li91631519818"><strong id="evs_04_2009__b22351428152219">true</strong>: indicates a shared disk.</li><li id="evs_04_2009__li1916311191410"><strong id="evs_04_2009__b1580183032218">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2009__row9244758141817"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2009__evs_04_2010_p978017142534">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2009__evs_04_2010_p12780191455320">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2009__evs_04_2010_p278051495317">The reserved field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2009__li949885516582"><a name="evs_04_2009__li949885516582"></a><a name="li949885516582"></a>Parameters in the <strong id="evs_04_2009__b84235270692535">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table44453603165834" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row67020808165834"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2009__p59976390165834">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2009__p43343669105259">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2009__p45826298165834">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row20942657165834"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2009__p18633648165834">href</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2009__p21176318105259">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2009__p50128425165834">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2009__row48502642165834"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2009__p36399890165834">rel</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2009__p37560167105259">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2009__p46341215165834">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2009__li2847936164017"><a name="evs_04_2009__li2847936164017"></a><a name="li2847936164017"></a>Parameters in the <strong id="evs_04_2009__b1408034320">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__table3307491164033" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__row21424691164033"><th align="left" class="cellrowborder" valign="top" width="21.687831216878315%" id="mcps1.3.5.2.3.2.1.4.1.1"><p id="evs_04_2009__p57678439164033">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.687831216878315%" id="mcps1.3.5.2.3.2.1.4.1.2"><p id="evs_04_2009__p66852304105349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.624337566243376%" id="mcps1.3.5.2.3.2.1.4.1.3"><p id="evs_04_2009__p1357476164033">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__row42846717164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p48032051164033">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p46327539105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p62170963164033">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2009__row22667763164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p24149511164033">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p61543187105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p919418164033">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2009__row57853019113651"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p50055523113657">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p27965571113657">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p6478808113657">The time when the disk was attached.</p>
<p id="evs_04_2009__p692624863119">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2009__row8274763164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p66276072164033">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p18942231105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p38983264164033">The name of the physical host housing the cloud server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2009__row15305060164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p31750372164033">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p57925736105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p8281462164033">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2009__row7424294164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p64496914164033">device</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p61473005105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p42870577164033">The device name.</p>
</td>
</tr>
<tr id="evs_04_2009__row50290878164033"><td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2009__p47029330164033">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.687831216878315%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2009__p13257486105349">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2009__p59986642164033">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2009__li6221175494947"><a name="evs_04_2009__li6221175494947"></a><a name="li6221175494947"></a>Parameters in the <strong id="evs_04_2009__b937215423231">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__evs_04_3004_row4496975195554"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.5.2.4.2.1.4.1.1"><p id="evs_04_2009__evs_04_3004_p8809200174410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.62%" id="mcps1.3.5.2.4.2.1.4.1.2"><p id="evs_04_2009__evs_04_3004_p168135017449">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.5.2.4.2.1.4.1.3"><p id="evs_04_2009__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__evs_04_3004_row456195295554"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2009__evs_04_3004_p1562408795622">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2009__evs_04_3004_p5759155095622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><div class="p" id="evs_04_2009__evs_04_3004_p177192813501">The encryption field in <strong id="evs_04_2009__b1667919212417">metadata</strong>.<ul id="evs_04_2009__evs_04_3004_ul141951225145011"><li id="evs_04_2009__evs_04_3004_li191951925125013"><strong id="evs_04_2009__b19559171817245">0</strong>: indicates a non-encrypted disk.</li><li id="evs_04_2009__evs_04_3004_li11195192510508"><strong id="evs_04_2009__b1636013122412">1</strong>: indicates an encrypted disk.</li><li id="evs_04_2009__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2009__evs_04_3004_row247050109562"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2009__evs_04_3004_p241272995622">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2009__evs_04_3004_p6121338895622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2009__evs_04_3004_p4159804295622">The encryption CMK ID in <strong id="evs_04_2009__b10203580262">metadata</strong>. This parameter is used together with <strong id="evs_04_2009__b52049810269">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2009__b19204118102613">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_2009__evs_04_3004_row60499086104915"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2009__evs_04_3004_p1478896104915">hw:passthrough</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2009__evs_04_3004_p52681767104915">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><div class="p" id="evs_04_2009__evs_04_3004_p17177177145116">The parameter that describes the disk device type in <strong id="evs_04_2009__b1095763218316">metadata</strong>. The value can be <strong id="evs_04_2009__b128991822123215">true</strong> or <strong id="evs_04_2009__b1051822633212">false</strong>.<ul id="evs_04_2009__evs_04_3004_ul14462208141855"><li id="evs_04_2009__evs_04_3004_li16942218141855"><strong id="evs_04_2009__b553261014331">true</strong> indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported.</li><li id="evs_04_2009__evs_04_3004_li42055621173515"><strong id="evs_04_2009__b718612433338">false</strong> indicates the Virtual Block Device (VBD) device type (the default type), which supports only simple SCSI read/write commands.</li><li id="evs_04_2009__evs_04_3004_li922714915316">If this parameter does not appear, the disk device type is VBD.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2009__evs_04_3004_row991210132288"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2009__evs_04_3004_p3500156018292">full_clone</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2009__evs_04_3004_p1655411118292">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2009__evs_04_3004_p47931946183150">The clone method. If the disk is created from a snapshot, value <strong id="evs_04_2009__b4292133310619">0</strong> indicates the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2009__li0419202382514"><a name="evs_04_2009__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2009__b1450053520375">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2009__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2009__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.5.2.1.4.1.1"><p id="evs_04_2009__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.5.2.1.4.1.2"><p id="evs_04_2009__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.5.2.1.4.1.3"><p id="evs_04_2009__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2009__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.1 "><p id="evs_04_2009__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.2 "><p id="evs_04_2009__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.5.2.1.4.1.3 "><p id="evs_04_2009__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2009__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.1 "><p id="evs_04_2009__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.2 "><p id="evs_04_2009__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.5.2.1.4.1.3 "><p id="evs_04_2009__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2009__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><li class="litext" id="evs_04_2009__li4811267162948">Example response<pre class="screen" id="evs_04_2009__screen45726576161229">{
"id": "36ba39af-3579-4e6e-adfc-b764349c0f77",
"links": [
{
"href": "https://volume.region.xxx.xxx-tsi.de/v2/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77",
"rel": "self"
},
{
"href": "https://volume.region.xxx.xxx-tsi.de/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77",
"rel": "bookmark"
}
],
"name": "newVolume",
"status": "in-use",
"attachments": [
{
"server_id": "c3d3250c-7ce5-42cc-b620-dd2b63d19ca5",
"attachment_id": "011a2bdb-a033-4479-845b-50bd8ed7f4d4",
"attached_at": "2017-05-23T11:27:38.604815",
"host_name": null,
"volume_id": "36ba39af-3579-4e6e-adfc-b764349c0f77",
"device": "/dev/sdf",
"id": "36ba39af-3579-4e6e-adfc-b764349c0f77"
}
],
"description": "new volume",
"multiattach": false,
"shareable": false,
"size": 10,
"metadata": {
"policy": "dc71a9c9-b3fa-429d-a070-037682d82d21",
"attached_mode": "rw",
"readonly": "False",
"hw:passthrough": "false"
},
"bootable": "false",
"availability_zone": "az-dc-1",
"os-vol-host-attr:host": null,
"source_volid": null,
"snapshot_id": null,
"created_at": "2017-05-23T09:49:44.481299",
"volume_type": "SAS",
"os-vol-tenant-attr:tenant_id": null,
"os-volume-replication:extended_status": null,
"volume_image_metadata": null
}</pre>
<p class="litext" id="evs_04_2009__p10940218">or</p>
<pre class="screen" id="evs_04_2009__screen10049057144415">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2009__section4793853"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2009__ul14643244"><li id="evs_04_2009__li64680333">Normal<p id="evs_04_2009__p45252091"><a name="evs_04_2009__li64680333"></a><a name="li64680333"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2009__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2009__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_2002.html">Disk Management</a></div>
</div>
</div>
View Git Blame Copy Permalink