Help & DocumentationCloud Block StorageAPI DocumentationCloud Disk APIsResizeDisk

ResizeDisk

Last updated: 2020-04-03 10:29:11

PDF

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (ResizeDisk) is used to expand the capacity of the cloud disk.

  • Only elastic cloud disks can be expanded. The cloud disk type can be queried in the Portable field in the output parameters through the API DescribeDisks. For the cloud disk created along with the CVM, the capacity can only be expanded via the API ResizeInstanceDisks.
  • This API is an asynchronous API. The cloud disk is not immediately expanded to the specified size as the API successfully returns results. You can use the API DescribeDisks to query the cloud disk status. The cloud disk in the status of "EXPANDING" is in the process of capacity expansion. When the status changes to "UNATTACHED", the capacity expansion is completed.

A maximum of 20 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: cbs.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: ResizeDisk.
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.
DiskId Yes String ID of the cloud disk, which can be queried via the API DescribeDisks.
DiskSize Yes Integer Cloud disk size after scale out (in GB). This must be larger than the current size of the cloud disk. For the value range of the cloud disk sizes, see cloud disk Product Types.

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. Example

Example1 Expanding Cloud Disk to 200G

Input Example

https://cbs.tencentcloudapi.com/?Action=ResizeDisk
&DiskId=disk-lzrg2pwi
&DiskSize=200
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "adefc06d-2cf1-29f6-24a6-5a1f81b5c0ac"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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

Error Code Description
InvalidDisk.Busy The cloud disk is busy. Try again later.
InvalidDisk.Expire The cloud disk has expired.
InvalidDisk.NotSupported Indicates that the operation is not supported for the cloud disk.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
MissingParameter Missing parameter. Request does not include the required parameter.
UnsupportedOperation.InstanceNotStopped Instance mounted on cloud disk not shut down.