
# 扩容云硬盘 - ResizeVolume
#### 功能介绍
对按需或者包周期云硬盘进行扩容。
在扩容包周期云硬盘的场景下：
- 如果您需要查看订单可用的优惠券，请参考"[查询订单可用优惠券](https://support.huaweicloud.com/api-oce/api_order_00015.html)"。
  
- 如果您需要支付订单，请参考"[支付包周期产品订单](https://support.huaweicloud.com/api-oce/api_order_00030.html)"。
  
- 如果您需要查询订单的资源开通详情，请参考"[查询订单的资源开通详情](https://support.huaweicloud.com/api-oce/api_order_00001.html)"。
  
- 如果您需要退订该包周期资源，请参考"[退订包周期资源](https://support.huaweicloud.com/api-oce/api_order_00019.html)"。
  
- 扩容接口采用异步通知的方式实现。扩容完成时，不会修改云盘分区和文件系统，您需要在扩容后自行分配存储空间。
  
 
#### 接口约束
- 扩容状态为available的云硬盘时，没有约束限制。
  
- 扩容状态为in-use的云硬盘时，有以下约束：
  - 不支持共享云硬盘，即multiattach参数值必须为false。
    
  
  - 云硬盘所挂载的云服务器状态必须为ACTIVE、PAUSED、SUSPENDED、SHUTOFF才支持扩容。
    
   
 
#### 调用方法
请参见[如何调用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:resize | Write | volume \*   | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId   - evs:VolumeSize    | evs:volumes:extend | billing:order:pay |
     
  
 
#### URI
POST /v2.1/{project_id}/cloudvolumes/{volume_id}/action
表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参数 
| 参数        | 是否必选 | 参数类型                                                                              | 描述                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| bssParam  | 否    | [BssParamForResizeVolume] object | **参数解释** 按需和包周期的扩展参数。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 |
| os-extend | 是    | [OsExtend] object                               | **参数解释** 标记扩容云硬盘操作。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。   |
   
 表4BssParamForResizeVolume 
| 参数        | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| isAutoPay | 否    | String | **参数解释** 功能说明：是否立即支付。 **约束限制** 该参数只有在云硬盘为包周期的情况下有意义。 **取值范围** - true：立即支付，从账户余额中自动扣费   - false：不立即支付，创建订单暂不支付    **默认取值** false |
   
 表5OsExtend 
| 参数       | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| new_size | 是    | Integer | **参数解释** 扩容后的云硬盘大小，单位为GiB。 **约束限制** 扩容的大小必须大于原有云硬盘容量且小于云硬盘最大容量。 云硬盘最大容量： - 数据盘：32768GiB   - 系统盘：1024GiB    **取值范围** 不涉及。 **默认取值** 不涉及。 |
   
#### 响应参数
**状态码：202**
表6响应Body参数 
| 参数       | 参数类型   | 描述                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| job_id   | String | **参数解释** 任务ID，云硬盘为按需计费时返回该参数。 如果需要查询job的状态，请参考[查询job的状态](https://support.huaweicloud.com/api-evs/evs_04_0054.html)。 **取值范围** 不涉及。       |
| order_id | String | **参数解释** 订单ID，云硬盘为包周期计费时返回该参数。 如果您需要支付订单，请参考："[支付包周期产品订单](https://support.huaweicloud.com/api-oce/api_order_00016.html)"。 **取值范围** 不涉及。 |
   
**状态码：400**
表7响应Body参数 
| 参数    | 参数类型                                           | 描述                                                                                                                                                                                                                              |
|:---|:---|:---|
| error | [Error] object | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 包含错误码和错误消息的对象 |
   
 表8Error 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                 |
|:---|:---|:---|
| code    | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 |
| message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 描述错误消息的字符串                                                                     |
   
#### 请求示例
扩容云硬盘，扩容后的云硬盘大小为100GiB，立即支付扩容费用，且从账户余额中自动扣费。
```
POST https://{endpoint}/v2.1/{project_id}/cloudvolumes/{volume_id}/action
{
  "os-extend" : {
    "new_size" : 100
  },
  "bssParam" : {
    "isAutoPay" : "true"
  }
}
```
#### 响应示例
**状态码：202**
Accepted
```
{
  "order_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}
```
**状态码：400**
Bad Request
```
{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  扩容云硬盘，扩容后的云硬盘大小为100GiB，立即支付扩容费用，且从账户余额中自动扣费。
  ```
  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 ResizeVolumeSolution {
      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();
          ResizeVolumeRequest request = new ResizeVolumeRequest();
          request.withVolumeId("{volume_id}");
          ResizeVolumeRequestBody body = new ResizeVolumeRequestBody();
          OsExtend osextendbody = new OsExtend();
          osextendbody.withNewSize(100);
          BssParamForResizeVolume bssParambody = new BssParamForResizeVolume();
          bssParambody.withIsAutoPay(BssParamForResizeVolume.IsAutoPayEnum.fromValue("true"));
          body.withOsExtend(osextendbody);
          body.withBssParam(bssParambody);
          request.withBody(body);
          try {
              ResizeVolumeResponse response = client.resizeVolume(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]
  扩容云硬盘，扩容后的云硬盘大小为100GiB，立即支付扩容费用，且从账户余额中自动扣费。
  ```
  # 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 = ResizeVolumeRequest()
          request.volume_id = "{volume_id}"
          osextendbody = OsExtend(
              new_size=100
          )
          bssParambody = BssParamForResizeVolume(
              is_auto_pay="true"
          )
          request.body = ResizeVolumeRequestBody(
              os_extend=osextendbody,
              bss_param=bssParambody
          )
          response = client.resize_volume(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]
  扩容云硬盘，扩容后的云硬盘大小为100GiB，立即支付扩容费用，且从账户余额中自动扣费。
  ```
  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.ResizeVolumeRequest{}
  request.VolumeId = "{volume_id}"
  osextendbody := &model.OsExtend{
  NewSize: int32(100),
  }
  isAutoPayBssParam:= model.GetBssParamForResizeVolumeIsAutoPayEnum().TRUE
  bssParambody := &model.BssParamForResizeVolume{
  IsAutoPay: &isAutoPayBssParam,
  }
  request.Body = &model.ResizeVolumeRequestBody{
  OsExtend: osextendbody,
  BssParam: bssParambody,
  }
  response, err := client.ResizeVolume(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=ResizeVolume)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 202 | Accepted    |
| 400 | Bad Request |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。
