doc-exports/docs/evs/api-ref/evs_04_2085.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

165 lines
12 KiB
HTML

<a name="evs_04_2085"></a><a name="evs_04_2085"></a>
<h1 class="topictitle1">Setting Read-Only Flag for an EVS Disk</h1>
<div id="body1493902424383"><div class="section" id="evs_04_2085__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_2085__p50301879">This API is used to set the read-only flag for the EVS disk.</p>
</div>
<div class="section" id="evs_04_2085__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2085__ul47920438"><li id="evs_04_2085__li28630766">URI format<p id="evs_04_2085__p44289360"><a name="evs_04_2085__li28630766"></a><a name="li28630766"></a>POST /v2/{project_id}/volumes/{volume_id}/action</p>
</li><li id="evs_04_2085__li971734">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2085__table8745607" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2085__row15985080"><th align="left" class="cellrowborder" valign="top" width="23.74%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2085__p19723089">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2085__p54066375">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.01%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2085__p17300225">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2085__row59140967"><td class="cellrowborder" valign="top" width="23.74%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2085__p25689059">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2085__p439002">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2085__p35559222">Specifies the project ID.</p>
</td>
</tr>
<tr id="evs_04_2085__row51597550"><td class="cellrowborder" valign="top" width="23.74%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2085__p18651996">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2085__p34416674">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.01%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2085__p36287209">Specifies the disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2085__section27129916"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2085__ul61836145"><li id="evs_04_2085__li19654399">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2085__table42671863" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2085__row12592542"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_2085__p13362997">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="evs_04_2085__p8661001">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.05%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_2085__p30452481">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_2085__p50731910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2085__row5187493615377"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_2085__p4112025815377">os-update_readonly_flag</p>
</td>
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="evs_04_2085__p4240658415377">Object</p>
</td>
<td class="cellrowborder" valign="top" width="18.05%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_2085__p1238131615377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_2085__p6336250715377">Specifies the disk read-only flag. For details, see <a href="#evs_04_2085__li55520608111457">Parameter in the os-update_readonly_flag field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2085__li55520608111457"><a name="evs_04_2085__li55520608111457"></a><a name="li55520608111457"></a>Parameter in the <strong id="evs_04_2085__b15954111744317">os-update_readonly_flag</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2085__table38065209105423" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2085__row47014882105423"><th align="left" class="cellrowborder" valign="top" width="19.17%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="evs_04_2085__p50109122105423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.669999999999998%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="evs_04_2085__p32307099105423">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.86%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="evs_04_2085__p66738196105423">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="evs_04_2085__p37084757105423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2085__row65642867105423"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_2085__p1874528111511">readonly</p>
</td>
<td class="cellrowborder" valign="top" width="17.669999999999998%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_2085__p45274007105423">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_2085__p43315944105423">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><div class="p" id="evs_04_2085__p18930541105423">Specifies the read-only flag.<ul id="evs_04_2085__ul4954137112218"><li id="evs_04_2085__li119541137202213"><strong id="evs_04_2085__b1846332111818">true</strong>: specifies the disk is read-only.</li><li id="evs_04_2085__li695423782213"><strong id="evs_04_2085__b326591715916">false</strong>: specifies the disk is not read-only.</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2085__li52840473">Example request<pre class="screen" id="evs_04_2085__screen37660345164036">{
"os-update_readonly_flag": {
"readonly": true
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2085__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2085__ul221411327369"><li id="evs_04_2085__li15527813121252">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2085__table5532594121252" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2085__row60048709121252"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2085__p32107236121252">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2085__p50549312121252">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2085__p2030156121252">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2085__row30224973121252"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2085__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2085__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2085__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2085__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2085__li0419202382514"><a name="evs_04_2085__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2085__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2085__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2085__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2085__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2085__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2085__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2085__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2085__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2085__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2085__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2085__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2085__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2085__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2085__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2085__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_2085__ul2889143711911"><li id="evs_04_2085__li2903350411916">Example response<p id="evs_04_2085__p57112307111233"><a name="evs_04_2085__li2903350411916"></a><a name="li2903350411916"></a>None</p>
<p id="evs_04_2085__p52821068113531">or</p>
<pre class="screen" id="evs_04_2085__screen4594167995947">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2085__p5655715720175">In the preceding example, <strong id="evs_04_2085__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2085__b842352706144438">badRequest</strong> or <strong id="evs_04_2085__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2085__screen50777049152511">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2085__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2085__ul5136981"><li id="evs_04_2085__li46232835">Normal<p id="evs_04_2085__p13442339"><a name="evs_04_2085__li46232835"></a><a name="li46232835"></a>202</p>
</li></ul>
</div>
<div class="section" id="evs_04_2085__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2085__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>