Help Center> Elastic Volume Service> API Reference> API v2> EVS Disk> Expanding Capacity of an EVS Disk

Expanding Capacity of an EVS Disk

Function

This API contains all functions found in Expanding Capacity of an EVS Disk (Deprecated) and can also be used to expand the capacity of the disk billed in yearly/monthly mode. Enterprise project authorization is supported.

After a yearly/monthly-billed disk is successfully expanded by calling this API,
  • If you need to view the coupons available for your order, see Viewing Coupons Available for an Order.
  • If you need to pay for the order, see Paying for the Order of Yearly/Monthly-Billed Resources.
  • If you need to view the resource provisioning details in your order, see Querying Resource Provisioning Details in an Order.
  • If you need to unsubscribe from a yearly/monthly resource, see Unsubscribing from Year/Monthly Resources.

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, that is, the value of parameter multiattach must be false.
    • The status of the server to which the disk attached must be ACTIVE, PAUSED, SUSPENDED, or SHUTOFF.

URI

  • URI format

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

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

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

    volume_id

    Yes

    Specifies the disk ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    os-extend

    Object

    Yes

    Specifies the disk expansion marker. For details, see Parameter in the os-extend field.

    bssParam

    Object

    No

    Specifies the operation parameter. For details, see Parameter in the bssParam.

  • Parameter in the os-extend field

    Parameter

    Type

    Mandatory

    Description

    new_size

    Integer

    Yes

    Specifies the size of the disk after capacity expansion, in GB.

    The new disk size ranges from the original disk size to the maximum size (32768 for a data disk and 1024 for a system disk).

    NOTE:

    If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent.

  • Parameters in the bssParam field

    Parameter

    Type

    Mandatory

    Description

    isAutoPay

    String

    No

    • Specifies whether to pay immediately. This parameter is valid only when the disk is billed on the yearly/monthly basis. The default value is false.
    • Value range
      • false: indicates not to pay immediately after an order is created.
      • true: indicates to pay immediately after an order is created. The system will automatically deduct fees from the account balance.
  • Example request
    {
        "os-extend": {
            "new_size": 100
        }, 
        "bssParam": {
            "isAutoPay": "true"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    job_id

    String

    Specifies the task ID. This parameter is returned when the expanded disk is billed in pay-per-use mode.

    NOTE:

    For details about how to query the task status, see Querying Task Status.

    order_id

    String

    Specifies the order ID. This parameter is returned when the expanded disk is billed in yearly/monthly mode.

    NOTE:

    If you need to pay for the order, see Paying for the Order of Yearly/Monthly-Billed Resources.

    error

    Object

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    Specifies the error message returned when an error occurs.

    code

    String

    Specifies the error code returned when an error occurs.

    For details about the error code, see Error Codes.

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

    or

    {
        "order_id": "CS1711152257C60TL"
    }

    or

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

Status Codes

  • Normal

    202

Error Codes

For details, see Error Codes.