
# 修改云硬盘QoS - ModifyVolumeQoS
#### 功能介绍
调整云硬盘的iops或者吞吐量。
#### 接口约束
云硬盘状态是available、in-use。
GPSSD2类型云硬盘允许修改iops和吞吐量，ESSD2类型云硬盘允许修改iops，其他类型云硬盘不支持。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                   | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | 别名                 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | evs:volumes:modifyQos | Write | volume \*   | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId   - evs:VolumeIops   - evs:VolumeThroughput    | evs:volumes:extend | -      |
     
  
 
#### URI
PUT /v5/{project_id}/cloudvolumes/{volume_id}/qos
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。                                        |
| volume_id  | 是    | String | **参数解释** 云硬盘ID。 可通过[查询所有云硬盘详情](https://support.huaweicloud.com/api-evs/evs_04_2006.html)获取云硬盘ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 |
   
表3请求Body参数 
| 参数         | 是否必选 | 参数类型                                                                        | 描述                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| qos_modify | 是    | [ModifyVolumeQoSOption] object | **参数解释** 标记修改云硬盘QoS操作。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 |
   
 表4ModifyVolumeQoSOption 
| 参数         | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| iops       | 是    | Integer | **参数解释** 修改后的云硬盘iops。 **约束限制** 只支持GPSSD2、ESSD2类型的云硬盘。 了解GPSSD2、ESSD2类型的iops大小范围，请参见[云硬盘类型及性能介绍里面的云硬盘性能数据表](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **取值范围** 不涉及。 **默认取值** 不涉及。    |
| throughput | 否    | Integer | **参数解释** 修改后的云硬盘吞吐量，单位是MiB/s。 **约束限制** GPSSD2类型云盘必须填写，其他类型不能填写。 了解GPSSD2类型的吞吐量大小范围，请参见[云硬盘类型及性能介绍里面的云硬盘性能数据表](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **取值范围** 不涉及。 **默认取值** 不涉及。 |
   
#### 响应参数
**状态码：202**
表5响应Body参数 
| 参数     | 参数类型   | 描述                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| job_id | String | **参数解释** 正常返回时返回的任务ID。 如果需要查询job的状态，请参考[查询job的状态](https://support.huaweicloud.com/api-evs/evs_04_0054.html)。 **取值范围** 不涉及。 |
   
**状态码：400**
表6响应Body参数 
| 参数    | 参数类型                                         | 描述                                                                                                                                                                                                                        |
|:---|:---|:---|
| error | [Error] object | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 包含错误码和错误消息的对象 |
   
 表7Error 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                           |
|:---|:---|:---|
| code    | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 |
| message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 描述错误消息的字符串                                                                     |
   
#### 请求示例
```
PUT https://{endpoint}/v5/{project_id}/cloudvolumes/{volume_id}/qos
{
  "qos_modify" : {
    "iops" : 10000,
    "throughput" : 200
  }
}
```
#### 响应示例
**状态码：202**
Accepted
```
{
  "job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}
```
**状态码：400**
Bad Request
```
{
  "error" : {
    "code" : "XXXX",
    "message" : "XXX"
  }
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  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]
  ```
  # 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]
  ```
  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, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := evs.EvsClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := evs.NewEvsClient(hcClient)
      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)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EVS/sdk?api=ModifyVolumeQoS)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 202 | Accepted    |
| 400 | Bad Request |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。
