ScaleInstance
Modifies the specifications and storage space of an instance.
Operation description
For more information about Hologres billing, see Billing overview.
The instance is unavailable while its compute resources are being changed. Changing instance storage resources of the instance does not affect its normal use. Do not change instance specifications frequently. For more information, see Upgrade or downgrade instance specifications.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hologram:ScaleInstance |
update |
*Instance
|
None | None |
Request syntax
POST /api/v1/instances/{instanceId}/scale HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The ID of the Hologres instance. |
hgprecn-cn-xxxxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request body. |
|
| cpu |
integer |
No |
The instance specifications. Valid values:
Note
|
128 |
| storageSize |
integer |
No |
The standard storage space of the instance. Unit: GB. Note
This parameter is ignored for pay-as-you-go instances. |
1000 |
| coldStorageSize |
integer |
No |
The infrequent access storage space of the instance. Unit: GB. Note
This parameter is ignored for pay-as-you-go instances. |
1000 |
| scaleType |
string |
Yes |
The type of the specification change. Valid values:
Note
Valid values:
|
UPGRADE |
| gatewayCount |
integer |
No |
The number of gateways. Valid values: 2 to 50. Note
This parameter is required only for the Warehouse type. |
4 |
| enableServerlessComputing |
boolean |
No |
Specifies whether to enable serverless computing. Valid values:
|
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The ID of the request. |
D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70 |
| Data |
object |
The returned result. |
|
| OrderId |
string |
The ID of the order. |
219183853450000 |
| Code |
string |
The error code. |
InvalidScaleType.Unsupported |
| Message |
string |
The detailed error message. |
Invalid scale type |
| Success |
boolean |
Indicates whether the specification change was successful. Valid values:
|
true |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
| ErrorCode |
string |
The error code. |
null |
| ErrorMessage |
string |
The error message. |
null |
If a parameter validation error occurs, a normal Data object is still returned, but Success is set to false, and Code and Message are included. Unless an exception is thrown, the success of the operation is determined by Data.Success.
When you use the latest SDK to call this operation, a request timeout error may be returned because the default timeout period of the client in the SDK is different from that of the server. However, the operation is actually called successfully. To avoid this issue, you can set the ReadTimeout parameter to 20000 before you call the operation.

Examples
Success response
JSON format
{
"RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
"Data": {
"OrderId": "219183853450000",
"Code": "InvalidScaleType.Unsupported",
"Message": "Invalid scale type",
"Success": true
},
"HttpStatusCode": "200",
"ErrorCode": "null",
"ErrorMessage": "null"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.