UpgradeLindormInstance-阿里云帮助中心

Enable cold storage for a Lindorm instance, change the node specification or the number of nodes, and adjust the storage space.

Operation description

For information about how to select the data engine and storage type for a Lindorm instance, see Select a data engine and Select a storage type.

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

lindorm:UpgradeLindormInstance

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance is located. You can call the DescribeRegions operation to obtain the latest region list.	cn-shanghai
ZoneId	string	Yes	The ID of the availability zone. You can call the GetLindormInstance operation to obtain this ID.	cn-shanghai-f
InstanceId	string	Yes	The ID of the instance. You can call the GetLindormInstanceList operation to obtain this ID.	ld-bp1o3y0yme2i2****
UpgradeType	string	Yes	The type of the upgrade. For details about the supported types, see the description of the UpgradeType parameter in the "Additional information about request parameters" section.	upgrade-cold-storage
ClusterStorage	integer	No	The new storage capacity of the instance. Unit: GB. Valid values: 480 to 1017600.	480
ColdStorage	integer	No	The new cold storage capacity of the instance. Unit: GB. Valid values: 800 to 1000000.	800
SolrSpec	string	No	The new specification of the search engine nodes. Valid values: lindorm.g.xlarge: 4 CPU cores, 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 CPU cores, 32 GB of memory (dedicated specification). lindorm.g.4xlarge: 16 CPU cores, 64 GB of memory (dedicated specification). lindorm.g.8xlarge: 32 CPU cores, 128 GB of memory (dedicated specification).	lindorm.g.xlarge
SolrNum	integer	No	The new number of search engine nodes. Valid values: 0 to 60.	2
LindormSpec	string	No	The new specification of the wide table engine nodes. Valid values: lindorm.c.xlarge: 4 CPU cores, 8 GB of memory (dedicated specification). lindorm.c.2xlarge: 8 CPU cores, 16 GB of memory (dedicated specification). lindorm.c.4xlarge: 16 CPU cores, 32 GB of memory (dedicated specification). lindorm.c.8xlarge: 32 CPU cores, 64 GB of memory (dedicated specification).	lindorm.c.xlarge
LindormNum	integer	No	The new number of wide table engine nodes. Valid values: 0 to 90. Note If you specify this parameter, the LindormSpec parameter is also required.	2
TsdbSpec	string	No	The new specification of the time series engine nodes. Valid values: lindorm.g.xlarge: 4 CPU cores, 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 CPU cores, 32 GB of memory (dedicated specification). lindorm.g.4xlarge: 16 CPU cores, 64 GB of memory (dedicated specification). lindorm.g.8xlarge: 32 CPU cores, 128 GB of memory (dedicated specification).	lindorm.g.xlarge
TsdbNum	integer	No	The new number of time series engine nodes. Valid values: 0 to 24.	2
FilestoreSpec	string	No	The new specification of the file engine nodes. Valid value: lindorm.c.xlarge: 4 CPU cores, 8 GB of memory (standard specification).	lindorm.c.xlarge
FilestoreNum	integer	No	The new number of file engine nodes. Valid values: 0 to 60.	2
StreamSpec	string	No	The new specification of the stream engine nodes. Valid values: lindorm.c.2xlarge: 8 CPU cores, 16 GB of memory (dedicated specification). lindorm.c.4xlarge: 16 CPU cores, 32 GB of memory (dedicated specification). lindorm.c.8xlarge: 32 CPU cores, 64 GB of memory (dedicated specification).	lindorm.g.xlarge
StreamNum	integer	No	The new number of stream engine nodes. Valid values: 0 to 90.	2
LtsCoreSpec	string	No	The new specification of the LTS nodes. Valid values: lindorm.g.xlarge: 4 CPU cores, 16 GB of memory (dedicated specification). lindorm.g.2xlarge: 8 CPU cores, 32 GB of memory (dedicated specification).	lindorm.g.xlarge
LtsCoreNum	integer	No	The new number of LTS nodes. Valid values: 0 to 50.	2
CoreSingleStorage	integer	No	The new storage capacity of a single core node in a multi-zone instance. Unit: GB. Valid values: 400 to 64000. This parameter is optional.	400GB
LogSpec	string	No	The new specification of the log nodes for a multi-zone instance. Valid values: lindorm.sn1.large: 4 CPU cores, 8 GB of memory (dedicated specification). lindorm.sn1.2xlarge: 8 CPU cores, 16 GB of memory (dedicated specification). This parameter is optional.	lindorm.sn1.large
LogNum	integer	No	The new number of log nodes for a multi-zone instance. Valid values: 4 to 400. This parameter is optional.	4
LogSingleStorage	integer	No	The new disk capacity of a single log node for a multi-zone instance. Unit: GB. Valid values: 400 to 64000. This parameter is optional.	400GB

UpgradeType parameter

When you specify the upgrade type for an instance with the UpgradeType parameter in the UpgradeLindormInstance operation, you must also set the required parameters to the new specifications. For more information, see the following table.

UpgradeType parameter	Type	Required parameters	Description
`upgrade-cold-storage`	String	`ColdStorage`	Enables or expands cold storage.
`upgrade-disk-size`	String	`ClusterStorage`	Expands the capacity of cloud disks.
`open-search-engine`	String	Instance with local disks: `SolrNum` Instance with cloud disks: `SolrNum`, `SolrSpec`, and `ClusterStorage`	Enables the search engine.
`upgrade-search-engine`	String	`SolrSpec`	Upgrades the search engine specification. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-search-core-num`	String	`SolrNum` and `ClusterStorage`	Changes the number of search engine nodes.
`open-lindorm-engine`	String	Instance with local disks: `LindormNum` Instance with cloud disks: `LindormNum`, `LindormSpec`, and `ClusterStorage`	Enables the wide-column engine.
`upgrade-lindorm-engine`	String	`LindormSpec`	Upgrades the wide-column engine specification. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-lindorm-core-num`	String	`LindormNum` and `ClusterStorage`	Changes the number of wide-column engine nodes.
`open-tsdb-engine`	String	`TsdbSpec`, `TsdbNum`, and `ClusterStorage`	Enables the TSDB engine.
`upgrade-tsdb-engine`	String	`TsdbSpec`	Upgrades the TSDB engine specification. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-tsdb-core-num`	String	`TsdbNum` and `ClusterStorage`	Changes the number of TSDB engine nodes.
`open-stream-engine`	String	`StreamSpec`, `StreamNum`, and `ClusterStorage`	Enables the stream engine.
`upgrade-stream-engine`	String	`StreamSpec`	Upgrades the stream engine specification. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-stream-core-num`	String	`StreamNum` and `ClusterStorage`	Changes the number of stream engine nodes.
`upgrade-file-engine`	String	`FilestoreSpec`	Upgrades the file engine specification. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-file-core-num`	String	`FilestoreNum`	Changes the number of file engine nodes.
`open-bds-transfer`	String	Instance with local disks: `LtsCoreNum`, `LtsCoreSpec`, and `SolrNum` Instance with cloud disks: `LtsCoreNum`, `LtsCoreSpec`, `SolrNum`, and `SolrSpec`	Enables the BDS (LTS) engine and the search engine.
`upgrade-bds-transfer`	String	`LtsCoreSpec`	Upgrades the BDS (LTS) engine specification.
`upgrade-bds-core-num`	String	`LtsCoreNum`	Changes the number of BDS (LTS) engine nodes.
`open-bds-transfer-only`	String	`LtsCoreNum` and `LtsCoreSpec`	Enables the BDS (LTS) engine on an instance that already has the search engine enabled.

For a multi-AZ instance, see the following table.

UpgradeType parameter	Type	Required parameters	Description
`upgrade-disk-size`	String	`CoreSingleStorage` and `LogSingleStorage`	Expands the disk capacity per core node or per log node.
`upgrade-lindorm-engine`	String	`LindormSpec` and `LogSpec`	Upgrades the specification of core nodes or log nodes. Note: This upgrade type is not supported for an instance with local disks.
`upgrade-lindorm-core-num`	String	`LindormNum` and `LogNum`	Changes the number of core nodes or log nodes.

Response elements

Element	Type	Description	Example
	object
OrderId	integer	The order ID.	111111111111111
RequestId	string	The request ID.	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.