Modifying QoS of an EVS Disk
Function
This API is used to change the IOPS or throughput of an EVS disk.
Constraints
The disk must be in the available or in-use 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.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
PUT /v5/{project_id}/cloudvolumes/{volume_id}/qos
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition The project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
|
volume_id |
Yes |
String |
Definition The disk ID. You can call the Querying Details About All EVS Disks API to obtain the disk ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition The user token. You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
qos_modify |
Yes |
ModifyVolumeQoSOption object |
Definition The disk QoS modification marker. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
iops |
Yes |
Integer |
Definition The new IOPS configured for the disk. Constraints This parameter is only supported for general purpose SSD V2 disks. To learn the IOPS ranges of general purpose SSD V2 disks, see the EVS performance data table in Disk Types and Performance. Range N/A Default Value N/A |
|
throughput |
No |
Integer |
Definition The new throughput configured for the disk, in MiB/s. Constraints This parameter is only mandatory for general purpose SSD V2 disks. To learn the throughput range of general purpose SSD V2 disks, see the table of EVS performance data in Disk Types and Performance. Range N/A Default Value N/A |
Response Parameters
Status code: 202
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Definition The task ID returned if the response is normal. To query the task status, see Querying Task Status. Range N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
Error object |
Definition The error code returned if an error occurs. For details about the error code, see Error Codes. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition The error code returned if an error occurs. Range For details about the error code, see Error Codes. |
|
message |
String |
Definition The error message returned if an error occurs. Range N/A |
Example Requests
PUT https://{endpoint}/v5/{project_id}/cloudvolumes/{volume_id}/qos
{
"qos_modify" : {
"iops" : 10000,
"throughput" : 200
}
}
Example Responses
Status code: 202
Accepted
{
"job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}
Status code: 400
Bad Request
{
"error" : {
"code" : "XXXX",
"message" : "XXX"
}
}
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class ModifyVolumeQoSSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); ModifyVolumeQoSRequest request = new ModifyVolumeQoSRequest(); request.withVolumeId("{volume_id}"); ModifyVolumeQoSRequestBody body = new ModifyVolumeQoSRequestBody(); ModifyVolumeQoSOption qosModifybody = new ModifyVolumeQoSOption(); qosModifybody.withIops(10000) .withThroughput(200); body.withQosModify(qosModifybody); request.withBody(body); try { ModifyVolumeQoSResponse response = client.modifyVolumeQoS(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ModifyVolumeQoSRequest() request.volume_id = "{volume_id}" qosModifybody = ModifyVolumeQoSOption( iops=10000, throughput=200 ) request.body = ModifyVolumeQoSRequestBody( qos_modify=qosModifybody ) response = client.modify_volume_qo_s(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ModifyVolumeQoSRequest{} request.VolumeId = "{volume_id}" throughputQosModify:= int32(200) qosModifybody := &model.ModifyVolumeQoSOption{ Iops: int32(10000), Throughput: &throughputQosModify, } request.Body = &model.ModifyVolumeQoSRequestBody{ QosModify: qosModifybody, } response, err := client.ModifyVolumeQoS(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
202 |
Accepted |
|
400 |
Bad Request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot