cvm — Cloud Virtual Machine
cvm · 2017-03-12
ResizeInstanceDisks
POST
Expand the data disks of an instance.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/ResizeInstanceDisks path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cvm.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cvm.api3.convergecloud.com' \
-H 'X-TC-Action: ResizeInstanceDisks' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"InstanceId":"<InstanceId>","DataDisks":"<DataDisks>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | Yes | Instance ID to be operated. can be obtained from the `InstanceId` in the return value from the DescribeInstances api. |
| DataDisks | DataDisk[] | Yes | Specifies the configuration information of the data disk to be expanded, only supporting specifying the target capacity of the disk to be expanded. only non-elastic data disks (with `Portable` being `false` in the return values of DescribeDisks) can be expanded. the unit of data disk capacity is GiB. the minimum expansion step is 10 GiB. for data disk type selection, refer to disk product intro… |
| ForceStop | boolean | No | Specifies whether to forcibly shut down a running instance. it is recommended to manually shut down a running instance first and then expand the instance disk. valid values: true: forcibly shut down an instance after a normal shutdown fails. false: do not forcibly shut down an instance after a normal shutdown fails. default value: false. forced shutdown is equivalent to turning off a physical c… |
| SystemDisk | SystemDisk | No | System disk configuration information to be expanded. only supports specifying the purpose capacity of the disk to be expanded. only supports cloud disk expansion. |
| ResizeOnline | boolean | No | Whether the cloud disk is expanded online. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
// action-specific fields,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · ResizeInstanceDisks