# 云硬盘类型变更 - RetypeVolume #### 功能介绍 对按需或者包周期云硬盘进行云硬盘类型变更。在云硬盘类型变更包周期云硬盘的场景下：- 如果您需要查看订单可用的优惠券，请参考"[查询订单可用优惠券](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/zh-cn_topic_0082522030.html)"。 #### 调用方法 请参见[如何调用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:retype | Write | volume \* | - g:ResourceTag/\ - g:EnterpriseProjectId - evs:VolumeType | - | billing:order:pay | #### URI POST /v2/{project_id}/volumes/{volume_id}/retype 表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请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bssParam | 否 | [BssParamForRetypeVolume] object | **参数解释** 包周期云硬盘retype才需要传入该字段 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | os-retype | 是 | [RetypeVolume] object | **参数解释** 变更云硬盘类型的请求体。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表3BssParamForRetypeVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | isAutoPay | 否 | String | **参数解释** 功能说明：是否立即支付。 **约束限制** 该参数只有在云硬盘为包周期的情况下有意义。默认值为false **取值范围** - true：立即支付，从账户余额中自动扣费 - false：不立即支付，创建订单暂不支付 **默认取值** false | 表4RetypeVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | new_type | 是 | String | **参数解释** 变更至指定的云硬盘类型，目前支持"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"，"ESSD2"六种。 了解不同云硬盘类型的详细信息，请参见[云硬盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 **约束限制** 1.当指定的云硬盘类型在availability_zone内不存在时，则变更云硬盘类型失败; 2.原类型为SAS时，可以变更到上述的其他任意类型; 3.原类型包含SSD时，可以retype到其他包含SSD的类型，但不能retype到SAS; **取值范围** "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 "ESSD"为极速型SSD云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 **默认取值** 不涉及。 | | iops | 否 | Integer | **参数解释** 云硬盘iops大小。 **约束限制** 只有GPSSD2或ESSD2两种类型才能使用该参数。 **取值范围** Integer整型。 取值请参见[云硬盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)。 **默认取值** 不涉及。 | | throughput | 否 | Integer | **参数解释** 云硬盘的吞吐量大小。 **约束限制** 只有GPSSD2类型才能使用该参数。 **取值范围** Integer整型。 取值请参见[云硬盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)。 **默认取值** 不涉及。 | #### 响应参数 **状态码：202** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | **参数解释** 订单ID，云硬盘为包周期计费时返回该参数。 说明： 如果您需要支付订单，请参考："[支付包周期产品订单](https://support.huaweicloud.com/api-oce/api_order_00030.html)"。 **取值范围** 不涉及。 | | 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 | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 描述错误消息的字符串 | #### 请求示例 - 包周期的云硬盘变更云硬盘类型到SSD类型，并且设置为自动支付。 ``` POST https://{endpoint}/v2/{project_id}/volumes/{volume_id}/retype { "os-retype" : { "new_type" : "SSD" }, "bssParam" : { "isAutoPay" : "true" } } ``` - 按需或者包周期的云硬盘变更云硬盘类型到SSD类型。 ``` POST https://{endpoint}/v2/{project_id}/volumes/{volume_id}/retype { "os-retype" : { "new_type" : "SSD" } } ``` #### 响应示例 **状态码：202** Accepted - 示例 1 ``` { "job_id" : "xxx" } ``` - 示例 2 ``` ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "XXX" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] - 包周期的云硬盘变更云硬盘类型到SSD类型，并且设置为自动支付。 ``` 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 RetypeVolumeSolution { 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("")) .build(); RetypeVolumeRequest request = new RetypeVolumeRequest(); request.withVolumeId("{volume_id}"); RetypeVolumeRequestBody body = new RetypeVolumeRequestBody(); RetypeVolume osretypebody = new RetypeVolume(); osretypebody.withNewType("SSD"); BssParamForRetypeVolume bssParambody = new BssParamForRetypeVolume(); bssParambody.withIsAutoPay(BssParamForRetypeVolume.IsAutoPayEnum.fromValue("true")); body.withOsRetype(osretypebody); body.withBssParam(bssParambody); request.withBody(body); try { RetypeVolumeResponse response = client.retypeVolume(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()); } } } ``` - 按需或者包周期的云硬盘变更云硬盘类型到SSD类型。 ``` 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 RetypeVolumeSolution { 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("")) .build(); RetypeVolumeRequest request = new RetypeVolumeRequest(); request.withVolumeId("{volume_id}"); RetypeVolumeRequestBody body = new RetypeVolumeRequestBody(); RetypeVolume osretypebody = new RetypeVolume(); osretypebody.withNewType("SSD"); body.withOsRetype(osretypebody); request.withBody(body); try { RetypeVolumeResponse response = client.retypeVolume(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] - 包周期的云硬盘变更云硬盘类型到SSD类型，并且设置为自动支付。 ``` # 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("")) \ .build() try: request = RetypeVolumeRequest() request.volume_id = "{volume_id}" osretypebody = RetypeVolume( new_type="SSD" ) bssParambody = BssParamForRetypeVolume( is_auto_pay="true" ) request.body = RetypeVolumeRequestBody( os_retype=osretypebody, bss_param=bssParambody ) response = client.retype_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) ``` - 按需或者包周期的云硬盘变更云硬盘类型到SSD类型。 ``` # 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("")) \ .build() try: request = RetypeVolumeRequest() request.volume_id = "{volume_id}" osretypebody = RetypeVolume( new_type="SSD" ) request.body = RetypeVolumeRequestBody( os_retype=osretypebody ) response = client.retype_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] - 包周期的云硬盘变更云硬盘类型到SSD类型，并且设置为自动支付。 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) request := &model.RetypeVolumeRequest{} request.VolumeId = "{volume_id}" osretypebody := &model.RetypeVolume{ NewType: "SSD", } isAutoPayBssParam:= model.GetBssParamForRetypeVolumeIsAutoPayEnum().TRUE bssParambody := &model.BssParamForRetypeVolume{ IsAutoPay: &isAutoPayBssParam, } request.Body = &model.RetypeVolumeRequestBody{ OsRetype: osretypebody, BssParam: bssParambody, } response, err := client.RetypeVolume(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - 按需或者包周期的云硬盘变更云硬盘类型到SSD类型。 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) request := &model.RetypeVolumeRequest{} request.VolumeId = "{volume_id}" osretypebody := &model.RetypeVolume{ NewType: "SSD", } request.Body = &model.RetypeVolumeRequestBody{ OsRetype: osretypebody, } response, err := client.RetypeVolume(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=RetypeVolume)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 202 | Accepted | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。