Help Center/ Elastic Volume Service/ API Reference/ API/ Disk Management/ Changing the Disk Type
Updated on 2025-08-20 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Changing the Disk Type

Function

This API is used to change the disk type of a pay-per-use or yearly/monthly disk. - - - -

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/volumes/{volume_id}/retype

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

For details about how to obtain the project ID, 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 obtain it on the disk list page of the EVS console.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

-

Yes

Object

Definition

The request body for changing the disk type.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 RetypeVolumeRequestBody

Parameter

Mandatory

Type

Description

bssParam

No

BssParamForRetypeVolume object

Definition

This field is only required when you are changing the disk type for a yearly/monthly disk.

Constraints

N/A

Range

N/A

Default Value

N/A

os-retype

Yes

RetypeVolume object

Definition

The request body for changing the disk type.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 BssParamForRetypeVolume

Parameter

Mandatory

Type

Description

isAutoPay

No

String

Definition

Whether to pay immediately.

Constraints

This parameter is only valid when the disk is billed on a yearly/monthly basis. The default value is false.

Range

  • true: indicates to pay immediately after an order is created. The system will automatically deduct charges from the account balance.

  • false: An order is not paid immediately after being created.

Default Value

false
Table 5 RetypeVolume

Parameter

Mandatory

Type

Description

new_type

Yes

String

Definition

The new disk type you want to change to. Supported values are SAS, GPSSD, SSD, ESSD, GPSSD2, and ESSD2.

For details about disk types, see

Disk Types and Performance.

Constraints

  • If the specified disk type is not available in the AZ, the disk type change will fail.

  • If the source disk type is backed by SAS, you can change the disk type to any of the other types.

  • If the source disk type is backed by SSD, you can only change to another SSD-backed disk type, but not the SAS-backed type.

Range

SAS: the high I/O type

GPSSD: the general purpose SSD type

SSD: the ultra-high I/O type

ESSD: the extreme SSD type

GPSSD2: the general purpose SSD V2 type

ESSD2: the extreme SSD V2 type

Default Value

N/A

iops

No

Integer

Definition

The disk IOPS.

Constraints

This parameter is only used for general purpose SSD V2 or extreme SSD V2 disks.

Range

N/A

Default Value

N/A

throughput

No

Integer

Definition

The disk throughput.

Constraints

This parameter is only used for general purpose SSD V2 disks.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 6 Response body parameters

Parameter

Type

Description

order_id

String

Definition

The order ID. This parameter is returned when the disk is billed on a yearly/monthly basis. For details about how to query the task status, see Querying Task Status.

Range

N/A

job_id

String

Definition

The task ID. This parameter is returned when the disk is billed on a pay-per-use basis. If you need to pay for the order, see "Paying for the Order of Yearly/Monthly Resources."

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error code returned if an error occurs. For the error codes and their meanings, see Error Codes.

Range

N/A
Table 8 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For the error codes and their meanings, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

  • Changing a yearly/monthly disk to an SSD-backed disk type and configuring auto payment

    https://{endpoint}/v2/{project_id}/volumes/{volume_id}/retype

{
  "os-retype" : {
    "new_type" : "SSD"
  },
  "bssParam" : {
    "isAutoPay" : "true"
  }
}

  • Changing a pay-per-use or yearly/monthly disk to an SSD-backed disk type

    https://{endpoint}/v2/{project_id}/volumes/{volume_id}/retype

{
  "os-retype" : {
    "new_type" : "SSD"
  }
}

Example Responses

Status code: 202

Accepted

  • Example 1

    {
  "job_id" : "xxx"
}

  • Example 2

    • 
  

  
Status code: 400

  
Bad Request

  
{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

 

 

  
SDK Sample Code

  
The SDK sample code is as follows.

 

 

  
Java

  
    
   
  • 
    
    Changing a yearly/monthly disk to an SSD-backed disk type and configuring auto payment
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
55
56
    
          
    		
         
          
    
           
    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("<YOUR REGION>"))
                .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());
        }
    }
}

    
          
    		
        
    
           
      
    
     
    
    
    • 
   
  • 
    
    Changing a pay-per-use or yearly/monthly disk to an SSD-backed disk type
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
    
          
    		
         
          
    
           
    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("<YOUR REGION>"))
                .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

  
    
   
  • 
    
    Changing a yearly/monthly disk to an SSD-backed disk type and configuring auto payment
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
    
          
    		
         
          
    
           
    # 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 = 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)

    
          
    		
        
    
           
      
    
     
    
    
    • 
   
  • 
    
    Changing a pay-per-use or yearly/monthly disk to an SSD-backed disk type
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
    
          
    		
         
          
    
           
    # 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 = 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

  
    
   
  • 
    
    Changing a yearly/monthly disk to an SSD-backed disk type and configuring auto payment
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
    
          
    		
         
          
    
           
    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.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)
    }
}

    
          
    		
        
    
           
      
    
     
    
    
    • 
   
  • 
    
    Changing a pay-per-use or yearly/monthly disk to an SSD-backed disk type
    
    
    
     
    
      
    
       
        
    
         
          
    
           
     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
    
          
    		
         
          
    
           
    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.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)
    }
}

    
          
    		
        
    
           
      
    
     
    
    
    • 
  

 

 

  
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.

 





 

  

   Parent topic: Disk Management