Instance Scaling
Last Updated：2020-10-20
It is used to scale the specified virtual machine. At present, it supports the CPU and memory scaling of virtual machine.
- When the instance is postpaid, the auto scaling can be performed. When the instance is prepaid, the scale-down operation can not be performed.
- The scaling operation can be performed only when the instance in the Running or Stopped status.
- The instance is restarted once after scaling.
- It is an asynchronous interface. You can view whether the scaling status is recovered through the [Query Instance Details](BCC/API Reference/Instance Related Interfaces/Query Details of the Specified Instance.md) interface.
- You can scale the dedicated instance through the specified CPU, memory and temporary disk size. The temporary disk of dedicated instance can be scaled up only, but can not be scaled down.
Request Structure
Request example for BCC instance scale-up:
PUT /v{version}/instance/{instanceId}?{action}&clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"cpuCount": cpuCount,
"memoryCapacityInGB": memoryCapacityInGB
}Request example for dedicated instance scale-up:
PUT /v{version}/instance/{instanceId}?{action}&clientToken={clientToken} HTTP/1.1
Host: dcc.bj.baidubce.com
Authorization: authorization string
{
"cpuCount": cpuCount,
"memoryCapacityInGB": memoryCapacityInGB,
"ephemeralDisks": [
"sizeInGB":sizeInGB
]
}
Request Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| instanceId | String | Yes | URL parameter | Instance ID of virtual machine |
| action | String | Yes | Query Parameter | This API value is "resize". |
| clientToken | String | Yes | Query Parameter | Idempotent Token, which is an ASCII string with the length no more than 64 bits. See [Idempotency of ClientToken](BCC/API Reference/General Description.md#Idempotence) for details. |
| cpuCount | int | Yes | Request Body Parameter | Number of CPUs (cores), which is invalid when newInstanceType is specified. |
| memoryCapacityInGB | int | Yes | Request Body Parameter | Memory capacity (GB), which is invalid when newInstanceType is specified. |
| ephemeralDisks | List<[EphemeralDisk](BCC/API Reference/Appendix.md#EphemeralDisk)> | No | Request Body Parameter | Temporary disk capacity configuration, which only supports the memory optimized dedicated instance currently. The capacity is deducted from the corresponding DCC package capacity. |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
No specific parameters are returned.
Error Code
| Error Code | Error Description | HTTP Status Code | Explanations |
|---|---|---|---|
| BadRequest | Bad request parameters or illegal request. | 400 | Invalid request parameter |
| Instance.InstanceBeBanned | The instance is banned, contact technical support for assistance. | 403 | Blocked |
| NoSuchObject | The specified object is not found or resource do not exist. | 404 | The resource does not exist. |
| OperationDenied | Operation not available. | 409 | The operation is not available. |
Request Instance
PUT /v2/instance/i-YufwpQAe?resize&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"cpuCount": 2,
"memoryCapacityInGB": 2
} Return Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS