forked from docs/doc-exports
lizaoxu
6d73dcaf41
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: lizaoxu <lizaoxu@huawei.com> Co-committed-by: lizaoxu <lizaoxu@huawei.com>
243 lines
16 KiB
HTML
243 lines
16 KiB
HTML
<a name="evs_04_4009"></a><a name="evs_04_4009"></a>
|
|
|
|
<h1 class="topictitle1">Modifying QoS of an EVS Disk</h1>
|
|
<div id="body0000001906839498"><div class="section" id="evs_04_4009__section8528184743016"><h4 class="sectiontitle">Function</h4><p id="evs_04_4009__p13528174763011">This API is used to change the IOPS or throughput of an EVS disk.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section35291447123010"><h4 class="sectiontitle">Constraints</h4><p id="evs_04_4009__p14529114719302">The disk must be in the <strong id="evs_04_4009__b9781132191616">available</strong> or <strong id="evs_04_4009__b828162641613">in-use</strong> state. For a General Purpose SSD V2 disk, both the IOPS and throughput can be changed. This API is not supported for other types of EVS disks.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section1753034743016"><h4 class="sectiontitle">URI</h4><p id="evs_04_4009__p165301947183018">PUT /v5/{project_id}/cloudvolumes/{volume_id}/qos</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__table175311547133015" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="evs_04_4009__row17530347133010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="evs_04_4009__p853114719303">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="evs_04_4009__p753174773015">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="evs_04_4009__p153210478306">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="evs_04_4009__p8532144712304">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row3530154733011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="evs_04_4009__p14532147113017">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="evs_04_4009__p1953244716307">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="evs_04_4009__p1953304703013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="evs_04_4009__p1753312471301">The project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_4009__row15301847183012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="evs_04_4009__p55338478304">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="evs_04_4009__p1453315474308">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="evs_04_4009__p2533347133015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="evs_04_4009__p1853417477301">The disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section8534184733010"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="evs_04_4009__row353416479306"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="evs_04_4009__p85351147173015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="evs_04_4009__p1353511475306">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="evs_04_4009__p10535124723016">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="evs_04_4009__p1353610478304">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row2534847183016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="evs_04_4009__p75361479308">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="evs_04_4009__p2053617470309">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="evs_04_4009__p6536147133018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="evs_04_4009__p105366477306">The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="evs_04_4009__b46065301919">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__request_ModifyVolumeQoSRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="evs_04_4009__row17537164719307"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="evs_04_4009__p165371947103015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="evs_04_4009__p053784763013">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="evs_04_4009__p3537124703013">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="evs_04_4009__p14537154793016">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row11537147193020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="evs_04_4009__p353894710308">qos_modify</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="evs_04_4009__p17538174714301">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="evs_04_4009__p153844720301"><a href="#evs_04_4009__request_ModifyVolumeQoSOption">ModifyVolumeQoSOption</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="evs_04_4009__p145381647183019">The disk QoS change marker.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="evs_04_4009__request_ModifyVolumeQoSOption"></a><a name="request_ModifyVolumeQoSOption"></a><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__request_ModifyVolumeQoSOption" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ModifyVolumeQoSOption</caption><thead align="left"><tr id="evs_04_4009__row7538174712304"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="evs_04_4009__p1753944717309">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="evs_04_4009__p1853904733016">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="evs_04_4009__p125392476303">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="evs_04_4009__p165391547183018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row953884718302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="evs_04_4009__p1753915474302">iops</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="evs_04_4009__p1353934715306">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="evs_04_4009__p453915477306">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="evs_04_4009__p135401347123013">The new maximum IOPS of the disk. Only General Purpose SSD V2 disks are supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_4009__row4538174718300"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="evs_04_4009__p1854074717304">throughput</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="evs_04_4009__p754074743014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="evs_04_4009__p554094717307">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="evs_04_4009__p19540164763014">The new maximum throughput of the disk, in the unit of MiB/s. This parameter is only supported for General Purpose SSD V2 disks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section12541147123013"><h4 class="sectiontitle">Response Parameters</h4><p id="evs_04_4009__p18541164713304"><strong id="evs_04_4009__b348624242013">Status code: 202</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__response_JobResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="evs_04_4009__row254113472308"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="evs_04_4009__p254294743010">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="evs_04_4009__p2542124718301">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="evs_04_4009__p17542154718302">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row16541164716307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="evs_04_4009__p185421047143011">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="evs_04_4009__p154274733013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="evs_04_4009__p2054215473301">The task ID.</p>
|
|
<div class="note" id="evs_04_4009__note18542347153011"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_4009__p5543134733018">To query the task status, see <a href="evs_04_0054.html">Querying Task Status</a>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="evs_04_4009__p8543104718300"><strong id="evs_04_4009__b5372141111210">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__response_ErrorResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameter</caption><thead align="left"><tr id="evs_04_4009__row19543174723013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="evs_04_4009__p2054354716307">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="evs_04_4009__p16543747103012">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="evs_04_4009__p754354715308">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row5543104711305"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="evs_04_4009__p125441347183014">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="evs_04_4009__p95449475309"><a href="#evs_04_4009__response_Error">Error</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="evs_04_4009__p115441347173018">The error code returned if an error occurs. For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="evs_04_4009__response_Error"></a><a name="response_Error"></a><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__response_Error" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Error</caption><thead align="left"><tr id="evs_04_4009__row35446473305"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="evs_04_4009__p95441647113016">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="evs_04_4009__p15545204733019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="evs_04_4009__p8545947163014">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row95441047173014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="evs_04_4009__p17545104763019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="evs_04_4009__p65451347143014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="evs_04_4009__p8545164773019">The error code returned if an error occurs. For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_4009__row15544124711307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="evs_04_4009__p16545164718305">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="evs_04_4009__p1354518479306">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="evs_04_4009__p12545847163011">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section1954520474300"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="evs_04_4009__screen9546184716302">PUT https://{endpoint}/v5/{project_id}/cloudvolumes/{volume_id}/qos
|
|
|
|
{
|
|
"qos_modify" : {
|
|
"iops" : 10000,
|
|
"throughput" : 200
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section1554612478308"><h4 class="sectiontitle">Example Responses</h4><p id="evs_04_4009__p175461147163014"><strong id="evs_04_4009__b169214432204">Status code: 202</strong></p>
|
|
<p id="evs_04_4009__p654754719303">Accepted</p>
|
|
<pre class="screen" id="evs_04_4009__screen13547147113012">{
|
|
"job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
|
|
}</pre>
|
|
<p id="evs_04_4009__p25473471304"><strong id="evs_04_4009__b103351812152119">Status code: 400</strong></p>
|
|
<p id="evs_04_4009__p12547547133011">Bad Request</p>
|
|
<pre class="screen" id="evs_04_4009__screen1354716474305">{
|
|
"error" : {
|
|
"code" : "XXXX",
|
|
"message" : "XXX"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section17764194712308"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_4009__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_4009__row4560204719306"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="evs_04_4009__p37642477308">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="evs_04_4009__p14764144723020">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_4009__row115604476308"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="evs_04_4009__p776412479304">202</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="evs_04_4009__p276444723020">Accepted</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_4009__row056004793017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="evs_04_4009__p1764114783019">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="evs_04_4009__p1176411471305">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="evs_04_4009__section19764247123012"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_4009__p19765104713303">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>
|
|
|