ResizeInstanceDisks

Last updated: 2018-10-12 16:02:29

PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com

This API (ResizeInstanceDisks) is used to expand the capacity of the data disk of an instance.

  • Capacity expansion is only available to the data disk purchased with the instance, and the data disk type can be CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.* This API cannot be used to expand the capacity of data disks for CDH instances.
  • For prepaid instances, you will be charged a fee for using this API, so make sure to keep sufficient balance in your account. You can query the account balance via API DescribeAccountBalance.
  • Only one data disk is allowed for capacity expansion.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ResizeInstanceDisks
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String IDs of instances you are working with. You can obtain the parameter value from the InstanceId field value in the returned result of API DescribeInstances.
DataDisks.N Yes Array of DataDisk Configuration information of the data disk whose capacity is to be expanded. Capacity expansion is only available to the data disk purchased with the instance, and the data disk type can be CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD. Data disk capacity is calculated in GB. Minimum increment of capacity expansion is 10 GB. For information on how to choose a data disk type, please see Disk Product Overview. The available types of data disks are subject to the instance type (InstanceType). In addition, the maximum capacity allowed for expansion varies with different types of data disks.
ForceStop No Boolean Indicates whether to perform a forced shutdown on a running instance. It is recommended to manually shut down the running instance before resetting the user password. Supported values:
  • TRUE: Perform a forced shutdown
  • FALSE: Do not perform a forced shutdown

    Default: FALSE.

    Just like powering off a physical PC, a forced shutdown may cause data loss or the corruption of file system. Be sure to perform forced shutdown only when the server cannot be shut down normally.
  • 3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Error Codes

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalServerError Internal error.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidAccount.UnpaidOrder There is an order to be paid in the account.
    InvalidInstance.NotSupported Unsupported instance.
    InvalidInstanceId.Malformed Invalid instance ID. Specified instance ID is not in a correct format. For example, ins-1122 has an invalid instance ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue Invalid parameter value. The parameter value is in an incorrect format or is not supported.
    MissingParameter Parameter is missing. A required parameter is missing in the request.

    5. Example

    Example 1 Resize a disk with a specified ID

    Input example

    https://cvm.tencentcloudapi.com/?Action=ResizeInstanceDisks
    &InstanceId=ins-r8hr2upy
    &DataDisks.0.DiskSize=100
    &<Common request parameters>

    Output example

    {
      "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
      }
    }