Help & DocumentationCloud Block StorageAPI DocumentationCloud Disk APIsResizeDisk

ResizeDisk

Last updated: 2019-09-09 20:17:32

PDF

Contents：

1. API Description

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

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

*Only elastic cloud disks are supported. You can query whether the cloud disk is an elastic cloud disk in the Portable field returned by the API DescribeDisks. To expand the capacity of non-elastic cloud disks, please use 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.

Default request rate limit: 20/sec.

Note: This API supports finance AZs. As finance AZs and non-finance AZs are isolated, when accessing the services in a finance AZ (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the finance AZ, preferably in the same region as specified in Region.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. Value​used in 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, see 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 The desired cloud disk capacity (in GB). It cannot be smaller 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 Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Expanding the Capacity of a Cloud Disk to 200 GB

Input Sample Code

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

Output Sample Code

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

5. Resources for Developers

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 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. 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 This operation is not supported for cloud disks.
InvalidDiskId.NotFound The DiskId does not exist.
InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
MissingParameter Missing parameter. A required parameter is missing in the request.
UnsupportedOperation.InstanceNotStopped The instance the cloud disk is mounted to has not been shut down.