Help Center> Elastic Volume Service> API Reference> API> Disk Management> Expanding Capacity of an EVS Disk
Updated on 2024-02-27 GMT+08:00

Expanding Capacity of an EVS Disk

Function

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

Constraints

If the status of the to-be-expanded disk is available, there are no restrictions. If the status of the to-be-expanded disk is in-use, the restrictions are as follows:

  • A shared disk cannot be expanded, which means that the value of multiattach must be false.

  • The status of the server to which the disk attached must be ACTIVE, PAUSED, SUSPENDED, or SHUTOFF.

Calling Method

For details, see Calling APIs.

URI

POST /v2.1/{project_id}/cloudvolumes/{volume_id}/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

volume_id

Yes

String

The disk ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bssParam

No

BssParamForResizeVolume object

The extended parameter of pay-per-use and yearly/monthly billing.

os-extend

Yes

OsExtend object

The capacity expansion marker.

Table 4 BssParamForResizeVolume

Parameter

Mandatory

Type

Description

isAutoPay

No

String

Whether to pay immediately. This parameter is valid only when the disk is billed on a yearly/monthly basis. The default value is false. Values:

  • true: An order is immediately paid from the account balance.

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

Default: false

Enumeration values:

  • false

  • true

cloudServiceConsoleURL

No

String

The URL used to switch to the cloud service console to view information after the subscription is complete.

Table 5 OsExtend

Parameter

Mandatory

Type

Description

new_size

Yes

Integer

The new disk size, in GiB. This parameter value must be greater than the original disk size and less than the maximum size allowed for a disk. The maximum disk size:

  • Data disk: 32,768 GiB

  • System disk: 1,024 GiB

Response Parameters

Status code: 202

Table 6 Response body parameters

Parameter

Type

Description

job_id

String

The task ID. This parameter is returned when the disk is billed on a pay-per-use basis.

NOTE:

To query the task status, see Querying Task Status.

order_id

String

The order ID. This parameter is returned when the disk is billed on a yearly/monthly basis.

NOTE:

If you need to pay for the order, see Paying Yearly/Monthly Product Orders.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs. For details, seeParameters in the error field.

Table 8 Error

Parameter

Type

Description

code

String

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

message

String

The error message returned if an error occurs.

Example Requests

Expanding the capacity of an EVS disk (Set the disk size to 100 GiB. You will be billed for the expansion immediately.)

POST https://{endpoint}/v2.1/{project_id}/cloudvolumes/{volume_id}/action

{
  "os-extend" : {
    "new_size" : 100
  },
  "bssParam" : {
    "isAutoPay" : "true"
  }
}

Example Responses

Status code: 202

Accepted

{
  "job_id" : "70a599e0-31e7-49b7-b260-868f441e862b"
}

Status code: 400

Bad Request

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

SDK Sample Code

The SDK sample code is as follows.

Expanding the capacity of an EVS disk (Set the disk size to 100 GiB. You will be billed for the expansion immediately.)

 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 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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        EvsClient client = EvsClient.newBuilder()
                .withCredential(auth)
                .withRegion(EvsRegion.valueOf("<YOUR REGION>"))
                .build();
        ResizeVolumeRequest request = new ResizeVolumeRequest();
        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());
        }
    }
}

Expanding the capacity of an EVS disk (Set the disk size to 100 GiB. You will be billed for the expansion immediately.)

 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

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = EvsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EvsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ResizeVolumeRequest()
        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)

Expanding the capacity of an EVS disk (Set the disk size to 100 GiB. You will be billed for the expansion immediately.)

 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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := evs.NewEvsClient(
        evs.EvsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ResizeVolumeRequest{}
	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)
    }
}

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.