All Products
Search

This Product

    Lindorm:UpgradeLindormInstance

    Document Center

    Lindorm:UpgradeLindormInstance

    Last Updated:Oct 27, 2025

    Enables cold storage for a Lindorm instance, or changes the node specifications, the number of nodes, or the storage capacity.

    Operation description

    For more information about the data engines and storage specifications of Lindorm instances, see Select data engines and Select storage 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The ID of the region where the instance is located. Call the DescribeRegions operation to obtain the region ID.

    cn-shanghai
    ZoneId

    string

    Yes

    The ID of the zone. Call the GetLindormInstance operation to obtain the zone ID.

    cn-shanghai-f
    InstanceId

    string

    Yes

    The ID of the instance. Call the GetLindormInstanceList operation to obtain the instance ID.

    ld-bp1o3y0yme2i2****
    UpgradeType

    string

    Yes

    The type of the upgrade. For more information about the supported upgrade types, see the description of the UpgradeType parameter.

    upgrade-cold-storage
    ClusterStorage

    integer

    No

    The storage capacity of the instance after the upgrade. Unit: GB. Valid values: 480 to 1017600.

    480
    ColdStorage

    integer

    No

    The cold storage capacity of the instance after the upgrade. Unit: GB. Valid values: 800 to 1000000.

    800
    SolrSpec

    string

    No

    The specifications of the search engine nodes of the instance after the upgrade. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated)

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated)

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated)

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated)

    lindorm.g.xlarge
    SolrNum

    integer

    No

    The number of search engine nodes in the instance after the upgrade. Valid values: 0 to 60.

    2
    LindormSpec

    string

    No

    The specifications of the LindormTable nodes of the instance after the upgrade. Valid values:

    • lindorm.c.xlarge: 4 cores, 8 GB (Dedicated)

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated)

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated)

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated)

    lindorm.c.xlarge
    LindormNum

    integer

    No

    The number of LindormTable nodes in the instance after the upgrade. Valid values: 0 to 90.

    Note

    This parameter must be specified with the LindormSpec parameter.

    2
    TsdbSpec

    string

    No

    The specifications of the LindormTSDB nodes of the instance after the upgrade. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated)

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated)

    • lindorm.g.4xlarge: 16 cores, 64 GB (Dedicated)

    • lindorm.g.8xlarge: 32 cores, 128 GB (Dedicated)

    lindorm.g.xlarge
    TsdbNum

    integer

    No

    The number of LindormTSDB nodes in the instance after the upgrade. Valid values: 0 to 24.

    2
    FilestoreSpec

    string

    No

    The specifications of the file engine nodes of the instance after the upgrade. Valid value:

    lindorm.c.xlarge: 4 cores, 8 GB (Standard)

    lindorm.c.xlarge
    FilestoreNum

    integer

    No

    The number of file engine nodes in the instance after the upgrade. Valid values: 0 to 60.

    2
    StreamSpec

    string

    No

    The specifications of the stream engine nodes of the instance after the upgrade. Valid values:

    • lindorm.c.2xlarge: 8 cores, 16 GB (Dedicated)

    • lindorm.c.4xlarge: 16 cores, 32 GB (Dedicated)

    • lindorm.c.8xlarge: 32 cores, 64 GB (Dedicated)

    lindorm.g.xlarge
    StreamNum

    integer

    No

    The number of stream engine nodes in the instance after the upgrade. Valid values: 0 to 90.

    2
    LtsCoreSpec

    string

    No

    The specifications of the Lindorm Tunnel Service (LTS) nodes of the instance after the upgrade. Valid values:

    • lindorm.g.xlarge: 4 cores, 16 GB (Dedicated)

    • lindorm.g.2xlarge: 8 cores, 32 GB (Dedicated)

    lindorm.g.xlarge
    LtsCoreNum

    integer

    No

    The number of LTS nodes in the instance after the upgrade. Valid values: 0 to 50.

    2
    CoreSingleStorage

    integer

    No

    The storage capacity of a single core node in the multi-zone instance after the upgrade. Valid values: 400 to 64000. Unit: GB. This parameter is available only for multi-zone instances.

    400GB
    LogSpec

    string

    No

    The specifications of the log nodes in the multi-zone instance after the upgrade. Valid values:

    • lindorm.sn1.large: 4 cores, 8 GB (Dedicated)

    • lindorm.sn1.2xlarge: 8 cores, 16 GB (Dedicated)

    This parameter is available only for multi-zone instances.

    lindorm.sn1.large
    LogNum

    integer

    No

    The number of log nodes in the multi-zone instance after the upgrade. Valid values: 4 to 400. This parameter is available only for multi-zone instances.

    4
    LogSingleStorage

    integer

    No

    The disk capacity of a single log node in the multi-zone instance after the upgrade. Valid values: 400 to 64000. Unit: GB. This parameter is available only for multi-zone instances.

    400GB

    Description of the UpgradeType parameter

    When you call the UpgradeLindormInstance operation, you must set the UpgradeType parameter to specify the upgrade type. You must also configure the parameters required for that upgrade type. The following table lists the required parameters for each upgrade type.

    UpgradeType parameterTypeRequired parametersDescription
    upgrade-cold-storageStringColdStorageEnable or scale out cold storage.
    upgrade-disk-sizeStringClusterStorageScale out disks.
    open-search-engineStringFor instances that use local disks: SolrNum
    For other instances: SolrNum, SolrSpec, and ClusterStorage

    		Enable the search engine.
    upgrade-search-engineStringSolrSpecUpgrade the specifications of the search engine. Note This parameter is not supported for instances that use local disks.
    upgrade-search-core-numStringSolrNum and ClusterStorageChange the number of search engine nodes.
    open-lindorm-engineStringFor instances that use local disks: LindormNum
    For other instances: LindormNum, LindormSpec, and ClusterStorage

    		Enable the LindormTable engine.
    upgrade-lindorm-engineStringLindormSpecUpgrade the specifications of the LindormTable engine. Note This parameter is not supported for instances that use local disks.
    upgrade-lindorm-core-numStringLindormNum and ClusterStorageChange the number of LindormTable nodes.
    open-tsdb-engineStringTsdbSpec, TsdbNum, and ClusterStorageEnable the LindormTSDB engine.
    upgrade-tsdb-engineStringTsdbSpecUpgrade the specifications of the LindormTSDB engine. Note This parameter is not supported for instances that use local disks.
    upgrade-tsdb-core-numStringTsdbNum and ClusterStorageChange the number of LindormTSDB nodes.
    open-stream-engineStringStreamSpec, StreamNum, and ClusterStorageEnable the stream engine.
    upgrade-stream-engineStringStreamSpecUpgrade the specifications of the stream engine. Note This parameter is not supported for instances that use local disks.
    upgrade-stream-core-numStringStreamNum and ClusterStorageChange the number of stream engine nodes.
    upgrade-file-engineStringFilestoreSpecUpgrade the specifications of the file engine. Note This parameter is not supported for instances that use local disks.
    upgrade-file-core-numStringFilestoreNumChange the number of file engine nodes.
    open-bds-transferStringFor instances that use local disks: LtsCoreNum, LtsCoreSpec, and SolrNum
    For other instances: LtsCoreNum, LtsCoreSpec, SolrNum, and SolrSpec

    		Enable the BDS (LTS) engine and the search engine.
    upgrade-bds-transferStringLtsCoreSpecChange the specifications of the BDS (LTS) engine.
    upgrade-bds-core-numStringLtsCoreNumChange the number of BDS (LTS) engine nodes.
    open-bds-transfer-onlyStringLtsCoreNum and LtsCoreSpecEnable the BDS (LTS) engine for an instance for which the search engine is already enabled.

    For multi-zone instances, see the following table.

    UpgradeType parameterTypeRequired parametersDescription
    upgrade-disk-sizeStringCoreSingleStorage and LogSingleStorageScale out the disk capacity of a single core node or a single log node.
    upgrade-lindorm-engineStringLindormSpec and LogSpecUpgrade the specifications of core nodes or log nodes. Note This parameter is not supported for instances that use local disks.
    upgrade-lindorm-core-numStringLindormNum and LogNumChange the number of core nodes or log nodes.

    Response elements

    Element

    Type

    Description

    Example

    object

    OrderId

    integer

    The ID of the order.

    111111111111111
    RequestId

    string

    The ID of the request.

    2A7D4F9D-AA26-4E15-A2B1-3E4792C6****

    Examples

    Success response

    JSON format

    {
  "OrderId": 111111111111111,
  "RequestId": "2A7D4F9D-AA26-4E15-A2B1-3E4792C6****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Lindorm.Errorcode.InstanceStorageInvalid The instance storage parameter is invalid: %s
    400 Instance.IsDeleted The instance is deleted. The specified instance is already deleted.
    400 Instance.IsNotValid The instance is invalid. The specified instance is invalid.
    400 InstanceConfig.NotChanged The upgrade or downgrade configuration is not changed, please check. The upgrade or downgrade configuration is not changed, please check.
    403 API.Forbidden The API operation is forbidden in this environment. This operation is not supported in the current environment.
    403 Lindorm.Errorcode.OperationDenied You are not authorized to operate on the specified resource. You are not authorized to manage the specified resource.
    403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. You are not authorized to create the service-linked role.
    403 Instance.NotActive Instance is not active. Instance status is not running
    403 OperationDenied.OrderProcessing Order in process, please try again later. Order in process, please try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.