1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API (ResizeInstanceDisks) is used to expand the data disk of an instance.
- Currently, only data disks purchased with the instance and with Data Disk Types of
CLOUD_BASIC,CLOUD_PREMIUM, orCLOUD_SSDare supported for expansion.
Default interface request rate limit: 10 times per second.
Interface update time: 2022-12-02 07:34:09.
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: ResizeInstanceDisks |
| 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 |
| InstanceId | Yes | No | String | Instance ID to be operated. Can be obtained through the InstanceId in the returned value from the API DescribeInstances.Example: ins-r8hr2upy |
| SystemDisk | No | No | SystemDisk | Data disk configuration information to be expanded. Currently, only data disks purchased with the instance and with Data Disk Types of CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD are supported for expansion. Unit of the system disk capacity: GB. Minimum expansion step: 10 GB. For the selection of system disk types, see the disk product introduction. Available system disk types are limited by the instance type InstanceType. In addition, the maximum capacity allowed for expansion varies with the system disk types. When calling this API, only the parameter of DiskSize needs to be passed, for example, {DiskSize: xxx}.Example:View |
| DataDisks | No | No | Array of DataDisk | Describe Information about Data Disk to be Expanded Example:View |
| ResizeOnline | No | No | Bool | Whether the scale-out method for CBS is online scale-out. Example: true |
| ForceStop | No | No | Bool | Whether to perform forced shutdown on the running instance, False by default. Example: true |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskId | String | Task ID Example: 435323 |
| flowId | String | Task Flow ID Example: 3 |
| 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 |
|---|---|
| InvalidInstanceId.NotFound | No corresponding instance was found. |
| InvalidInstance.NotSupported | Unsupported instance. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or not supported, etc. |
| InternalServerError | Internal operation error. |
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InvalidInstanceId.Malformed | Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122. |
| MissingParameter | Parameters are missing. The request did not include mandatory parameters. |
| InvalidAccount.UnpaidOrder | The account has unpaid orders. |
| UnsupportedOperation.InstanceStateRunning | The instance is running. |