All Products
Search

This Product

    Hologres:ScaleInstance

    Document Center

    Hologres:ScaleInstance

    Last Updated:Nov 11, 2025

    Changes the instance specifications and storage space of an instance.

    Operation description

    Warning

    This is a paid operation. Before you call this operation, make sure that you understand the billing methods and pricing of Hologres.

    • For more information about Hologres billing, see Billing overview.

    • The instance becomes unavailable when you upgrade or downgrade its computing resources. Upgrading or downgrading its storage resources does not affect the services of the instance. Avoid frequently upgrading or downgrading the instance. 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 instance ID.

    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: 16 vCPUs and 64 GB of memory (1 compute node)

    • 32: 32 vCPUs and 128 GB of memory (2 compute nodes)

    • 64: 64 vCPUs and 256 GB of memory (4 compute nodes)

    • 96: 96 vCPUs and 384 GB memory (6 compute nodes)

    • 128: 128 vCPUs and 512 GB memory (8 compute nodes)

    • and so on.

    Note

    • Specify the number of vCPUs.

    • To purchase an instance type with more than 1024 vCPUs, submit a ticket.

    • Skip this parameter 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.

    1000G

    coldStorageSize

    integer

    No

    The cold storage space of the instance. Unit: GB.

    Note

    This parameter is ignored for pay-as-you-go instances.

    1000G

    scaleType

    string

    Yes

    The scaling type.

    Note

    • Upgrade an instance: New specifications must be equal to or greater than original specifications. Leaving a parameter empty retains its original specification. At least one specification must be increased.

    • Downgrade an instance: New specifications must be equal to or less than original specifications. Leaving a parameter empty retains its original specification. At least one specification must be decreased.

    Valid values:

    • DOWNGRADE :

      Downgrade the instance.

    • UPGRADE :

      Upgrade the instance.

    UPGRADE

    gatewayCount

    integer

    No

    The number of gateways. Valid values: [2, 50].

    Note

    This parameter applies only to virtual warehouse instances.

    4

    enableServerlessComputing

    boolean

    No

    Specifies whether to enable Serverless Computing.

    Valid values:

    • true :

      Enable Serverless Computing.

    • false :

      Disable Serverless Computing.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    The response schema.

    RequestId

    string

    The ID of the request.

    D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70

    Data

    object

    The returned results.

    OrderId

    string

    The order ID.

    219183853450000

    Code

    string

    The error code.

    InvalidScaleType.Unsupported

    Message

    string

    The details of the error.

    不支持的变配类型

    Success

    boolean

    Indicates whether the scaling was successful.

    Valid values:

    • true :

      The operation was successful.

    • false :

      The operation failed.

    true

    HttpStatusCode

    string

    The HTTP status code.

    200

    ErrorCode

    string

    The error code.

    null

    ErrorMessage

    string

    The error message.

    null

    Note

    • If parameter verification fails, the system returns the Data object. In this case, the value of the Success parameter is false, and the Code and Message parameters are also returned. The value of Data.Success indicates whether the operation was successful, unless an exception is thrown.

    • When you use a new software development kit (SDK) to call this operation, a request timeout error may be returned. This is because the default timeout period of the client is different from that of the server. However, the operation is still successfully called. To prevent this issue, set the ReadTimeout parameter to 20000 before the call.

    Examples

    Success response

    JSON format

    {
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "Data": {
    "OrderId": "219183853450000",
    "Code": "InvalidScaleType.Unsupported",
    "Message": "不支持的变配类型",
    "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.