1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to scale out a cloud disk.
- It only supports scale-out of elastic cloud disks. The cloud disk type can be queried through the DescribeDisks API. For details, see the explanation of the Portable field in the output parameters. A cloud disk created along with CVM should be scaled out through the [ResizeInstanceDisks](/tcloud/api/Compute/CVM/APIs/CVM (cvm)/Version (2017-03-12)/Instance APIs/ResizeInstanceDisks) API.
- This API is asynchronous. When a response is returned successfully, the cloud disk is not immediately scaled out to the specified size. The status of the corresponding cloud disk can be queried through the DescribeDisks API. If the status of the cloud disk is EXPANDING, it indicates that the cloud disk is being scaled out. If the status changes to UNATTACHED, it indicates that the cloud disk is scaled out successfully.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-29 00:43:48.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ResizeDisk |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| DiskId | Yes | No | String | Cloud disk ID. It can be queried through the DescribeDisks API. Example: disk-7q2iy7gp |
| DiskSize | Yes | No | Uint64 | Size of the cloud disk after scaling, in GB, which must be greater than the current cloud disk size. Value range: Common cloud disk: 10 GB to 4000 GB; High-performance cloud disk: 50 GB to 4000 GB; SSD cloud disk: 100 GB to 4000 GB. The step is 10 GB. Example: 100 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidDisk.Busy | The cloud disk is busy. Try again later. |
| InvalidDisk.Expire | The cloud disk has expired. |
| ResourceInsufficient.OverQuota | Insufficient quota |