ScaleInstance

Updated at:

Modifies the specifications and storage space of an instance.

Operation description

Warning This API operation incurs fees. Make sure that you fully understand the billing methods and pricing of Hologres before you call this operation.
  • 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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:ScaleInstance

update

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

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:

  • 16 cores, 64 GB (Number of compute nodes: 1)

  • 32 cores, 128 GB (Number of compute nodes: 2)

  • 64 cores, 256 GB (Number of compute nodes: 4)

  • 96 cores, 384 GB (Number of compute nodes: 6)

  • 128 cores, 512 GB (Number of compute nodes: 8)

  • More

Note
  • Specify only the number of cores.

  • To purchase specifications with more than 1,024 cores, submit a ticket.

  • You do not need to specify the specifications for shared instances.

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:

  • UPGRADE: upgrades the specifications.

  • DOWNGRADE: downgrades the specifications.

Note
  • When you upgrade the specifications, the new specifications cannot be lower than the original specifications. An empty field indicates that the original specifications remain unchanged. At least one specification must be higher than the original specification.

  • When you downgrade the specifications, the new specifications cannot be higher than the original specifications. An empty field indicates that the original specifications remain unchanged. At least one specification must be lower than the original specification.

Valid values:

  • DOWNGRADE :

    DOWNGRADE

  • UPGRADE :

    UPGRADE

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:

  • false :

    false

  • true :

    true

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:

  • false :

    Failed.

  • true :

    Successful.

true

HttpStatusCode

string

The HTTP status code.

200

ErrorCode

string

The error code.

null

ErrorMessage

string

The error message.

null

Note
  • 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.