tencent cloud

文档反馈

ResizeDisk

最后更新时间:2023-06-21 15:01:15

1. API Description

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

This API is used to expand cloud disks.

*This API supports only the expansion of elastic cloud disks. To query the type of a cloud disk, you can call the DescribeDisks API and check the Portable field in the response. To expand non-elastic cloud disks, you can call the ResizeInstanceDisks API. *This is an async API. A successful return of this API does not mean that the cloud disk has been expanded successfully. You can call the DescribeDisks API to query the status of a cloud disk. EXPANDING indicates that the expansion is in process.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: ResizeDisk.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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 a cloud disk to 200 GB

This example shows you how to expand a cloud disk to 200 GB.

Input Example

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResizeDisk
<Common request parameters>

{
    "DiskSize": "200",
    "DiskId": "disk-lzrg2pwi"
}

Output Example

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

5. Developer Resources

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
InternalError.ComponentError Dependent component request failed. Please contact customer service.
InvalidAccount.InsufficientBalance Insufficient account balance
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.
InvalidParameter.DiskConfigNotSupported Currently configured cloud disk not supported in current region.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resources.
ResourceNotFound.NotFound The resource is not found.
ResourceUnavailable.Expire The cloud disk has expired.
ResourceUnavailable.NotSupported The resource does not support this operation.
TradeDealConflict Order conflict.
UnauthorizedOperation.NotHavePaymentRight No payment permission.
UnsupportedOperation.InstanceNotStopped Instance mounted on cloud disk not shut down.